types

package
Version: v1.11.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 17, 2021 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AbortIncompleteMultipartUpload

type AbortIncompleteMultipartUpload struct {

	// Specifies the number of days after which Amazon S3 aborts an incomplete
	// multipart upload to the Outposts bucket.
	DaysAfterInitiation int32
	// contains filtered or unexported fields
}

The container for abort incomplete multipart upload

type AccessPoint

type AccessPoint struct {

	// The name of the bucket associated with this access point.
	//
	// This member is required.
	Bucket *string

	// The name of this access point.
	//
	// This member is required.
	Name *string

	// Indicates whether this access point allows access from the public internet. If
	// VpcConfiguration is specified for this access point, then NetworkOrigin is VPC,
	// and the access point doesn't allow access from the public internet. Otherwise,
	// NetworkOrigin is Internet, and the access point allows access from the public
	// internet, subject to the access point and bucket access policies.
	//
	// This member is required.
	NetworkOrigin NetworkOrigin

	// The ARN for the access point.
	AccessPointArn *string

	// The name or alias of the access point.
	Alias *string

	// The virtual private cloud (VPC) configuration for this access point, if one
	// exists. This element is empty if this access point is an Amazon S3 on Outposts
	// access point that is used by other Amazon Web Services.
	VpcConfiguration *VpcConfiguration
	// contains filtered or unexported fields
}

An access point used to access a bucket.

type AccountLevel added in v0.30.0

type AccountLevel struct {

	// A container for the S3 Storage Lens bucket-level configuration.
	//
	// This member is required.
	BucketLevel *BucketLevel

	// A container for the S3 Storage Lens activity metrics.
	ActivityMetrics *ActivityMetrics
	// contains filtered or unexported fields
}

A container for the account level Amazon S3 Storage Lens configuration.

type ActivityMetrics added in v0.30.0

type ActivityMetrics struct {

	// A container for whether the activity metrics are enabled.
	IsEnabled bool
	// contains filtered or unexported fields
}

A container for the activity metrics.

type AsyncErrorDetails added in v1.11.0

type AsyncErrorDetails struct {

	// A string that uniquely identifies the error condition.
	Code *string

	// A generic descritpion of the error condition in English.
	Message *string

	// The ID of the request associated with the error.
	RequestId *string

	// The identifier of the resource associated with the error.
	Resource *string
	// contains filtered or unexported fields
}

Error details for the failed asynchronous operation.

type AsyncOperation added in v1.11.0

type AsyncOperation struct {

	// The time that the request was sent to the service.
	CreationTime *time.Time

	// The specific operation for the asynchronous request.
	Operation AsyncOperationName

	// The parameters associated with the request.
	RequestParameters *AsyncRequestParameters

	// The current status of the request.
	RequestStatus *string

	// The request token associated with the request.
	RequestTokenARN *string

	// The details of the response.
	ResponseDetails *AsyncResponseDetails
	// contains filtered or unexported fields
}

A container for the information about an asynchronous operation.

type AsyncOperationName added in v1.11.0

type AsyncOperationName string
const (
	AsyncOperationNameCreateMultiRegionAccessPoint    AsyncOperationName = "CreateMultiRegionAccessPoint"
	AsyncOperationNameDeleteMultiRegionAccessPoint    AsyncOperationName = "DeleteMultiRegionAccessPoint"
	AsyncOperationNamePutMultiRegionAccessPointPolicy AsyncOperationName = "PutMultiRegionAccessPointPolicy"
)

Enum values for AsyncOperationName

func (AsyncOperationName) Values added in v1.11.0

Values returns all known values for AsyncOperationName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AsyncRequestParameters added in v1.11.0

type AsyncRequestParameters struct {

	// A container of the parameters for a CreateMultiRegionAccessPoint
	// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html)
	// request.
	CreateMultiRegionAccessPointRequest *CreateMultiRegionAccessPointInput

	// A container of the parameters for a DeleteMultiRegionAccessPoint
	// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html)
	// request.
	DeleteMultiRegionAccessPointRequest *DeleteMultiRegionAccessPointInput

	// A container of the parameters for a PutMultiRegionAccessPoint
	// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPoint.html)
	// request.
	PutMultiRegionAccessPointPolicyRequest *PutMultiRegionAccessPointPolicyInput
	// contains filtered or unexported fields
}

A container for the request parameters associated with an asynchronous request.

type AsyncResponseDetails added in v1.11.0

type AsyncResponseDetails struct {

	// Error details for an asynchronous request.
	ErrorDetails *AsyncErrorDetails

	// The details for the Multi-Region Access Point.
	MultiRegionAccessPointDetails *MultiRegionAccessPointsAsyncResponse
	// contains filtered or unexported fields
}

A container for the response details that are returned when querying about an asynchronous request.

type AwsLambdaTransformation added in v1.3.0

type AwsLambdaTransformation struct {

	// The Amazon Resource Name (ARN) of the Lambda function.
	//
	// This member is required.
	FunctionArn *string

	// Additional JSON that provides supplemental data to the Lambda function used to
	// transform objects.
	FunctionPayload *string
	// contains filtered or unexported fields
}

Lambda function used to transform objects through an Object Lambda Access Point.

type BadRequestException

type BadRequestException struct {
	Message *string
	// contains filtered or unexported fields
}

func (*BadRequestException) Error

func (e *BadRequestException) Error() string

func (*BadRequestException) ErrorCode

func (e *BadRequestException) ErrorCode() string

func (*BadRequestException) ErrorFault

func (e *BadRequestException) ErrorFault() smithy.ErrorFault

func (*BadRequestException) ErrorMessage

func (e *BadRequestException) ErrorMessage() string

type BucketAlreadyExists

type BucketAlreadyExists struct {
	Message *string
	// contains filtered or unexported fields
}

The requested Outposts bucket name is not available. The bucket namespace is shared by all users of the Outposts in this Region. Select a different name and try again.

func (*BucketAlreadyExists) Error

func (e *BucketAlreadyExists) Error() string

func (*BucketAlreadyExists) ErrorCode

func (e *BucketAlreadyExists) ErrorCode() string

func (*BucketAlreadyExists) ErrorFault

func (e *BucketAlreadyExists) ErrorFault() smithy.ErrorFault

func (*BucketAlreadyExists) ErrorMessage

func (e *BucketAlreadyExists) ErrorMessage() string

type BucketAlreadyOwnedByYou

type BucketAlreadyOwnedByYou struct {
	Message *string
	// contains filtered or unexported fields
}

The Outposts bucket you tried to create already exists, and you own it.

func (*BucketAlreadyOwnedByYou) Error

func (e *BucketAlreadyOwnedByYou) Error() string

func (*BucketAlreadyOwnedByYou) ErrorCode

func (e *BucketAlreadyOwnedByYou) ErrorCode() string

func (*BucketAlreadyOwnedByYou) ErrorFault

func (e *BucketAlreadyOwnedByYou) ErrorFault() smithy.ErrorFault

func (*BucketAlreadyOwnedByYou) ErrorMessage

func (e *BucketAlreadyOwnedByYou) ErrorMessage() string

type BucketCannedACL

type BucketCannedACL string
const (
	BucketCannedACLPrivate           BucketCannedACL = "private"
	BucketCannedACLPublicRead        BucketCannedACL = "public-read"
	BucketCannedACLPublicReadWrite   BucketCannedACL = "public-read-write"
	BucketCannedACLAuthenticatedRead BucketCannedACL = "authenticated-read"
)

Enum values for BucketCannedACL

func (BucketCannedACL) Values added in v0.29.0

func (BucketCannedACL) Values() []BucketCannedACL

Values returns all known values for BucketCannedACL. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BucketLevel added in v0.30.0

type BucketLevel struct {

	// A container for the bucket-level activity metrics for Amazon S3 Storage Lens
	ActivityMetrics *ActivityMetrics

	// A container for the bucket-level prefix-level metrics for S3 Storage Lens
	PrefixLevel *PrefixLevel
	// contains filtered or unexported fields
}

A container for the bucket-level configuration.

type BucketLocationConstraint

type BucketLocationConstraint string
const (
	BucketLocationConstraintEu           BucketLocationConstraint = "EU"
	BucketLocationConstraintEuWest1      BucketLocationConstraint = "eu-west-1"
	BucketLocationConstraintUsWest1      BucketLocationConstraint = "us-west-1"
	BucketLocationConstraintUsWest2      BucketLocationConstraint = "us-west-2"
	BucketLocationConstraintApSouth1     BucketLocationConstraint = "ap-south-1"
	BucketLocationConstraintApSoutheast1 BucketLocationConstraint = "ap-southeast-1"
	BucketLocationConstraintApSoutheast2 BucketLocationConstraint = "ap-southeast-2"
	BucketLocationConstraintApNortheast1 BucketLocationConstraint = "ap-northeast-1"
	BucketLocationConstraintSaEast1      BucketLocationConstraint = "sa-east-1"
	BucketLocationConstraintCnNorth1     BucketLocationConstraint = "cn-north-1"
	BucketLocationConstraintEuCentral1   BucketLocationConstraint = "eu-central-1"
)

Enum values for BucketLocationConstraint

func (BucketLocationConstraint) Values added in v0.29.0

Values returns all known values for BucketLocationConstraint. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type CreateBucketConfiguration

type CreateBucketConfiguration struct {

	// Specifies the Region where the bucket will be created. If you are creating a
	// bucket on the US East (N. Virginia) Region (us-east-1), you do not need to
	// specify the location. This is not supported by Amazon S3 on Outposts buckets.
	LocationConstraint BucketLocationConstraint
	// contains filtered or unexported fields
}

The container for the bucket configuration. This is not supported by Amazon S3 on Outposts buckets.

type CreateMultiRegionAccessPointInput added in v1.11.0

type CreateMultiRegionAccessPointInput struct {

	// The name of the Multi-Region Access Point associated with this request.
	//
	// This member is required.
	Name *string

	// The buckets in different Regions that are associated with the Multi-Region
	// Access Point.
	//
	// This member is required.
	Regions []Region

	// The PublicAccessBlock configuration that you want to apply to this Amazon S3
	// account. You can enable the configuration options in any combination. For more
	// information about when Amazon S3 considers a bucket or object public, see The
	// Meaning of "Public"
	// (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status)
	// in the Amazon S3 User Guide. This is not supported for Amazon S3 on Outposts.
	PublicAccessBlock *PublicAccessBlockConfiguration
	// contains filtered or unexported fields
}

A container for the information associated with a CreateMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html) request.

type DeleteMultiRegionAccessPointInput added in v1.11.0

type DeleteMultiRegionAccessPointInput struct {

	// The name of the Multi-Region Access Point associated with this request.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

A container for the information associated with a DeleteMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html) request.

type EstablishedMultiRegionAccessPointPolicy added in v1.11.0

type EstablishedMultiRegionAccessPointPolicy struct {

	// The details of the last established policy.
	Policy *string
	// contains filtered or unexported fields
}

The last established access control policy for a Multi-Region Access Point. When you update the policy, the update is first listed as the proposed policy. After the update is finished and all Regions have been updated, the proposed policy is listed as the established policy. If both policies have the same version number, the proposed policy is the established policy.

type Exclude added in v0.30.0

type Exclude struct {

	// A container for the S3 Storage Lens bucket excludes.
	Buckets []string

	// A container for the S3 Storage Lens Region excludes.
	Regions []string
	// contains filtered or unexported fields
}

A container for what Amazon S3 Storage Lens will exclude.

type ExpirationStatus

type ExpirationStatus string
const (
	ExpirationStatusEnabled  ExpirationStatus = "Enabled"
	ExpirationStatusDisabled ExpirationStatus = "Disabled"
)

Enum values for ExpirationStatus

func (ExpirationStatus) Values added in v0.29.0

Values returns all known values for ExpirationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Format added in v0.30.0

type Format string
const (
	FormatCsv     Format = "CSV"
	FormatParquet Format = "Parquet"
)

Enum values for Format

func (Format) Values added in v0.30.0

func (Format) Values() []Format

Values returns all known values for Format. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type IdempotencyException

type IdempotencyException struct {
	Message *string
	// contains filtered or unexported fields
}

func (*IdempotencyException) Error

func (e *IdempotencyException) Error() string

func (*IdempotencyException) ErrorCode

func (e *IdempotencyException) ErrorCode() string

func (*IdempotencyException) ErrorFault

func (e *IdempotencyException) ErrorFault() smithy.ErrorFault

func (*IdempotencyException) ErrorMessage

func (e *IdempotencyException) ErrorMessage() string

type Include added in v0.30.0

type Include struct {

	// A container for the S3 Storage Lens bucket includes.
	Buckets []string

	// A container for the S3 Storage Lens Region includes.
	Regions []string
	// contains filtered or unexported fields
}

A container for what Amazon S3 Storage Lens configuration includes.

type InternalServiceException

type InternalServiceException struct {
	Message *string
	// contains filtered or unexported fields
}

func (*InternalServiceException) Error

func (e *InternalServiceException) Error() string

func (*InternalServiceException) ErrorCode

func (e *InternalServiceException) ErrorCode() string

func (*InternalServiceException) ErrorFault

func (e *InternalServiceException) ErrorFault() smithy.ErrorFault

func (*InternalServiceException) ErrorMessage

func (e *InternalServiceException) ErrorMessage() string

type InvalidNextTokenException

type InvalidNextTokenException struct {
	Message *string
	// contains filtered or unexported fields
}

func (*InvalidNextTokenException) Error

func (e *InvalidNextTokenException) Error() string

func (*InvalidNextTokenException) ErrorCode

func (e *InvalidNextTokenException) ErrorCode() string

func (*InvalidNextTokenException) ErrorFault

func (*InvalidNextTokenException) ErrorMessage

func (e *InvalidNextTokenException) ErrorMessage() string

type InvalidRequestException

type InvalidRequestException struct {
	Message *string
	// contains filtered or unexported fields
}

func (*InvalidRequestException) Error

func (e *InvalidRequestException) Error() string

func (*InvalidRequestException) ErrorCode

func (e *InvalidRequestException) ErrorCode() string

func (*InvalidRequestException) ErrorFault

func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault

func (*InvalidRequestException) ErrorMessage

func (e *InvalidRequestException) ErrorMessage() string

type JobDescriptor

type JobDescriptor struct {

	// Indicates whether confirmation is required before Amazon S3 begins running the
	// specified job. Confirmation is required only for jobs created through the Amazon
	// S3 console.
	ConfirmationRequired bool

	// A timestamp indicating when this job was created.
	CreationTime *time.Time

	// The description for this job, if one was provided in this job's Create Job
	// request.
	Description *string

	// If the specified job failed, this field contains information describing the
	// failure.
	FailureReasons []JobFailure

	// The Amazon Resource Name (ARN) for this job.
	JobArn *string

	// The ID for the specified job.
	JobId *string

	// The configuration information for the specified job's manifest object.
	Manifest *JobManifest

	// The operation that the specified job is configured to run on the objects listed
	// in the manifest.
	Operation *JobOperation

	// The priority of the specified job.
	Priority int32

	// Describes the total number of tasks that the specified job has run, the number
	// of tasks that succeeded, and the number of tasks that failed.
	ProgressSummary *JobProgressSummary

	// Contains the configuration information for the job-completion report if you
	// requested one in the Create Job request.
	Report *JobReport

	// The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role
	// assigned to run the tasks for this job.
	RoleArn *string

	// The current status of the specified job.
	Status JobStatus

	// The reason for updating the job.
	StatusUpdateReason *string

	// The reason why the specified job was suspended. A job is only suspended if you
	// create it through the Amazon S3 console. When you create the job, it enters the
	// Suspended state to await confirmation before running. After you confirm the job,
	// it automatically exits the Suspended state.
	SuspendedCause *string

	// The timestamp when this job was suspended, if it has been suspended.
	SuspendedDate *time.Time

	// A timestamp indicating when this job terminated. A job's termination date is the
	// date and time when it succeeded, failed, or was canceled.
	TerminationDate *time.Time
	// contains filtered or unexported fields
}

A container element for the job configuration and status information returned by a Describe Job request.

type JobFailure

type JobFailure struct {

	// The failure code, if any, for the specified job.
	FailureCode *string

	// The failure reason, if any, for the specified job.
	FailureReason *string
	// contains filtered or unexported fields
}

If this job failed, this element indicates why the job failed.

type JobListDescriptor

type JobListDescriptor struct {

	// A timestamp indicating when the specified job was created.
	CreationTime *time.Time

	// The user-specified description that was included in the specified job's Create
	// Job request.
	Description *string

	// The ID for the specified job.
	JobId *string

	// The operation that the specified job is configured to run on every object listed
	// in the manifest.
	Operation OperationName

	// The current priority for the specified job.
	Priority int32

	// Describes the total number of tasks that the specified job has run, the number
	// of tasks that succeeded, and the number of tasks that failed.
	ProgressSummary *JobProgressSummary

	// The specified job's current status.
	Status JobStatus

	// A timestamp indicating when the specified job terminated. A job's termination
	// date is the date and time when it succeeded, failed, or was canceled.
	TerminationDate *time.Time
	// contains filtered or unexported fields
}

Contains the configuration and status information for a single job retrieved as part of a job list.

type JobManifest

type JobManifest struct {

	// Contains the information required to locate the specified job's manifest.
	//
	// This member is required.
	Location *JobManifestLocation

	// Describes the format of the specified job's manifest. If the manifest is in CSV
	// format, also describes the columns contained within the manifest.
	//
	// This member is required.
	Spec *JobManifestSpec
	// contains filtered or unexported fields
}

Contains the configuration information for a job's manifest.

type JobManifestFieldName

type JobManifestFieldName string
const (
	JobManifestFieldNameIgnore    JobManifestFieldName = "Ignore"
	JobManifestFieldNameBucket    JobManifestFieldName = "Bucket"
	JobManifestFieldNameKey       JobManifestFieldName = "Key"
	JobManifestFieldNameVersionId JobManifestFieldName = "VersionId"
)

Enum values for JobManifestFieldName

func (JobManifestFieldName) Values added in v0.29.0

Values returns all known values for JobManifestFieldName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type JobManifestFormat

type JobManifestFormat string
const (
	JobManifestFormatS3BatchOperationsCsv20180820 JobManifestFormat = "S3BatchOperations_CSV_20180820"
	JobManifestFormatS3InventoryReportCsv20161130 JobManifestFormat = "S3InventoryReport_CSV_20161130"
)

Enum values for JobManifestFormat

func (JobManifestFormat) Values added in v0.29.0

Values returns all known values for JobManifestFormat. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type JobManifestLocation

type JobManifestLocation struct {

	// The ETag for the specified manifest object.
	//
	// This member is required.
	ETag *string

	// The Amazon Resource Name (ARN) for a manifest object. Replacement must be made
	// for object keys containing special characters (such as carriage returns) when
	// using XML requests. For more information, see  XML related object key
	// constraints
	// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
	//
	// This member is required.
	ObjectArn *string

	// The optional version ID to identify a specific version of the manifest object.
	ObjectVersionId *string
	// contains filtered or unexported fields
}

Contains the information required to locate a manifest object.

type JobManifestSpec

type JobManifestSpec struct {

	// Indicates which of the available formats the specified manifest uses.
	//
	// This member is required.
	Format JobManifestFormat

	// If the specified manifest object is in the S3BatchOperations_CSV_20180820
	// format, this element describes which columns contain the required data.
	Fields []JobManifestFieldName
	// contains filtered or unexported fields
}

Describes the format of a manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.

type JobOperation

type JobOperation struct {

	// Directs the specified job to invoke an Lambda function on every object in the
	// manifest.
	LambdaInvoke *LambdaInvokeOperation

	// Directs the specified job to execute a DELETE Object tagging call on every
	// object in the manifest.
	S3DeleteObjectTagging *S3DeleteObjectTaggingOperation

	// Directs the specified job to initiate restore requests for every archived object
	// in the manifest.
	S3InitiateRestoreObject *S3InitiateRestoreObjectOperation

	// Directs the specified job to run a PUT Object acl call on every object in the
	// manifest.
	S3PutObjectAcl *S3SetObjectAclOperation

	// Directs the specified job to run a PUT Copy object call on every object in the
	// manifest.
	S3PutObjectCopy *S3CopyObjectOperation

	// Contains the configuration for an S3 Object Lock legal hold operation that an S3
	// Batch Operations job passes every object to the underlying PutObjectLegalHold
	// API. For more information, see Using S3 Object Lock legal hold with S3 Batch
	// Operations
	// (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-legal-hold.html) in
	// the Amazon S3 User Guide.
	S3PutObjectLegalHold *S3SetObjectLegalHoldOperation

	// Contains the configuration parameters for the Object Lock retention action for
	// an S3 Batch Operations job. Batch Operations passes every object to the
	// underlying PutObjectRetention API. For more information, see Using S3 Object
	// Lock retention with S3 Batch Operations
	// (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html)
	// in the Amazon S3 User Guide.
	S3PutObjectRetention *S3SetObjectRetentionOperation

	// Directs the specified job to run a PUT Object tagging call on every object in
	// the manifest.
	S3PutObjectTagging *S3SetObjectTaggingOperation
	// contains filtered or unexported fields
}

The operation that you want this job to perform on every object listed in the manifest. For more information about the available operations, see Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html) in the Amazon S3 User Guide.

type JobProgressSummary

type JobProgressSummary struct {

	//
	NumberOfTasksFailed int64

	//
	NumberOfTasksSucceeded int64

	//
	TotalNumberOfTasks int64
	// contains filtered or unexported fields
}

Describes the total number of tasks that the specified job has started, the number of tasks that succeeded, and the number of tasks that failed.

type JobReport

type JobReport struct {

	// Indicates whether the specified job will generate a job-completion report.
	//
	// This member is required.
	Enabled bool

	// The Amazon Resource Name (ARN) for the bucket where specified job-completion
	// report will be stored.
	Bucket *string

	// The format of the specified job-completion report.
	Format JobReportFormat

	// An optional prefix to describe where in the specified bucket the job-completion
	// report will be stored. Amazon S3 stores the job-completion report at
	// /job-/report.json.
	Prefix *string

	// Indicates whether the job-completion report will include details of all tasks or
	// only failed tasks.
	ReportScope JobReportScope
	// contains filtered or unexported fields
}

Contains the configuration parameters for a job-completion report.

type JobReportFormat

type JobReportFormat string
const (
	JobReportFormatReportCsv20180820 JobReportFormat = "Report_CSV_20180820"
)

Enum values for JobReportFormat

func (JobReportFormat) Values added in v0.29.0

func (JobReportFormat) Values() []JobReportFormat

Values returns all known values for JobReportFormat. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type JobReportScope

type JobReportScope string
const (
	JobReportScopeAllTasks        JobReportScope = "AllTasks"
	JobReportScopeFailedTasksOnly JobReportScope = "FailedTasksOnly"
)

Enum values for JobReportScope

func (JobReportScope) Values added in v0.29.0

func (JobReportScope) Values() []JobReportScope

Values returns all known values for JobReportScope. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type JobStatus

type JobStatus string
const (
	JobStatusActive     JobStatus = "Active"
	JobStatusCancelled  JobStatus = "Cancelled"
	JobStatusCancelling JobStatus = "Cancelling"
	JobStatusComplete   JobStatus = "Complete"
	JobStatusCompleting JobStatus = "Completing"
	JobStatusFailed     JobStatus = "Failed"
	JobStatusFailing    JobStatus = "Failing"
	JobStatusNew        JobStatus = "New"
	JobStatusPaused     JobStatus = "Paused"
	JobStatusPausing    JobStatus = "Pausing"
	JobStatusPreparing  JobStatus = "Preparing"
	JobStatusReady      JobStatus = "Ready"
	JobStatusSuspended  JobStatus = "Suspended"
)

Enum values for JobStatus

func (JobStatus) Values added in v0.29.0

func (JobStatus) Values() []JobStatus

Values returns all known values for JobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type JobStatusException

type JobStatusException struct {
	Message *string
	// contains filtered or unexported fields
}

func (*JobStatusException) Error

func (e *JobStatusException) Error() string

func (*JobStatusException) ErrorCode

func (e *JobStatusException) ErrorCode() string

func (*JobStatusException) ErrorFault

func (e *JobStatusException) ErrorFault() smithy.ErrorFault

func (*JobStatusException) ErrorMessage

func (e *JobStatusException) ErrorMessage() string

type LambdaInvokeOperation

type LambdaInvokeOperation struct {

	// The Amazon Resource Name (ARN) for the Lambda function that the specified job
	// will invoke on every object in the manifest.
	FunctionArn *string
	// contains filtered or unexported fields
}

Contains the configuration parameters for a Lambda Invoke operation.

type LifecycleConfiguration

type LifecycleConfiguration struct {

	// A lifecycle rule for individual objects in an Outposts bucket.
	Rules []LifecycleRule
	// contains filtered or unexported fields
}

The container for the Outposts bucket lifecycle configuration.

type LifecycleExpiration

type LifecycleExpiration struct {

	// Indicates at what date the object is to be deleted. Should be in GMT ISO 8601
	// format.
	Date *time.Time

	// Indicates the lifetime, in days, of the objects that are subject to the rule.
	// The value must be a non-zero positive integer.
	Days int32

	// Indicates whether Amazon S3 will remove a delete marker with no noncurrent
	// versions. If set to true, the delete marker will be expired. If set to false,
	// the policy takes no action. This cannot be specified with Days or Date in a
	// Lifecycle Expiration Policy.
	ExpiredObjectDeleteMarker bool
	// contains filtered or unexported fields
}

The container of the Outposts bucket lifecycle expiration.

type LifecycleRule

type LifecycleRule struct {

	// If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is
	// not currently being applied.
	//
	// This member is required.
	Status ExpirationStatus

	// Specifies the days since the initiation of an incomplete multipart upload that
	// Amazon S3 waits before permanently removing all parts of the upload. For more
	// information, see  Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle
	// Policy
	// (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config)
	// in the Amazon S3 User Guide.
	AbortIncompleteMultipartUpload *AbortIncompleteMultipartUpload

	// Specifies the expiration for the lifecycle of the object in the form of date,
	// days and, whether the object has a delete marker.
	Expiration *LifecycleExpiration

	// The container for the filter of lifecycle rule.
	Filter *LifecycleRuleFilter

	// Unique identifier for the rule. The value cannot be longer than 255 characters.
	ID *string

	// The noncurrent version expiration of the lifecycle rule. This is not supported
	// by Amazon S3 on Outposts buckets.
	NoncurrentVersionExpiration *NoncurrentVersionExpiration

	// Specifies the transition rule for the lifecycle rule that describes when
	// noncurrent objects transition to a specific storage class. If your bucket is
	// versioning-enabled (or versioning is suspended), you can set this action to
	// request that Amazon S3 transition noncurrent object versions to a specific
	// storage class at a set period in the object's lifetime. This is not supported by
	// Amazon S3 on Outposts buckets.
	NoncurrentVersionTransitions []NoncurrentVersionTransition

	// Specifies when an Amazon S3 object transitions to a specified storage class.
	// This is not supported by Amazon S3 on Outposts buckets.
	Transitions []Transition
	// contains filtered or unexported fields
}

The container for the Outposts bucket lifecycle rule.

type LifecycleRuleAndOperator

type LifecycleRuleAndOperator struct {

	// Prefix identifying one or more objects to which the rule applies.
	Prefix *string

	// All of these tags must exist in the object's tag set in order for the rule to
	// apply.
	Tags []S3Tag
	// contains filtered or unexported fields
}

The container for the Outposts bucket lifecycle rule and operator.

type LifecycleRuleFilter

type LifecycleRuleFilter struct {

	// The container for the AND condition for the lifecycle rule.
	And *LifecycleRuleAndOperator

	// Prefix identifying one or more objects to which the rule applies. Replacement
	// must be made for object keys containing special characters (such as carriage
	// returns) when using XML requests. For more information, see  XML related object
	// key constraints
	// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).
	Prefix *string

	//
	Tag *S3Tag
	// contains filtered or unexported fields
}

The container for the filter of the lifecycle rule.

type ListStorageLensConfigurationEntry added in v0.30.0

type ListStorageLensConfigurationEntry struct {

	// A container for the S3 Storage Lens home Region. Your metrics data is stored and
	// retained in your designated S3 Storage Lens home Region.
	//
	// This member is required.
	HomeRegion *string

	// A container for the S3 Storage Lens configuration ID.
	//
	// This member is required.
	Id *string

	// The ARN of the S3 Storage Lens configuration. This property is read-only.
	//
	// This member is required.
	StorageLensArn *string

	// A container for whether the S3 Storage Lens configuration is enabled. This
	// property is required.
	IsEnabled bool
	// contains filtered or unexported fields
}

Part of ListStorageLensConfigurationResult. Each entry includes the description of the S3 Storage Lens configuration, its home Region, whether it is enabled, its Amazon Resource Name (ARN), and config ID.

type MultiRegionAccessPointPolicyDocument added in v1.11.0

type MultiRegionAccessPointPolicyDocument struct {

	// The last established policy for the Multi-Region Access Point.
	Established *EstablishedMultiRegionAccessPointPolicy

	// The proposed policy for the Multi-Region Access Point.
	Proposed *ProposedMultiRegionAccessPointPolicy
	// contains filtered or unexported fields
}

The Multi-Region Access Point access control policy. When you update the policy, the update is first listed as the proposed policy. After the update is finished and all Regions have been updated, the proposed policy is listed as the established policy. If both policies have the same version number, the proposed policy is the established policy.

type MultiRegionAccessPointRegionalResponse added in v1.11.0

type MultiRegionAccessPointRegionalResponse struct {

	// The name of the Region in the Multi-Region Access Point.
	Name *string

	// The current status of the Multi-Region Access Point in this Region.
	RequestStatus *string
	// contains filtered or unexported fields
}

Status information for a single Multi-Region Access Point Region.

type MultiRegionAccessPointReport added in v1.11.0

type MultiRegionAccessPointReport struct {

	// The alias for the Multi-Region Access Point. For more information about the
	// distinction between the name and the alias of an Multi-Region Access Point, see
	// Managing Multi-Region Access Points
	// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming).
	Alias *string

	// When the Multi-Region Access Point create request was received.
	CreatedAt *time.Time

	// The name of the Multi-Region Access Point.
	Name *string

	// The PublicAccessBlock configuration that you want to apply to this Amazon S3
	// account. You can enable the configuration options in any combination. For more
	// information about when Amazon S3 considers a bucket or object public, see The
	// Meaning of "Public"
	// (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status)
	// in the Amazon S3 User Guide. This is not supported for Amazon S3 on Outposts.
	PublicAccessBlock *PublicAccessBlockConfiguration

	// A collection of the Regions and buckets associated with the Multi-Region Access
	// Point.
	Regions []RegionReport

	// The current status of the Multi-Region Access Point. CREATING and DELETING are
	// temporary states that exist while the request is propogating and being
	// completed. If a Multi-Region Access Point has a status of PARTIALLY_CREATED, you
	// can retry creation or send a request to delete the Multi-Region Access Point. If
	// a Multi-Region Access Point has a status of PARTIALLY_DELETED, you can retry a
	// delete request to finish the deletion of the Multi-Region Access Point.
	Status MultiRegionAccessPointStatus
	// contains filtered or unexported fields
}

A collection of statuses for a Multi-Region Access Point in the various Regions it supports.

type MultiRegionAccessPointStatus added in v1.11.0

type MultiRegionAccessPointStatus string
const (
	MultiRegionAccessPointStatusReady                     MultiRegionAccessPointStatus = "READY"
	MultiRegionAccessPointStatusInconsistentAcrossRegions MultiRegionAccessPointStatus = "INCONSISTENT_ACROSS_REGIONS"
	MultiRegionAccessPointStatusCreating                  MultiRegionAccessPointStatus = "CREATING"
	MultiRegionAccessPointStatusPartiallyCreated          MultiRegionAccessPointStatus = "PARTIALLY_CREATED"
	MultiRegionAccessPointStatusPartiallyDeleted          MultiRegionAccessPointStatus = "PARTIALLY_DELETED"
	MultiRegionAccessPointStatusDeleting                  MultiRegionAccessPointStatus = "DELETING"
)

Enum values for MultiRegionAccessPointStatus

func (MultiRegionAccessPointStatus) Values added in v1.11.0

Values returns all known values for MultiRegionAccessPointStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type MultiRegionAccessPointsAsyncResponse added in v1.11.0

type MultiRegionAccessPointsAsyncResponse struct {

	// A collection of status information for the different Regions that a Multi-Region
	// Access Point supports.
	Regions []MultiRegionAccessPointRegionalResponse
	// contains filtered or unexported fields
}

The Multi-Region Access Point details that are returned when querying about an asynchronous request.

type NetworkOrigin

type NetworkOrigin string
const (
	NetworkOriginInternet NetworkOrigin = "Internet"
	NetworkOriginVpc      NetworkOrigin = "VPC"
)

Enum values for NetworkOrigin

func (NetworkOrigin) Values added in v0.29.0

func (NetworkOrigin) Values() []NetworkOrigin

Values returns all known values for NetworkOrigin. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type NoSuchPublicAccessBlockConfiguration

type NoSuchPublicAccessBlockConfiguration struct {
	Message *string
	// contains filtered or unexported fields
}

Amazon S3 throws this exception if you make a GetPublicAccessBlock request against an account that doesn't have a PublicAccessBlockConfiguration set.

func (*NoSuchPublicAccessBlockConfiguration) Error

func (*NoSuchPublicAccessBlockConfiguration) ErrorCode

func (*NoSuchPublicAccessBlockConfiguration) ErrorFault

func (*NoSuchPublicAccessBlockConfiguration) ErrorMessage

func (e *NoSuchPublicAccessBlockConfiguration) ErrorMessage() string

type NoncurrentVersionExpiration

type NoncurrentVersionExpiration struct {

	// Specifies the number of days an object is noncurrent before Amazon S3 can
	// perform the associated action. For information about the noncurrent days
	// calculations, see How Amazon S3 Calculates When an Object Became Noncurrent
	// (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations)
	// in the Amazon S3 User Guide.
	NoncurrentDays int32
	// contains filtered or unexported fields
}

The container of the noncurrent version expiration.

type NoncurrentVersionTransition

type NoncurrentVersionTransition struct {

	// Specifies the number of days an object is noncurrent before Amazon S3 can
	// perform the associated action. For information about the noncurrent days
	// calculations, see  How Amazon S3 Calculates How Long an Object Has Been
	// Noncurrent
	// (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations)
	// in the Amazon S3 User Guide.
	NoncurrentDays int32

	// The class of storage used to store the object.
	StorageClass TransitionStorageClass
	// contains filtered or unexported fields
}

The container for the noncurrent version transition.

type NotFoundException

type NotFoundException struct {
	Message *string
	// contains filtered or unexported fields
}

func (*NotFoundException) Error

func (e *NotFoundException) Error() string

func (*NotFoundException) ErrorCode

func (e *NotFoundException) ErrorCode() string

func (*NotFoundException) ErrorFault

func (e *NotFoundException) ErrorFault() smithy.ErrorFault

func (*NotFoundException) ErrorMessage

func (e *NotFoundException) ErrorMessage() string

type ObjectLambdaAccessPoint added in v1.3.0

type ObjectLambdaAccessPoint struct {

	// The name of the Object Lambda Access Point.
	//
	// This member is required.
	Name *string

	// Specifies the ARN for the Object Lambda Access Point.
	ObjectLambdaAccessPointArn *string
	// contains filtered or unexported fields
}

An access point with an attached Lambda function used to access transformed data from an Amazon S3 bucket.

type ObjectLambdaAllowedFeature added in v1.3.0

type ObjectLambdaAllowedFeature string
const (
	ObjectLambdaAllowedFeatureGetObjectRange      ObjectLambdaAllowedFeature = "GetObject-Range"
	ObjectLambdaAllowedFeatureGetObjectPartNumber ObjectLambdaAllowedFeature = "GetObject-PartNumber"
)

Enum values for ObjectLambdaAllowedFeature

func (ObjectLambdaAllowedFeature) Values added in v1.3.0

Values returns all known values for ObjectLambdaAllowedFeature. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ObjectLambdaConfiguration added in v1.3.0

type ObjectLambdaConfiguration struct {

	// Standard access point associated with the Object Lambda Access Point.
	//
	// This member is required.
	SupportingAccessPoint *string

	// A container for transformation configurations for an Object Lambda Access Point.
	//
	// This member is required.
	TransformationConfigurations []ObjectLambdaTransformationConfiguration

	// A container for allowed features. Valid inputs are GetObject-Range and
	// GetObject-PartNumber.
	AllowedFeatures []ObjectLambdaAllowedFeature

	// A container for whether the CloudWatch metrics configuration is enabled.
	CloudWatchMetricsEnabled bool
	// contains filtered or unexported fields
}

A configuration used when creating an Object Lambda Access Point.

type ObjectLambdaContentTransformation added in v1.3.0

type ObjectLambdaContentTransformation interface {
	// contains filtered or unexported methods
}

A container for AwsLambdaTransformation.

The following types satisfy this interface:

ObjectLambdaContentTransformationMemberAwsLambda
Example (OutputUsage)
// Code generated by smithy-go-codegen DO NOT EDIT.

package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/s3control/types"
)

func main() {
	var union types.ObjectLambdaContentTransformation
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ObjectLambdaContentTransformationMemberAwsLambda:
		_ = v.Value // Value is types.AwsLambdaTransformation

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

var _ *types.AwsLambdaTransformation
Output:

type ObjectLambdaContentTransformationMemberAwsLambda added in v1.3.0

type ObjectLambdaContentTransformationMemberAwsLambda struct {
	Value AwsLambdaTransformation
	// contains filtered or unexported fields
}

A container for an Lambda function.

type ObjectLambdaTransformationConfiguration added in v1.3.0

type ObjectLambdaTransformationConfiguration struct {

	// A container for the action of an Object Lambda Access Point configuration. Valid
	// input is GetObject.
	//
	// This member is required.
	Actions []ObjectLambdaTransformationConfigurationAction

	// A container for the content transformation of an Object Lambda Access Point
	// configuration.
	//
	// This member is required.
	ContentTransformation ObjectLambdaContentTransformation
	// contains filtered or unexported fields
}

A configuration used when creating an Object Lambda Access Point transformation.

type ObjectLambdaTransformationConfigurationAction added in v1.3.0

type ObjectLambdaTransformationConfigurationAction string
const (
	ObjectLambdaTransformationConfigurationActionGetObject ObjectLambdaTransformationConfigurationAction = "GetObject"
)

Enum values for ObjectLambdaTransformationConfigurationAction

func (ObjectLambdaTransformationConfigurationAction) Values added in v1.3.0

Values returns all known values for ObjectLambdaTransformationConfigurationAction. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type OperationName

type OperationName string
const (
	OperationNameLambdaInvoke            OperationName = "LambdaInvoke"
	OperationNameS3PutObjectCopy         OperationName = "S3PutObjectCopy"
	OperationNameS3PutObjectAcl          OperationName = "S3PutObjectAcl"
	OperationNameS3PutObjectTagging      OperationName = "S3PutObjectTagging"
	OperationNameS3DeleteObjectTagging   OperationName = "S3DeleteObjectTagging"
	OperationNameS3InitiateRestoreObject OperationName = "S3InitiateRestoreObject"
	OperationNameS3PutObjectLegalHold    OperationName = "S3PutObjectLegalHold"
	OperationNameS3PutObjectRetention    OperationName = "S3PutObjectRetention"
)

Enum values for OperationName

func (OperationName) Values added in v0.29.0

func (OperationName) Values() []OperationName

Values returns all known values for OperationName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type OutputSchemaVersion added in v0.30.0

type OutputSchemaVersion string
const (
	OutputSchemaVersionV1 OutputSchemaVersion = "V_1"
)

Enum values for OutputSchemaVersion

func (OutputSchemaVersion) Values added in v0.30.0

Values returns all known values for OutputSchemaVersion. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PolicyStatus

type PolicyStatus struct {

	//
	IsPublic bool
	// contains filtered or unexported fields
}

Indicates whether this access point policy is public. For more information about how Amazon S3 evaluates policies to determine whether they are public, see The Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) in the Amazon S3 User Guide.

type PrefixLevel added in v0.30.0

type PrefixLevel struct {

	// A container for the prefix-level storage metrics for S3 Storage Lens.
	//
	// This member is required.
	StorageMetrics *PrefixLevelStorageMetrics
	// contains filtered or unexported fields
}

A container for the prefix-level configuration.

type PrefixLevelStorageMetrics added in v0.30.0

type PrefixLevelStorageMetrics struct {

	// A container for whether prefix-level storage metrics are enabled.
	IsEnabled bool

	//
	SelectionCriteria *SelectionCriteria
	// contains filtered or unexported fields
}

A container for the prefix-level storage metrics for S3 Storage Lens.

type ProposedMultiRegionAccessPointPolicy added in v1.11.0

type ProposedMultiRegionAccessPointPolicy struct {

	// The details of the proposed policy.
	Policy *string
	// contains filtered or unexported fields
}

The proposed access control policy for the Multi-Region Access Point. When you update the policy, the update is first listed as the proposed policy. After the update is finished and all Regions have been updated, the proposed policy is listed as the established policy. If both policies have the same version number, the proposed policy is the established policy.

type PublicAccessBlockConfiguration

type PublicAccessBlockConfiguration struct {

	// Specifies whether Amazon S3 should block public access control lists (ACLs) for
	// buckets in this account. Setting this element to TRUE causes the following
	// behavior:
	//
	// * PUT Bucket acl and PUT Object acl calls fail if the specified ACL
	// is public.
	//
	// * PUT Object calls fail if the request includes a public ACL.
	//
	// * PUT
	// Bucket calls fail if the request includes a public ACL.
	//
	// Enabling this setting
	// doesn't affect existing policies or ACLs. This is not supported for Amazon S3 on
	// Outposts.
	BlockPublicAcls bool

	// Specifies whether Amazon S3 should block public bucket policies for buckets in
	// this account. Setting this element to TRUE causes Amazon S3 to reject calls to
	// PUT Bucket policy if the specified bucket policy allows public access. Enabling
	// this setting doesn't affect existing bucket policies. This is not supported for
	// Amazon S3 on Outposts.
	BlockPublicPolicy bool

	// Specifies whether Amazon S3 should ignore public ACLs for buckets in this
	// account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs
	// on buckets in this account and any objects that they contain. Enabling this
	// setting doesn't affect the persistence of any existing ACLs and doesn't prevent
	// new public ACLs from being set. This is not supported for Amazon S3 on Outposts.
	IgnorePublicAcls bool

	// Specifies whether Amazon S3 should restrict public bucket policies for buckets
	// in this account. Setting this element to TRUE restricts access to buckets with
	// public policies to only Amazon Web Service principals and authorized users
	// within this account. Enabling this setting doesn't affect previously stored
	// bucket policies, except that public and cross-account access within any public
	// bucket policy, including non-public delegation to specific accounts, is blocked.
	// This is not supported for Amazon S3 on Outposts.
	RestrictPublicBuckets bool
	// contains filtered or unexported fields
}

The PublicAccessBlock configuration that you want to apply to this Amazon S3 account. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) in the Amazon S3 User Guide. This is not supported for Amazon S3 on Outposts.

type PutMultiRegionAccessPointPolicyInput added in v1.11.0

type PutMultiRegionAccessPointPolicyInput struct {

	// The name of the Multi-Region Access Point associated with the request.
	//
	// This member is required.
	Name *string

	// The policy details for the PutMultiRegionAccessPoint request.
	//
	// This member is required.
	Policy *string
	// contains filtered or unexported fields
}

A container for the information associated with a PutMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPoint.html) request.

type Region added in v1.11.0

type Region struct {

	// The name of the associated bucket for the Region.
	//
	// This member is required.
	Bucket *string
	// contains filtered or unexported fields
}

A Region that supports a Multi-Region Access Point as well as the associated bucket for the Region.

type RegionReport added in v1.11.0

type RegionReport struct {

	// The name of the bucket.
	Bucket *string

	// The name of the Region.
	Region *string
	// contains filtered or unexported fields
}

A combination of a bucket and Region that's part of a Multi-Region Access Point.

type RegionalBucket

type RegionalBucket struct {

	//
	//
	// This member is required.
	Bucket *string

	// The creation date of the regional bucket
	//
	// This member is required.
	CreationDate *time.Time

	//
	//
	// This member is required.
	PublicAccessBlockEnabled bool

	// The Amazon Resource Name (ARN) for the regional bucket.
	BucketArn *string

	// The Outposts ID of the regional bucket.
	OutpostId *string
	// contains filtered or unexported fields
}

The container for the regional bucket.

type RequestedJobStatus

type RequestedJobStatus string
const (
	RequestedJobStatusCancelled RequestedJobStatus = "Cancelled"
	RequestedJobStatusReady     RequestedJobStatus = "Ready"
)

Enum values for RequestedJobStatus

func (RequestedJobStatus) Values added in v0.29.0

Values returns all known values for RequestedJobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type S3AccessControlList

type S3AccessControlList struct {

	//
	//
	// This member is required.
	Owner *S3ObjectOwner

	//
	Grants []S3Grant
	// contains filtered or unexported fields
}

type S3AccessControlPolicy

type S3AccessControlPolicy struct {

	//
	AccessControlList *S3AccessControlList

	//
	CannedAccessControlList S3CannedAccessControlList
	// contains filtered or unexported fields
}

type S3BucketDestination added in v0.30.0

type S3BucketDestination struct {

	// The account ID of the owner of the S3 Storage Lens metrics export bucket.
	//
	// This member is required.
	AccountId *string

	// The Amazon Resource Name (ARN) of the bucket. This property is read-only and
	// follows the following format:
	// arn:aws:s3:us-east-1:example-account-id:bucket/your-destination-bucket-name
	//
	// This member is required.
	Arn *string

	//
	//
	// This member is required.
	Format Format

	// The schema version of the export file.
	//
	// This member is required.
	OutputSchemaVersion OutputSchemaVersion

	// The container for the type encryption of the metrics exports in this bucket.
	Encryption *StorageLensDataExportEncryption

	// The prefix of the destination bucket where the metrics export will be delivered.
	Prefix *string
	// contains filtered or unexported fields
}

A container for the bucket where the Amazon S3 Storage Lens metrics export files are located.

type S3CannedAccessControlList

type S3CannedAccessControlList string
const (
	S3CannedAccessControlListPrivate                S3CannedAccessControlList = "private"
	S3CannedAccessControlListPublicRead             S3CannedAccessControlList = "public-read"
	S3CannedAccessControlListPublicReadWrite        S3CannedAccessControlList = "public-read-write"
	S3CannedAccessControlListAwsExecRead            S3CannedAccessControlList = "aws-exec-read"
	S3CannedAccessControlListAuthenticatedRead      S3CannedAccessControlList = "authenticated-read"
	S3CannedAccessControlListBucketOwnerRead        S3CannedAccessControlList = "bucket-owner-read"
	S3CannedAccessControlListBucketOwnerFullControl S3CannedAccessControlList = "bucket-owner-full-control"
)

Enum values for S3CannedAccessControlList

func (S3CannedAccessControlList) Values added in v0.29.0

Values returns all known values for S3CannedAccessControlList. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type S3CopyObjectOperation

type S3CopyObjectOperation struct {

	//
	AccessControlGrants []S3Grant

	// Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption
	// with server-side encryption using Amazon Web Services KMS (SSE-KMS). Setting
	// this header to true causes Amazon S3 to use an S3 Bucket Key for object
	// encryption with SSE-KMS. Specifying this header with an object action doesn’t
	// affect bucket-level settings for S3 Bucket Key.
	BucketKeyEnabled bool

	//
	CannedAccessControlList S3CannedAccessControlList

	//
	MetadataDirective S3MetadataDirective

	//
	ModifiedSinceConstraint *time.Time

	//
	NewObjectMetadata *S3ObjectMetadata

	//
	NewObjectTagging []S3Tag

	// The legal hold status to be applied to all objects in the Batch Operations job.
	ObjectLockLegalHoldStatus S3ObjectLockLegalHoldStatus

	// The retention mode to be applied to all objects in the Batch Operations job.
	ObjectLockMode S3ObjectLockMode

	// The date when the applied object retention configuration expires on all objects
	// in the Batch Operations job.
	ObjectLockRetainUntilDate *time.Time

	// Specifies an optional metadata property for website redirects,
	// x-amz-website-redirect-location. Allows webpage redirects if the object is
	// accessed through a website endpoint.
	RedirectLocation *string

	//
	RequesterPays bool

	//
	SSEAwsKmsKeyId *string

	//
	StorageClass S3StorageClass

	// Specifies the folder prefix into which you would like the objects to be copied.
	// For example, to copy objects into a folder named "Folder1" in the destination
	// bucket, set the TargetKeyPrefix to "Folder1/".
	TargetKeyPrefix *string

	// Specifies the destination bucket ARN for the batch copy operation. For example,
	// to copy objects to a bucket named "destinationBucket", set the TargetResource to
	// "arn:aws:s3:::destinationBucket".
	TargetResource *string

	//
	UnModifiedSinceConstraint *time.Time
	// contains filtered or unexported fields
}

Contains the configuration parameters for a PUT Copy object operation. S3 Batch Operations passes every object to the underlying PUT Copy object API. For more information about the parameters for this operation, see PUT Object - Copy (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectCOPY.html).

type S3DeleteObjectTaggingOperation added in v1.3.0

type S3DeleteObjectTaggingOperation struct {
	// contains filtered or unexported fields
}

Contains no configuration parameters because the DELETE Object tagging API only accepts the bucket name and key name as parameters, which are defined in the job's manifest.

type S3GlacierJobTier

type S3GlacierJobTier string
const (
	S3GlacierJobTierBulk     S3GlacierJobTier = "BULK"
	S3GlacierJobTierStandard S3GlacierJobTier = "STANDARD"
)

Enum values for S3GlacierJobTier

func (S3GlacierJobTier) Values added in v0.29.0

Values returns all known values for S3GlacierJobTier. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type S3Grant

type S3Grant struct {

	//
	Grantee *S3Grantee

	//
	Permission S3Permission
	// contains filtered or unexported fields
}

type S3Grantee

type S3Grantee struct {

	//
	DisplayName *string

	//
	Identifier *string

	//
	TypeIdentifier S3GranteeTypeIdentifier
	// contains filtered or unexported fields
}

type S3GranteeTypeIdentifier

type S3GranteeTypeIdentifier string
const (
	S3GranteeTypeIdentifierCanonical    S3GranteeTypeIdentifier = "id"
	S3GranteeTypeIdentifierEmailAddress S3GranteeTypeIdentifier = "emailAddress"
	S3GranteeTypeIdentifierGroup        S3GranteeTypeIdentifier = "uri"
)

Enum values for S3GranteeTypeIdentifier

func (S3GranteeTypeIdentifier) Values added in v0.29.0

Values returns all known values for S3GranteeTypeIdentifier. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type S3InitiateRestoreObjectOperation

type S3InitiateRestoreObjectOperation struct {

	// This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive
	// object remains available in Amazon S3. S3 Initiate Restore Object jobs that
	// target S3 Glacier and S3 Glacier Deep Archive objects require ExpirationInDays
	// set to 1 or greater. Conversely, do not set ExpirationInDays when creating S3
	// Initiate Restore Object jobs that target S3 Intelligent-Tiering Archive Access
	// and Deep Archive Access tier objects. Objects in S3 Intelligent-Tiering archive
	// access tiers are not subject to restore expiry, so specifying ExpirationInDays
	// results in restore request failure. S3 Batch Operations jobs can operate either
	// on S3 Glacier and S3 Glacier Deep Archive storage class objects or on S3
	// Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects,
	// but not both types in the same job. If you need to restore objects of both types
	// you must create separate Batch Operations jobs.
	ExpirationInDays *int32

	// S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the
	// EXPEDITED retrieval tier.
	GlacierJobTier S3GlacierJobTier
	// contains filtered or unexported fields
}

Contains the configuration parameters for an S3 Initiate Restore Object job. S3 Batch Operations passes every object to the underlying POST Object restore API. For more information about the parameters for this operation, see RestoreObject (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOSTrestore.html#RESTObjectPOSTrestore-restore-request).

type S3MetadataDirective

type S3MetadataDirective string
const (
	S3MetadataDirectiveCopy    S3MetadataDirective = "COPY"
	S3MetadataDirectiveReplace S3MetadataDirective = "REPLACE"
)

Enum values for S3MetadataDirective

func (S3MetadataDirective) Values added in v0.29.0

Values returns all known values for S3MetadataDirective. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type S3ObjectLockLegalHold

type S3ObjectLockLegalHold struct {

	// The Object Lock legal hold status to be applied to all objects in the Batch
	// Operations job.
	//
	// This member is required.
	Status S3ObjectLockLegalHoldStatus
	// contains filtered or unexported fields
}

Whether S3 Object Lock legal hold will be applied to objects in an S3 Batch Operations job.

type S3ObjectLockLegalHoldStatus

type S3ObjectLockLegalHoldStatus string
const (
	S3ObjectLockLegalHoldStatusOff S3ObjectLockLegalHoldStatus = "OFF"
	S3ObjectLockLegalHoldStatusOn  S3ObjectLockLegalHoldStatus = "ON"
)

Enum values for S3ObjectLockLegalHoldStatus

func (S3ObjectLockLegalHoldStatus) Values added in v0.29.0

Values returns all known values for S3ObjectLockLegalHoldStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type S3ObjectLockMode

type S3ObjectLockMode string
const (
	S3ObjectLockModeCompliance S3ObjectLockMode = "COMPLIANCE"
	S3ObjectLockModeGovernance S3ObjectLockMode = "GOVERNANCE"
)

Enum values for S3ObjectLockMode

func (S3ObjectLockMode) Values added in v0.29.0

Values returns all known values for S3ObjectLockMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type S3ObjectLockRetentionMode

type S3ObjectLockRetentionMode string
const (
	S3ObjectLockRetentionModeCompliance S3ObjectLockRetentionMode = "COMPLIANCE"
	S3ObjectLockRetentionModeGovernance S3ObjectLockRetentionMode = "GOVERNANCE"
)

Enum values for S3ObjectLockRetentionMode

func (S3ObjectLockRetentionMode) Values added in v0.29.0

Values returns all known values for S3ObjectLockRetentionMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type S3ObjectMetadata

type S3ObjectMetadata struct {

	//
	CacheControl *string

	//
	ContentDisposition *string

	//
	ContentEncoding *string

	//
	ContentLanguage *string

	//
	ContentLength int64

	//
	ContentMD5 *string

	//
	ContentType *string

	//
	HttpExpiresDate *time.Time

	//
	RequesterCharged bool

	//
	SSEAlgorithm S3SSEAlgorithm

	//
	UserMetadata map[string]string
	// contains filtered or unexported fields
}

type S3ObjectOwner

type S3ObjectOwner struct {

	//
	DisplayName *string

	//
	ID *string
	// contains filtered or unexported fields
}

type S3Permission

type S3Permission string
const (
	S3PermissionFullControl S3Permission = "FULL_CONTROL"
	S3PermissionRead        S3Permission = "READ"
	S3PermissionWrite       S3Permission = "WRITE"
	S3PermissionReadAcp     S3Permission = "READ_ACP"
	S3PermissionWriteAcp    S3Permission = "WRITE_ACP"
)

Enum values for S3Permission

func (S3Permission) Values added in v0.29.0

func (S3Permission) Values() []S3Permission

Values returns all known values for S3Permission. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type S3Retention

type S3Retention struct {

	// The Object Lock retention mode to be applied to all objects in the Batch
	// Operations job.
	Mode S3ObjectLockRetentionMode

	// The date when the applied Object Lock retention will expire on all objects set
	// by the Batch Operations job.
	RetainUntilDate *time.Time
	// contains filtered or unexported fields
}

Contains the S3 Object Lock retention mode to be applied to all objects in the S3 Batch Operations job. If you don't provide Mode and RetainUntilDate data types in your operation, you will remove the retention from your objects. For more information, see Using S3 Object Lock retention with S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html) in the Amazon S3 User Guide.

type S3SSEAlgorithm

type S3SSEAlgorithm string
const (
	S3SSEAlgorithmAes256 S3SSEAlgorithm = "AES256"
	S3SSEAlgorithmKms    S3SSEAlgorithm = "KMS"
)

Enum values for S3SSEAlgorithm

func (S3SSEAlgorithm) Values added in v0.29.0

func (S3SSEAlgorithm) Values() []S3SSEAlgorithm

Values returns all known values for S3SSEAlgorithm. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type S3SetObjectAclOperation

type S3SetObjectAclOperation struct {

	//
	AccessControlPolicy *S3AccessControlPolicy
	// contains filtered or unexported fields
}

Contains the configuration parameters for a Set Object ACL operation. S3 Batch Operations passes every object to the underlying PUT Object acl API. For more information about the parameters for this operation, see PUT Object acl (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUTacl.html).

type S3SetObjectLegalHoldOperation

type S3SetObjectLegalHoldOperation struct {

	// Contains the Object Lock legal hold status to be applied to all objects in the
	// Batch Operations job.
	//
	// This member is required.
	LegalHold *S3ObjectLockLegalHold
	// contains filtered or unexported fields
}

Contains the configuration for an S3 Object Lock legal hold operation that an S3 Batch Operations job passes every object to the underlying PutObjectLegalHold API. For more information, see Using S3 Object Lock legal hold with S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-legal-hold.html) in the Amazon S3 User Guide.

type S3SetObjectRetentionOperation

type S3SetObjectRetentionOperation struct {

	// Contains the Object Lock retention mode to be applied to all objects in the
	// Batch Operations job. For more information, see Using S3 Object Lock retention
	// with S3 Batch Operations
	// (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html)
	// in the Amazon S3 User Guide.
	//
	// This member is required.
	Retention *S3Retention

	// Indicates if the action should be applied to objects in the Batch Operations job
	// even if they have Object Lock  GOVERNANCE type in place.
	BypassGovernanceRetention bool
	// contains filtered or unexported fields
}

Contains the configuration parameters for the Object Lock retention action for an S3 Batch Operations job. Batch Operations passes every object to the underlying PutObjectRetention API. For more information, see Using S3 Object Lock retention with S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html) in the Amazon S3 User Guide.

type S3SetObjectTaggingOperation

type S3SetObjectTaggingOperation struct {

	//
	TagSet []S3Tag
	// contains filtered or unexported fields
}

Contains the configuration parameters for a Set Object Tagging operation. S3 Batch Operations passes every object to the underlying PUT Object tagging API. For more information about the parameters for this operation, see PUT Object tagging (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUTtagging.html).

type S3StorageClass

type S3StorageClass string
const (
	S3StorageClassStandard           S3StorageClass = "STANDARD"
	S3StorageClassStandardIa         S3StorageClass = "STANDARD_IA"
	S3StorageClassOnezoneIa          S3StorageClass = "ONEZONE_IA"
	S3StorageClassGlacier            S3StorageClass = "GLACIER"
	S3StorageClassIntelligentTiering S3StorageClass = "INTELLIGENT_TIERING"
	S3StorageClassDeepArchive        S3StorageClass = "DEEP_ARCHIVE"
)

Enum values for S3StorageClass

func (S3StorageClass) Values added in v0.29.0

func (S3StorageClass) Values() []S3StorageClass

Values returns all known values for S3StorageClass. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type S3Tag

type S3Tag struct {

	//
	//
	// This member is required.
	Key *string

	//
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

type SSEKMS added in v0.30.0

type SSEKMS struct {

	// A container for the ARN of the SSE-KMS encryption. This property is read-only
	// and follows the following format:
	// arn:aws:kms:us-east-1:example-account-id:key/example-9a73-4afc-8d29-8f5900cef44e
	//
	// This member is required.
	KeyId *string
	// contains filtered or unexported fields
}

type SSES3 added in v0.30.0

type SSES3 struct {
	// contains filtered or unexported fields
}

type SelectionCriteria added in v0.30.0

type SelectionCriteria struct {

	// A container for the delimiter of the selection criteria being used.
	Delimiter *string

	// The max depth of the selection criteria
	MaxDepth int32

	// The minimum number of storage bytes percentage whose metrics will be selected.
	// You must choose a value greater than or equal to 1.0.
	MinStorageBytesPercentage float64
	// contains filtered or unexported fields
}

type StorageLensAwsOrg added in v0.30.0

type StorageLensAwsOrg struct {

	// A container for the Amazon Resource Name (ARN) of the Amazon Web Services
	// organization. This property is read-only and follows the following format:
	// arn:aws:organizations:us-east-1:example-account-id:organization/o-ex2l495dck
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

The Amazon Web Services organization for your S3 Storage Lens.

type StorageLensConfiguration added in v0.30.0

type StorageLensConfiguration struct {

	// A container for all the account-level configurations of your S3 Storage Lens
	// configuration.
	//
	// This member is required.
	AccountLevel *AccountLevel

	// A container for the Amazon S3 Storage Lens configuration ID.
	//
	// This member is required.
	Id *string

	// A container for whether the S3 Storage Lens configuration is enabled.
	//
	// This member is required.
	IsEnabled bool

	// A container for the Amazon Web Services organization for this S3 Storage Lens
	// configuration.
	AwsOrg *StorageLensAwsOrg

	// A container to specify the properties of your S3 Storage Lens metrics export
	// including, the destination, schema and format.
	DataExport *StorageLensDataExport

	// A container for what is excluded in this configuration. This container can only
	// be valid if there is no Include container submitted, and it's not empty.
	Exclude *Exclude

	// A container for what is included in this configuration. This container can only
	// be valid if there is no Exclude container submitted, and it's not empty.
	Include *Include

	// The Amazon Resource Name (ARN) of the S3 Storage Lens configuration. This
	// property is read-only and follows the following format:
	// arn:aws:s3:us-east-1:example-account-id:storage-lens/your-dashboard-name
	StorageLensArn *string
	// contains filtered or unexported fields
}

A container for the Amazon S3 Storage Lens configuration.

type StorageLensDataExport added in v0.30.0

type StorageLensDataExport struct {

	// A container for the bucket where the S3 Storage Lens metrics export will be
	// located. This bucket must be located in the same Region as the storage lens
	// configuration.
	//
	// This member is required.
	S3BucketDestination *S3BucketDestination
	// contains filtered or unexported fields
}

A container to specify the properties of your S3 Storage Lens metrics export, including the destination, schema, and format.

type StorageLensDataExportEncryption added in v0.30.0

type StorageLensDataExportEncryption struct {

	//
	SSEKMS *SSEKMS

	//
	SSES3 *SSES3
	// contains filtered or unexported fields
}

A container for the encryption of the S3 Storage Lens metrics exports.

type StorageLensTag added in v0.30.0

type StorageLensTag struct {

	//
	//
	// This member is required.
	Key *string

	//
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

type Tagging

type Tagging struct {

	// A collection for a set of tags.
	//
	// This member is required.
	TagSet []S3Tag
	// contains filtered or unexported fields
}

type TooManyRequestsException

type TooManyRequestsException struct {
	Message *string
	// contains filtered or unexported fields
}

func (*TooManyRequestsException) Error

func (e *TooManyRequestsException) Error() string

func (*TooManyRequestsException) ErrorCode

func (e *TooManyRequestsException) ErrorCode() string

func (*TooManyRequestsException) ErrorFault

func (e *TooManyRequestsException) ErrorFault() smithy.ErrorFault

func (*TooManyRequestsException) ErrorMessage

func (e *TooManyRequestsException) ErrorMessage() string

type TooManyTagsException

type TooManyTagsException struct {
	Message *string
	// contains filtered or unexported fields
}

Amazon S3 throws this exception if you have too many tags in your tag set.

func (*TooManyTagsException) Error

func (e *TooManyTagsException) Error() string

func (*TooManyTagsException) ErrorCode

func (e *TooManyTagsException) ErrorCode() string

func (*TooManyTagsException) ErrorFault

func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault

func (*TooManyTagsException) ErrorMessage

func (e *TooManyTagsException) ErrorMessage() string

type Transition

type Transition struct {

	// Indicates when objects are transitioned to the specified storage class. The date
	// value must be in ISO 8601 format. The time is always midnight UTC.
	Date *time.Time

	// Indicates the number of days after creation when objects are transitioned to the
	// specified storage class. The value must be a positive integer.
	Days int32

	// The storage class to which you want the object to transition.
	StorageClass TransitionStorageClass
	// contains filtered or unexported fields
}

Specifies when an object transitions to a specified storage class. For more information about Amazon S3 Lifecycle configuration rules, see Transitioning objects using Amazon S3 Lifecycle (https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html) in the Amazon S3 User Guide.

type TransitionStorageClass

type TransitionStorageClass string
const (
	TransitionStorageClassGlacier            TransitionStorageClass = "GLACIER"
	TransitionStorageClassStandardIa         TransitionStorageClass = "STANDARD_IA"
	TransitionStorageClassOnezoneIa          TransitionStorageClass = "ONEZONE_IA"
	TransitionStorageClassIntelligentTiering TransitionStorageClass = "INTELLIGENT_TIERING"
	TransitionStorageClassDeepArchive        TransitionStorageClass = "DEEP_ARCHIVE"
)

Enum values for TransitionStorageClass

func (TransitionStorageClass) Values added in v0.29.0

Values returns all known values for TransitionStorageClass. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type UnknownUnionMember added in v1.3.0

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type VpcConfiguration

type VpcConfiguration struct {

	// If this field is specified, this access point will only allow connections from
	// the specified VPC ID.
	//
	// This member is required.
	VpcId *string
	// contains filtered or unexported fields
}

The virtual private cloud (VPC) configuration for an access point.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL