types

package
v1.44.6 Latest Latest
Warning

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

 Go to latest Published: Apr 18, 2024 License: Apache-2.0 Imports: 4 Imported by: 9

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 AccessControlTranslation added in v1.30.0 

type AccessControlTranslation struct {

	// Specifies the replica ownership.
	//
	// This member is required.
	Owner OwnerOverride
	// contains filtered or unexported fields
}

A container for information about access control for replicas. This is not supported by Amazon S3 on Outposts buckets.

type AccessGrantsLocationConfiguration added in v1.39.0 

type AccessGrantsLocationConfiguration struct {

	// The S3SubPrefix is appended to the location scope creating the grant scope. Use
	// this field to narrow the scope of the grant to a subset of the location scope.
	// This field is required if the location scope is the default location s3://
	// because you cannot create a grant for all of your S3 data in the Region and must
	// narrow the scope. For example, if the location scope is the default location
	// s3:// , the S3SubPrefx can be a /*, so the full grant scope path would be
	// s3:///* . Or the S3SubPrefx can be /* , so the full grant scope path would be or
	// s3:///* . If the S3SubPrefix includes a prefix, append the wildcard character *
	// after the prefix to indicate that you want to include all object key names in
	// the bucket that start with that prefix.
	S3SubPrefix *string
	// contains filtered or unexported fields
}

The configuration options of the S3 Access Grants location. It contains the S3SubPrefix field. The grant scope, the data to which you are granting access, is the result of appending the Subprefix field to the scope of the registered location.

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 Amazon Web Services account ID associated with the S3 bucket associated
	// with this access point.
	BucketAccountId *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 element for the S3 Storage Lens bucket-level configuration.
	//
	// This member is required.
	BucketLevel *BucketLevel

	// A container element for S3 Storage Lens activity metrics.
	ActivityMetrics *ActivityMetrics

	// A container element for S3 Storage Lens advanced cost-optimization metrics.
	AdvancedCostOptimizationMetrics *AdvancedCostOptimizationMetrics

	// A container element for S3 Storage Lens advanced data-protection metrics.
	AdvancedDataProtectionMetrics *AdvancedDataProtectionMetrics

	// A container element for detailed status code metrics.
	DetailedStatusCodesMetrics *DetailedStatusCodesMetrics

	// A container element for S3 Storage Lens groups metrics.
	StorageLensGroupLevel *StorageLensGroupLevel
	// contains filtered or unexported fields
}

A container element for the account-level Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) in the Amazon S3 User Guide.

type ActivityMetrics added in v0.30.0 

type ActivityMetrics struct {

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

The container element for Amazon S3 Storage Lens activity metrics. Activity metrics show details about how your storage is requested, such as requests (for example, All requests, Get requests, Put requests), bytes uploaded or downloaded, and errors. For more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) in the Amazon S3 User Guide.

type AdvancedCostOptimizationMetrics added in v1.26.0 

type AdvancedCostOptimizationMetrics struct {

	// A container that indicates whether advanced cost-optimization metrics are
	// enabled.
	IsEnabled bool
	// contains filtered or unexported fields
}

The container element for Amazon S3 Storage Lens advanced cost-optimization metrics. Advanced cost-optimization metrics provide insights that you can use to manage and optimize your storage costs, for example, lifecycle rule counts for transitions, expirations, and incomplete multipart uploads. For more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) in the Amazon S3 User Guide.

type AdvancedDataProtectionMetrics added in v1.26.0 

type AdvancedDataProtectionMetrics struct {

	// A container that indicates whether advanced data-protection metrics are enabled.
	IsEnabled bool
	// contains filtered or unexported fields
}

The container element for Amazon S3 Storage Lens advanced data-protection metrics. Advanced data-protection metrics provide insights that you can use to perform audits and protect your data, for example replication rule counts within and across Regions. For more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) in the Amazon S3 User Guide.

type AsyncErrorDetails added in v1.11.0 

type AsyncErrorDetails struct {

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

	// A generic description 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 

func (AsyncOperationName) Values() []AsyncOperationName

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

	ErrorCodeOverride *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

	ErrorCodeOverride *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

	ErrorCodeOverride *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 S3 Storage Lens.
	ActivityMetrics *ActivityMetrics

	// A container for bucket-level advanced cost-optimization metrics for S3 Storage
	// Lens.
	AdvancedCostOptimizationMetrics *AdvancedCostOptimizationMetrics

	// A container for bucket-level advanced data-protection metrics for S3 Storage
	// Lens.
	AdvancedDataProtectionMetrics *AdvancedDataProtectionMetrics

	// A container for bucket-level detailed status code metrics for S3 Storage Lens.
	DetailedStatusCodesMetrics *DetailedStatusCodesMetrics

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

A container for the bucket-level configuration for Amazon S3 Storage Lens. For more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the Amazon S3 User Guide.

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 

func (BucketLocationConstraint) Values() []BucketLocationConstraint

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 BucketVersioningStatus added in v1.23.0 

type BucketVersioningStatus string
const (
	BucketVersioningStatusEnabled   BucketVersioningStatus = "Enabled"
	BucketVersioningStatusSuspended BucketVersioningStatus = "Suspended"
)

Enum values for BucketVersioningStatus

func (BucketVersioningStatus) Values added in v1.23.0 

func (BucketVersioningStatus) Values() []BucketVersioningStatus

Values returns all known values for BucketVersioningStatus. 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 CloudWatchMetrics added in v1.15.0 

type CloudWatchMetrics struct {

	// A container that indicates whether CloudWatch publishing for S3 Storage Lens
	// metrics is enabled. A value of true indicates that CloudWatch publishing for S3
	// Storage Lens metrics is enabled.
	//
	// This member is required.
	IsEnabled bool
	// contains filtered or unexported fields
}

A container for enabling Amazon CloudWatch publishing for S3 Storage Lens metrics. For more information about publishing S3 Storage Lens metrics to CloudWatch, see Monitor S3 Storage Lens metrics in CloudWatch (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_view_metrics_cloudwatch.html) in the Amazon S3 User Guide.

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 data type 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 Credentials added in v1.39.0 

type Credentials struct {

	// The unique access key ID of the Amazon Web Services STS temporary credential
	// that S3 Access Grants vends to grantees and client applications.
	AccessKeyId *string

	// The expiration date and time of the temporary credential that S3 Access Grants
	// vends to grantees and client applications.
	Expiration *time.Time

	// The secret access key of the Amazon Web Services STS temporary credential that
	// S3 Access Grants vends to grantees and client applications.
	SecretAccessKey *string

	// The Amazon Web Services STS temporary credential that S3 Access Grants vends to
	// grantees and client applications.
	SessionToken *string
	// contains filtered or unexported fields
}

The Amazon Web Services Security Token Service temporary credential that S3 Access Grants vends to grantees and client applications.

type DeleteMarkerReplication added in v1.30.0 

type DeleteMarkerReplication struct {

	// Indicates whether to replicate delete markers.
	//
	// This member is required.
	Status DeleteMarkerReplicationStatus
	// contains filtered or unexported fields
}

Specifies whether S3 on Outposts replicates delete markers. If you specify a Filter element in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication element's Status child element must be set to Disabled , because S3 on Outposts does not support replicating delete markers for tag-based rules. For more information about delete marker replication, see How delete operations affect replication (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html#outposts-replication-what-is-replicated) in the Amazon S3 User Guide.

type DeleteMarkerReplicationStatus added in v1.30.0 

type DeleteMarkerReplicationStatus string
const (
	DeleteMarkerReplicationStatusEnabled  DeleteMarkerReplicationStatus = "Enabled"
	DeleteMarkerReplicationStatusDisabled DeleteMarkerReplicationStatus = "Disabled"
)

Enum values for DeleteMarkerReplicationStatus

func (DeleteMarkerReplicationStatus) Values added in v1.30.0 

func (DeleteMarkerReplicationStatus) Values() []DeleteMarkerReplicationStatus

Values returns all known values for DeleteMarkerReplicationStatus. 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 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 Destination added in v1.30.0 

type Destination struct {

	// The Amazon Resource Name (ARN) of the access point for the destination bucket
	// where you want S3 on Outposts to store the replication results.
	//
	// This member is required.
	Bucket *string

	// Specify this property only in a cross-account scenario (where the source and
	// destination bucket owners are not the same), and you want to change replica
	// ownership to the Amazon Web Services account that owns the destination bucket.
	// If this property is not specified in the replication configuration, the replicas
	// are owned by same Amazon Web Services account that owns the source object. This
	// is not supported by Amazon S3 on Outposts buckets.
	AccessControlTranslation *AccessControlTranslation

	// The destination bucket owner's account ID.
	Account *string

	// A container that provides information about encryption. If
	// SourceSelectionCriteria is specified, you must specify this element. This is not
	// supported by Amazon S3 on Outposts buckets.
	EncryptionConfiguration *EncryptionConfiguration

	// A container that specifies replication metrics-related settings.
	Metrics *Metrics

	// A container that specifies S3 Replication Time Control (S3 RTC) settings,
	// including whether S3 RTC is enabled and the time when all objects and operations
	// on objects must be replicated. Must be specified together with a Metrics block.
	// This is not supported by Amazon S3 on Outposts buckets.
	ReplicationTime *ReplicationTime

	// The storage class to use when replicating objects. All objects stored on S3 on
	// Outposts are stored in the OUTPOSTS storage class. S3 on Outposts uses the
	// OUTPOSTS storage class to create the object replicas. Values other than OUTPOSTS
	// aren't supported by Amazon S3 on Outposts.
	StorageClass ReplicationStorageClass
	// contains filtered or unexported fields
}

Specifies information about the replication destination bucket and its settings for an S3 on Outposts replication configuration.

type DetailedStatusCodesMetrics added in v1.26.0 

type DetailedStatusCodesMetrics struct {

	// A container that indicates whether detailed status code metrics are enabled.
	IsEnabled bool
	// contains filtered or unexported fields
}

The container element for Amazon S3 Storage Lens detailed status code metrics. Detailed status code metrics generate metrics for HTTP status codes, such as 200 OK , 403 Forbidden , 503 Service Unavailable and others. For more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) in the Amazon S3 User Guide.

type EncryptionConfiguration added in v1.30.0 

type EncryptionConfiguration struct {

	// Specifies the ID of the customer managed KMS key that's stored in Key
	// Management Service (KMS) for the destination bucket. This ID is either the
	// Amazon Resource Name (ARN) for the KMS key or the alias ARN for the KMS key.
	// Amazon S3 uses this KMS key to encrypt replica objects. Amazon S3 supports only
	// symmetric encryption KMS keys. For more information, see Symmetric encryption
	// KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks)
	// in the Amazon Web Services Key Management Service Developer Guide.
	ReplicaKmsKeyID *string
	// contains filtered or unexported fields
}

Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects. This is not supported by Amazon S3 on Outposts buckets.

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 ExistingObjectReplication added in v1.30.0 

type ExistingObjectReplication struct {

	// Specifies whether Amazon S3 replicates existing source bucket objects.
	//
	// This member is required.
	Status ExistingObjectReplicationStatus
	// contains filtered or unexported fields
}

An optional configuration to replicate existing source bucket objects. This is not supported by Amazon S3 on Outposts buckets.

type ExistingObjectReplicationStatus added in v1.30.0 

type ExistingObjectReplicationStatus string
const (
	ExistingObjectReplicationStatusEnabled  ExistingObjectReplicationStatus = "Enabled"
	ExistingObjectReplicationStatusDisabled ExistingObjectReplicationStatus = "Disabled"
)

Enum values for ExistingObjectReplicationStatus

func (ExistingObjectReplicationStatus) Values added in v1.30.0 

func (ExistingObjectReplicationStatus) Values() []ExistingObjectReplicationStatus

Values returns all known values for ExistingObjectReplicationStatus. 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 ExpirationStatus 

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

Enum values for ExpirationStatus

func (ExpirationStatus) Values added in v0.29.0 

func (ExpirationStatus) Values() []ExpirationStatus

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 GeneratedManifestEncryption added in v1.19.0 

type GeneratedManifestEncryption struct {

	// Configuration details on how SSE-KMS is used to encrypt generated manifest
	// objects.
	SSEKMS *SSEKMSEncryption

	// Specifies the use of SSE-S3 to encrypt generated manifest objects.
	SSES3 *SSES3Encryption
	// contains filtered or unexported fields
}

The encryption configuration to use when storing the generated manifest.

type GeneratedManifestFormat added in v1.19.0 

type GeneratedManifestFormat string
const (
	GeneratedManifestFormatS3InventoryReportCsv20211130 GeneratedManifestFormat = "S3InventoryReport_CSV_20211130"
)

Enum values for GeneratedManifestFormat

func (GeneratedManifestFormat) Values added in v1.19.0 

func (GeneratedManifestFormat) Values() []GeneratedManifestFormat

Values returns all known values for GeneratedManifestFormat. 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 Grantee added in v1.39.0 

type Grantee struct {

	// The unique identifier of the Grantee . If the grantee type is IAM , the
	// identifier is the IAM Amazon Resource Name (ARN) of the user or role. If the
	// grantee type is a directory user or group, the identifier is 128-bit universally
	// unique identifier (UUID) in the format a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 .
	// You can obtain this UUID from your Amazon Web Services IAM Identity Center
	// instance.
	GranteeIdentifier *string

	// The type of the grantee to which access has been granted. It can be one of the
	// following values:
	//   - IAM - An IAM user or role.
	//   - DIRECTORY_USER - Your corporate directory user. You can use this option if
	//   you have added your corporate identity directory to IAM Identity Center and
	//   associated the IAM Identity Center instance with your S3 Access Grants instance.
	//
	//   - DIRECTORY_GROUP - Your corporate directory group. You can use this option if
	//   you have added your corporate identity directory to IAM Identity Center and
	//   associated the IAM Identity Center instance with your S3 Access Grants instance.
	GranteeType GranteeType
	// contains filtered or unexported fields
}

The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.

type GranteeType added in v1.39.0 

type GranteeType string
const (
	GranteeTypeDirectoryUser  GranteeType = "DIRECTORY_USER"
	GranteeTypeDirectoryGroup GranteeType = "DIRECTORY_GROUP"
	GranteeTypeIam            GranteeType = "IAM"
)

Enum values for GranteeType

func (GranteeType) Values added in v1.39.0 

func (GranteeType) Values() []GranteeType

Values returns all known values for GranteeType. 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

	ErrorCodeOverride *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

	ErrorCodeOverride *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

	ErrorCodeOverride *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 (e *InvalidNextTokenException) ErrorFault() smithy.ErrorFault

func (*InvalidNextTokenException) ErrorMessage 

func (e *InvalidNextTokenException) ErrorMessage() string

type InvalidRequestException 

type InvalidRequestException struct {
	Message *string

	ErrorCodeOverride *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 attribute of the JobDescriptor containing details about the job's generated
	// manifest.
	GeneratedManifestDescriptor *S3GeneratedManifestDescriptor

	// 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 manifest generator that was used to generate a job manifest for this job.
	ManifestGenerator JobManifestGenerator

	// 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.
	// Manifests can't be imported from directory buckets. For more information, see
	// Directory buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html)
	// .
	//
	// 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 

func (JobManifestFieldName) Values() []JobManifestFieldName

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 

func (JobManifestFormat) Values() []JobManifestFormat

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 JobManifestGenerator added in v1.19.0 

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

Configures the type of the job's ManifestGenerator.

The following types satisfy this interface: 

JobManifestGeneratorMemberS3JobManifestGenerator
Example (OutputUsage) 
package main

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

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

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

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

	}
}

Output:

type JobManifestGeneratorFilter added in v1.19.0 

type JobManifestGeneratorFilter struct {

	// If provided, the generated manifest includes only source bucket objects that
	// were created after this time.
	CreatedAfter *time.Time

	// If provided, the generated manifest includes only source bucket objects that
	// were created before this time.
	CreatedBefore *time.Time

	// Include objects in the generated manifest only if they are eligible for
	// replication according to the Replication configuration on the source bucket.
	EligibleForReplication *bool

	// If provided, the generated manifest includes only source bucket objects whose
	// object keys match the string constraints specified for MatchAnyPrefix ,
	// MatchAnySuffix , and MatchAnySubstring .
	KeyNameConstraint *KeyNameConstraint

	// If provided, the generated manifest includes only source bucket objects that
	// are stored with the specified storage class.
	MatchAnyStorageClass []S3StorageClass

	// If provided, the generated manifest includes only source bucket objects that
	// have one of the specified Replication statuses.
	ObjectReplicationStatuses []ReplicationStatus

	// If provided, the generated manifest includes only source bucket objects whose
	// file size is greater than the specified number of bytes.
	ObjectSizeGreaterThanBytes *int64

	// If provided, the generated manifest includes only source bucket objects whose
	// file size is less than the specified number of bytes.
	ObjectSizeLessThanBytes *int64
	// contains filtered or unexported fields
}

The filter used to describe a set of objects for the job's manifest.

type JobManifestGeneratorMemberS3JobManifestGenerator added in v1.19.0 

type JobManifestGeneratorMemberS3JobManifestGenerator struct {
	Value S3JobManifestGenerator
	// contains filtered or unexported fields
}

The S3 job ManifestGenerator's configuration details.

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. When you're using XML
	// requests, you must replace special characters (such as carriage returns) in
	// object keys with their equivalent XML entity codes. 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)
	// in the Amazon S3 User Guide.
	//
	// 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. Manifests can't be imported from directory buckets. For more information, see Directory buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html) .

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. This functionality is not supported by directory
	// buckets.
	S3DeleteObjectTagging *S3DeleteObjectTaggingOperation

	// Directs the specified job to initiate restore requests for every archived
	// object in the manifest. This functionality is not supported by directory
	// buckets.
	S3InitiateRestoreObject *S3InitiateRestoreObjectOperation

	// Directs the specified job to run a PutObjectAcl call on every object in the
	// manifest. This functionality is not supported by directory buckets.
	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 to every object to the underlying
	// PutObjectLegalHold API operation. 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. This functionality is not supported by directory
	// buckets.
	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 operation. 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 functionality is not supported by directory
	// buckets.
	S3PutObjectRetention *S3SetObjectRetentionOperation

	// Directs the specified job to run a PUT Object tagging call on every object in
	// the manifest. This functionality is not supported by directory buckets.
	S3PutObjectTagging *S3SetObjectTaggingOperation

	// Directs the specified job to invoke ReplicateObject on every object in the
	// job's manifest. This functionality is not supported by directory buckets.
	S3ReplicateObject *S3ReplicateObjectOperation
	// 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

	// The JobTimers attribute of a job's progress summary.
	Timers *JobTimers

	//
	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. Directory buckets - Directory buckets aren't supported as
	// a location for Batch Operations to store job completion reports.
	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

	ErrorCodeOverride *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 JobTimers added in v1.19.0 

type JobTimers struct {

	// Indicates the elapsed time in seconds the job has been in the Active job state.
	ElapsedTimeInActiveSeconds *int64
	// contains filtered or unexported fields
}

Provides timing details for the job.

type KeyNameConstraint added in v1.38.0 

type KeyNameConstraint struct {

	// If provided, the generated manifest includes objects where the specified string
	// appears at the start of the object key string.
	MatchAnyPrefix []string

	// If provided, the generated manifest includes objects where the specified string
	// appears anywhere within the object key string.
	MatchAnySubstring []string

	// If provided, the generated manifest includes objects where the specified string
	// appears at the end of the object key string.
	MatchAnySuffix []string
	// contains filtered or unexported fields
}

If provided, the generated manifest includes only source bucket objects whose object keys match the string constraints specified for MatchAnyPrefix , MatchAnySuffix , and MatchAnySubstring .

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

	// Specifies the schema version for the payload that Batch Operations sends when
	// invoking an Lambda function. Version 1.0 is the default. Version 2.0 is
	// required when you use Batch Operations to invoke Lambda functions that act on
	// directory buckets, or if you need to specify UserArguments . For more
	// information, see Automate object processing in Amazon S3 directory buckets with
	// S3 Batch Operations and Lambda (https://aws.amazon.com/blogs/storage/automate-object-processing-in-amazon-s3-directory-buckets-with-s3-batch-operations-and-aws-lambda/)
	// in the Amazon Web Services Storage Blog. Ensure that your Lambda function code
	// expects InvocationSchemaVersion 2.0 and uses bucket name rather than bucket
	// ARN. If the InvocationSchemaVersion does not match what your Lambda function
	// expects, your function might not work as expected. Directory buckets - To
	// initiate Amazon Web Services Lambda function to perform custom actions on
	// objects in directory buckets, you must specify 2.0 .
	InvocationSchemaVersion *string

	// Key-value pairs that are passed in the payload that Batch Operations sends when
	// invoking an Lambda function. You must specify InvocationSchemaVersion 2.0 for
	// LambdaInvoke operations that include UserArguments . For more information, see
	// Automate object processing in Amazon S3 directory buckets with S3 Batch
	// Operations and Lambda (https://aws.amazon.com/blogs/storage/automate-object-processing-in-amazon-s3-directory-buckets-with-s3-batch-operations-and-aws-lambda/)
	// in the Amazon Web Services Storage Blog.
	UserArguments map[string]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
	// Configuration (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.
	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 {

	// The non-inclusive minimum object size for the lifecycle rule. Setting this
	// property to 7 means the rule applies to objects with a size that is greater than
	// 7.
	ObjectSizeGreaterThan *int64

	// The non-inclusive maximum object size for the lifecycle rule. Setting this
	// property to 77 means the rule applies to objects with a size that is less than
	// 77.
	ObjectSizeLessThan *int64

	// 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

	// Minimum object size to which the rule applies.
	ObjectSizeGreaterThan *int64

	// Maximum object size to which the rule applies.
	ObjectSizeLessThan *int64

	// Prefix identifying one or more objects to which the rule applies. When you're
	// using XML requests, you must replace special characters (such as carriage
	// returns) in object keys with their equivalent XML entity codes. 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)
	// in the Amazon S3 User Guide.
	Prefix *string

	// A container for a key-value name pair.
	Tag *S3Tag
	// contains filtered or unexported fields
}

The container for the filter of the lifecycle rule.

type ListAccessGrantEntry added in v1.39.0 

type ListAccessGrantEntry struct {

	// The Amazon Resource Name (ARN) of the access grant.
	AccessGrantArn *string

	// The ID of the access grant. S3 Access Grants auto-generates this ID when you
	// create the access grant.
	AccessGrantId *string

	// The configuration options of the grant location. The grant location is the S3
	// path to the data to which you are granting access.
	AccessGrantsLocationConfiguration *AccessGrantsLocationConfiguration

	// The ID of the registered location to which you are granting access. S3 Access
	// Grants assigns this ID when you register the location. S3 Access Grants assigns
	// the ID default to the default location s3:// and assigns an auto-generated ID
	// to other locations that you register.
	AccessGrantsLocationId *string

	// The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center
	// application associated with your Identity Center instance. If the grant includes
	// an application ARN, the grantee can only access the S3 data through this
	// application.
	ApplicationArn *string

	// The date and time when you created the S3 Access Grants instance.
	CreatedAt *time.Time

	// The S3 path of the data to which you are granting access. It is the result of
	// appending the Subprefix to the location scope.
	GrantScope *string

	// The user, group, or role to which you are granting access. You can grant access
	// to an IAM user or role. If you have added your corporate directory to Amazon Web
	// Services IAM Identity Center and associated your Identity Center instance with
	// your S3 Access Grants instance, the grantee can also be a corporate directory
	// user or group.
	Grantee *Grantee

	// The type of access granted to your S3 data, which can be set to one of the
	// following values:
	//   - READ – Grant read-only access to the S3 data.
	//   - WRITE – Grant write-only access to the S3 data.
	//   - READWRITE – Grant both read and write access to the S3 data.
	Permission Permission
	// contains filtered or unexported fields
}

Information about the access grant.

type ListAccessGrantsInstanceEntry added in v1.39.0 

type ListAccessGrantsInstanceEntry struct {

	// The Amazon Resource Name (ARN) of the S3 Access Grants instance.
	AccessGrantsInstanceArn *string

	// The ID of the S3 Access Grants instance. The ID is default . You can have one S3
	// Access Grants instance per Region per account.
	AccessGrantsInstanceId *string

	// The date and time when you created the S3 Access Grants instance.
	CreatedAt *time.Time

	// If you associated your S3 Access Grants instance with an Amazon Web Services
	// IAM Identity Center instance, this field returns the Amazon Resource Name (ARN)
	// of the IAM Identity Center instance application; a subresource of the original
	// Identity Center instance. S3 Access Grants creates this Identity Center
	// application for the specific S3 Access Grants instance.
	IdentityCenterArn *string
	// contains filtered or unexported fields
}

Information about the S3 Access Grants instance.

type ListAccessGrantsLocationsEntry added in v1.39.0 

type ListAccessGrantsLocationsEntry struct {

	// The Amazon Resource Name (ARN) of the registered location.
	AccessGrantsLocationArn *string

	// The ID of the registered location to which you are granting access. S3 Access
	// Grants assigns this ID when you register the location. S3 Access Grants assigns
	// the ID default to the default location s3:// and assigns an auto-generated ID
	// to other locations that you register.
	AccessGrantsLocationId *string

	// The date and time when you registered the location.
	CreatedAt *time.Time

	// The Amazon Resource Name (ARN) of the IAM role for the registered location. S3
	// Access Grants assumes this role to manage access to the registered location.
	IAMRoleArn *string

	// The S3 path to the location that you are registering. The location scope can be
	// the default S3 location s3:// , the S3 path to a bucket s3:// , or the S3 path
	// to a bucket and prefix s3:/// . A prefix in S3 is a string of characters at the
	// beginning of an object key name used to organize the objects that you store in
	// your S3 buckets. For example, object key names that start with the engineering/
	// prefix or object key names that start with the marketing/campaigns/ prefix.
	LocationScope *string
	// contains filtered or unexported fields
}

A container for information about the registered location.

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 ListStorageLensGroupEntry added in v1.37.0 

type ListStorageLensGroupEntry struct {

	// Contains the Amazon Web Services Region where the Storage Lens group was
	// created.
	//
	// This member is required.
	HomeRegion *string

	// Contains the name of the Storage Lens group that exists in the specified home
	// Region.
	//
	// This member is required.
	Name *string

	// Contains the Amazon Resource Name (ARN) of the Storage Lens group. This
	// property is read-only.
	//
	// This member is required.
	StorageLensGroupArn *string
	// contains filtered or unexported fields
}

Each entry contains a Storage Lens group that exists in the specified home Region.

type MFADelete added in v1.23.0 

type MFADelete string
const (
	MFADeleteEnabled  MFADelete = "Enabled"
	MFADeleteDisabled MFADelete = "Disabled"
)

Enum values for MFADelete

func (MFADelete) Values added in v1.23.0 

func (MFADelete) Values() []MFADelete

Values returns all known values for MFADelete. 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 MFADeleteStatus added in v1.23.0 

type MFADeleteStatus string
const (
	MFADeleteStatusEnabled  MFADeleteStatus = "Enabled"
	MFADeleteStatusDisabled MFADeleteStatus = "Disabled"
)

Enum values for MFADeleteStatus

func (MFADeleteStatus) Values added in v1.23.0 

func (MFADeleteStatus) Values() []MFADeleteStatus

Values returns all known values for MFADeleteStatus. 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 MatchObjectAge added in v1.37.0 

type MatchObjectAge struct {

	// Specifies the maximum object age in days. Must be a positive whole number,
	// greater than the minimum object age and less than or equal to 2,147,483,647.
	DaysGreaterThan int32

	// Specifies the minimum object age in days. The value must be a positive whole
	// number, greater than 0 and less than or equal to 2,147,483,647.
	DaysLessThan int32
	// contains filtered or unexported fields
}

A filter condition that specifies the object age range of included objects in days. Only integers are supported.

type MatchObjectSize added in v1.37.0 

type MatchObjectSize struct {

	// Specifies the minimum object size in Bytes. The value must be a positive
	// number, greater than 0 and less than 5 TB.
	BytesGreaterThan int64

	// Specifies the maximum object size in Bytes. The value must be a positive
	// number, greater than the minimum object size and less than 5 TB.
	BytesLessThan int64
	// contains filtered or unexported fields
}

A filter condition that specifies the object size range of included objects in bytes. Only integers are supported.

type Metrics added in v1.30.0 

type Metrics struct {

	// Specifies whether replication metrics are enabled.
	//
	// This member is required.
	Status MetricsStatus

	// A container that specifies the time threshold for emitting the
	// s3:Replication:OperationMissedThreshold event. This is not supported by Amazon
	// S3 on Outposts buckets.
	EventThreshold *ReplicationTimeValue
	// contains filtered or unexported fields
}

A container that specifies replication metrics-related settings.

type MetricsStatus added in v1.30.0 

type MetricsStatus string
const (
	MetricsStatusEnabled  MetricsStatus = "Enabled"
	MetricsStatusDisabled MetricsStatus = "Disabled"
)

Enum values for MetricsStatus

func (MetricsStatus) Values added in v1.30.0 

func (MetricsStatus) Values() []MetricsStatus

Values returns all known values for MetricsStatus. 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 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
	// Rules for naming Amazon S3 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 data type 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 propagating 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 MultiRegionAccessPointRoute added in v1.27.0 

type MultiRegionAccessPointRoute struct {

	// The traffic state for the specified bucket or Amazon Web Services Region. A
	// value of 0 indicates a passive state, which means that no new traffic will be
	// routed to the Region. A value of 100 indicates an active state, which means
	// that traffic will be routed to the specified Region. When the routing
	// configuration for a Region is changed from active to passive, any in-progress
	// operations (uploads, copies, deletes, and so on) to the formerly active Region
	// will continue to run to until a final success or failure status is reached. If
	// all Regions in the routing configuration are designated as passive, you'll
	// receive an InvalidRequest error.
	//
	// This member is required.
	TrafficDialPercentage *int32

	// The name of the Amazon S3 bucket for which you'll submit a routing
	// configuration change. Either the Bucket or the Region value must be provided.
	// If both are provided, the bucket must be in the specified Region.
	Bucket *string

	// The Amazon Web Services Region to which you'll be submitting a routing
	// configuration change. Either the Bucket or the Region value must be provided.
	// If both are provided, the bucket must be in the specified Region.
	Region *string
	// contains filtered or unexported fields
}

A structure for a Multi-Region Access Point that indicates where Amazon S3 traffic can be routed. Routes can be either active or passive. Active routes can process Amazon S3 requests through the Multi-Region Access Point, but passive routes are not eligible to process Amazon S3 requests. Each route contains the Amazon S3 bucket name and the Amazon Web Services Region that the bucket is located in. The route also includes the TrafficDialPercentage value, which shows whether the bucket and Region are active (indicated by a value of 100 ) or passive (indicated by a value of 0 ).

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 

func (MultiRegionAccessPointStatus) Values() []MultiRegionAccessPointStatus

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

	ErrorCodeOverride *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 (e *NoSuchPublicAccessBlockConfiguration) Error() string

func (*NoSuchPublicAccessBlockConfiguration) ErrorCode 

func (e *NoSuchPublicAccessBlockConfiguration) ErrorCode() string

func (*NoSuchPublicAccessBlockConfiguration) ErrorFault 

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

func (*NoSuchPublicAccessBlockConfiguration) ErrorMessage 

func (e *NoSuchPublicAccessBlockConfiguration) ErrorMessage() string

type NoncurrentVersionExpiration 

type NoncurrentVersionExpiration struct {

	// Specifies how many noncurrent versions S3 on Outposts will retain. If there are
	// this many more recent noncurrent versions, S3 on Outposts will take the
	// associated action. For more information about noncurrent versions, see
	// Lifecycle configuration elements (https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html)
	// in the Amazon S3 User Guide.
	NewerNoncurrentVersions *int32

	// 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

	ErrorCodeOverride *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

	// The alias of the Object Lambda Access Point.
	Alias *ObjectLambdaAccessPointAlias

	// 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 ObjectLambdaAccessPointAlias added in v1.31.0 

type ObjectLambdaAccessPointAlias struct {

	// The status of the Object Lambda Access Point alias. If the status is
	// PROVISIONING , the Object Lambda Access Point is provisioning the alias and the
	// alias is not ready for use yet. If the status is READY , the Object Lambda
	// Access Point alias is successfully provisioned and ready for use.
	Status ObjectLambdaAccessPointAliasStatus

	// The alias value of the Object Lambda Access Point.
	Value *string
	// contains filtered or unexported fields
}

The alias of an Object Lambda Access Point. For more information, see How to use a bucket-style alias for your S3 bucket Object Lambda Access Point (https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-use.html#ol-access-points-alias) .

type ObjectLambdaAccessPointAliasStatus added in v1.31.0 

type ObjectLambdaAccessPointAliasStatus string
const (
	ObjectLambdaAccessPointAliasStatusProvisioning ObjectLambdaAccessPointAliasStatus = "PROVISIONING"
	ObjectLambdaAccessPointAliasStatusReady        ObjectLambdaAccessPointAliasStatus = "READY"
)

Enum values for ObjectLambdaAccessPointAliasStatus

func (ObjectLambdaAccessPointAliasStatus) Values added in v1.31.0 

func (ObjectLambdaAccessPointAliasStatus) Values() []ObjectLambdaAccessPointAliasStatus

Values returns all known values for ObjectLambdaAccessPointAliasStatus. 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 ObjectLambdaAllowedFeature added in v1.3.0 

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

Enum values for ObjectLambdaAllowedFeature

func (ObjectLambdaAllowedFeature) Values added in v1.3.0 

func (ObjectLambdaAllowedFeature) Values() []ObjectLambdaAllowedFeature

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 ,
	// GetObject-PartNumber , HeadObject-Range , and HeadObject-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) 
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")

	}
}

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 inputs are GetObject , ListObjects , HeadObject , and ListObjectsV2 .
	//
	// 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"
	ObjectLambdaTransformationConfigurationActionHeadObject    ObjectLambdaTransformationConfigurationAction = "HeadObject"
	ObjectLambdaTransformationConfigurationActionListObjects   ObjectLambdaTransformationConfigurationAction = "ListObjects"
	ObjectLambdaTransformationConfigurationActionListObjectsV2 ObjectLambdaTransformationConfigurationAction = "ListObjectsV2"
)

Enum values for ObjectLambdaTransformationConfigurationAction

func (ObjectLambdaTransformationConfigurationAction) Values added in v1.3.0 

func (ObjectLambdaTransformationConfigurationAction) Values() []ObjectLambdaTransformationConfigurationAction

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"
	OperationNameS3ReplicateObject       OperationName = "S3ReplicateObject"
)

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 

func (OutputSchemaVersion) Values() []OutputSchemaVersion

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 OwnerOverride added in v1.30.0 

type OwnerOverride string
const (
	OwnerOverrideDestination OwnerOverride = "Destination"
)

Enum values for OwnerOverride

func (OwnerOverride) Values added in v1.30.0 

func (OwnerOverride) Values() []OwnerOverride

Values returns all known values for OwnerOverride. 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 Permission added in v1.39.0 

type Permission string
const (
	PermissionRead      Permission = "READ"
	PermissionWrite     Permission = "WRITE"
	PermissionReadwrite Permission = "READWRITE"
)

Enum values for Permission

func (Permission) Values added in v1.39.0 

func (Permission) Values() []Permission

Values returns all known values for Permission. 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 Privilege added in v1.39.0 

type Privilege string
const (
	PrivilegeMinimal Privilege = "Minimal"
	PrivilegeDefault Privilege = "Default"
)

Enum values for Privilege

func (Privilege) Values added in v1.39.0 

func (Privilege) Values() []Privilege

Values returns all known values for Privilege. 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 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:
	//   - PutBucketAcl and PutObjectAcl 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 property
	// 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 property 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 property 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 property 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 data type 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

	// The Amazon Web Services account ID that owns the Amazon S3 bucket that's
	// associated with this Multi-Region Access Point.
	BucketAccountId *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 Amazon Web Services account ID that owns the Amazon S3 bucket that's
	// associated with this Multi-Region Access Point.
	BucketAccountId *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 ReplicaModifications added in v1.30.0 

type ReplicaModifications struct {

	// Specifies whether S3 on Outposts replicates modifications to object metadata on
	// replicas.
	//
	// This member is required.
	Status ReplicaModificationsStatus
	// contains filtered or unexported fields
}

A filter that you can use to specify whether replica modification sync is enabled. S3 on Outposts replica modification sync can help you keep object metadata synchronized between replicas and source objects. By default, S3 on Outposts replicates metadata from the source objects to the replicas only. When replica modification sync is enabled, S3 on Outposts replicates metadata changes made to the replica copies back to the source object, making the replication bidirectional. To replicate object metadata modifications on replicas, you can specify this element and set the Status of this element to Enabled . You must enable replica modification sync on the source and destination buckets to replicate replica metadata changes between the source and the replicas.

type ReplicaModificationsStatus added in v1.30.0 

type ReplicaModificationsStatus string
const (
	ReplicaModificationsStatusEnabled  ReplicaModificationsStatus = "Enabled"
	ReplicaModificationsStatusDisabled ReplicaModificationsStatus = "Disabled"
)

Enum values for ReplicaModificationsStatus

func (ReplicaModificationsStatus) Values added in v1.30.0 

func (ReplicaModificationsStatus) Values() []ReplicaModificationsStatus

Values returns all known values for ReplicaModificationsStatus. 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 ReplicationConfiguration added in v1.30.0 

type ReplicationConfiguration struct {

	// The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
	// that S3 on Outposts assumes when replicating objects. For information about S3
	// replication on Outposts configuration, see Setting up replication (https://docs.aws.amazon.com/AmazonS3/latest/userguide/outposts-replication-how-setup.html)
	// in the Amazon S3 User Guide.
	//
	// This member is required.
	Role *string

	// A container for one or more replication rules. A replication configuration must
	// have at least one rule and can contain an array of 100 rules at the most.
	//
	// This member is required.
	Rules []ReplicationRule
	// contains filtered or unexported fields
}

A container for one or more replication rules. A replication configuration must have at least one rule and you can add up to 100 rules. The maximum size of a replication configuration is 128 KB.

type ReplicationRule added in v1.30.0 

type ReplicationRule struct {

	// The Amazon Resource Name (ARN) of the access point for the source Outposts
	// bucket that you want S3 on Outposts to replicate the objects from.
	//
	// This member is required.
	Bucket *string

	// A container for information about the replication destination and its
	// configurations.
	//
	// This member is required.
	Destination *Destination

	// Specifies whether the rule is enabled.
	//
	// This member is required.
	Status ReplicationRuleStatus

	// Specifies whether S3 on Outposts replicates delete markers. If you specify a
	// Filter element in your replication configuration, you must also include a
	// DeleteMarkerReplication element. If your Filter includes a Tag element, the
	// DeleteMarkerReplication element's Status child element must be set to Disabled ,
	// because S3 on Outposts doesn't support replicating delete markers for tag-based
	// rules. For more information about delete marker replication, see How delete
	// operations affect replication (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html#outposts-replication-what-is-replicated)
	// in the Amazon S3 User Guide.
	DeleteMarkerReplication *DeleteMarkerReplication

	// An optional configuration to replicate existing source bucket objects. This is
	// not supported by Amazon S3 on Outposts buckets.
	ExistingObjectReplication *ExistingObjectReplication

	// A filter that identifies the subset of objects to which the replication rule
	// applies. A Filter element must specify exactly one Prefix , Tag , or And child
	// element.
	Filter *ReplicationRuleFilter

	// A unique identifier for the rule. The maximum value is 255 characters.
	ID *string

	// An object key name prefix that identifies the object or objects to which the
	// rule applies. The maximum prefix length is 1,024 characters. To include all
	// objects in an Outposts bucket, specify an empty string. When you're using XML
	// requests, you must replace special characters (such as carriage returns) in
	// object keys with their equivalent XML entity codes. 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)
	// in the Amazon S3 User Guide.
	//
	// Deprecated: Prefix has been deprecated
	Prefix *string

	// The priority indicates which rule has precedence whenever two or more
	// replication rules conflict. S3 on Outposts attempts to replicate objects
	// according to all replication rules. However, if there are two or more rules with
	// the same destination Outposts bucket, then objects will be replicated according
	// to the rule with the highest priority. The higher the number, the higher the
	// priority. For more information, see Creating replication rules on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication-between-outposts.html)
	// in the Amazon S3 User Guide.
	Priority *int32

	// A container that describes additional filters for identifying the source
	// Outposts objects that you want to replicate. You can choose to enable or disable
	// the replication of these objects.
	SourceSelectionCriteria *SourceSelectionCriteria
	// contains filtered or unexported fields
}

Specifies which S3 on Outposts objects to replicate and where to store the replicas.

type ReplicationRuleAndOperator added in v1.30.0 

type ReplicationRuleAndOperator struct {

	// An object key name prefix that identifies the subset of objects that the rule
	// applies to.
	Prefix *string

	// An array of tags that contain key and value pairs.
	Tags []S3Tag
	// contains filtered or unexported fields
}

A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example:

  • If you specify both a Prefix and a Tag filter, wrap these filters in an And element.
  • If you specify a filter based on multiple tags, wrap the Tag elements in an And element.

type ReplicationRuleFilter added in v1.30.0 

type ReplicationRuleFilter struct {

	// A container for specifying rule filters. The filters determine the subset of
	// objects that the rule applies to. This element is required only if you specify
	// more than one filter. For example:
	//   - If you specify both a Prefix and a Tag filter, wrap these filters in an And
	//   element.
	//   - If you specify a filter based on multiple tags, wrap the Tag elements in an
	//   And element.
	And *ReplicationRuleAndOperator

	// An object key name prefix that identifies the subset of objects that the rule
	// applies to. When you're using XML requests, you must replace special characters
	// (such as carriage returns) in object keys with their equivalent XML entity
	// codes. 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)
	// in the Amazon S3 User Guide.
	Prefix *string

	// A container for a key-value name pair.
	Tag *S3Tag
	// contains filtered or unexported fields
}

A filter that identifies the subset of objects to which the replication rule applies. A Filter element must specify exactly one Prefix , Tag , or And child element.

type ReplicationRuleStatus added in v1.30.0 

type ReplicationRuleStatus string
const (
	ReplicationRuleStatusEnabled  ReplicationRuleStatus = "Enabled"
	ReplicationRuleStatusDisabled ReplicationRuleStatus = "Disabled"
)

Enum values for ReplicationRuleStatus

func (ReplicationRuleStatus) Values added in v1.30.0 

func (ReplicationRuleStatus) Values() []ReplicationRuleStatus

Values returns all known values for ReplicationRuleStatus. 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 ReplicationStatus added in v1.19.0 

type ReplicationStatus string
const (
	ReplicationStatusCompleted ReplicationStatus = "COMPLETED"
	ReplicationStatusFailed    ReplicationStatus = "FAILED"
	ReplicationStatusReplica   ReplicationStatus = "REPLICA"
	ReplicationStatusNone      ReplicationStatus = "NONE"
)

Enum values for ReplicationStatus

func (ReplicationStatus) Values added in v1.19.0 

func (ReplicationStatus) Values() []ReplicationStatus

Values returns all known values for ReplicationStatus. 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 ReplicationStorageClass added in v1.30.0 

type ReplicationStorageClass string
const (
	ReplicationStorageClassStandard           ReplicationStorageClass = "STANDARD"
	ReplicationStorageClassReducedRedundancy  ReplicationStorageClass = "REDUCED_REDUNDANCY"
	ReplicationStorageClassStandardIa         ReplicationStorageClass = "STANDARD_IA"
	ReplicationStorageClassOnezoneIa          ReplicationStorageClass = "ONEZONE_IA"
	ReplicationStorageClassIntelligentTiering ReplicationStorageClass = "INTELLIGENT_TIERING"
	ReplicationStorageClassGlacier            ReplicationStorageClass = "GLACIER"
	ReplicationStorageClassDeepArchive        ReplicationStorageClass = "DEEP_ARCHIVE"
	ReplicationStorageClassOutposts           ReplicationStorageClass = "OUTPOSTS"
	ReplicationStorageClassGlacierIr          ReplicationStorageClass = "GLACIER_IR"
)

Enum values for ReplicationStorageClass

func (ReplicationStorageClass) Values added in v1.30.0 

func (ReplicationStorageClass) Values() []ReplicationStorageClass

Values returns all known values for ReplicationStorageClass. 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 ReplicationTime added in v1.30.0 

type ReplicationTime struct {

	// Specifies whether S3 Replication Time Control (S3 RTC) is enabled.
	//
	// This member is required.
	Status ReplicationTimeStatus

	// A container that specifies the time by which replication should be complete for
	// all objects and operations on objects.
	//
	// This member is required.
	Time *ReplicationTimeValue
	// contains filtered or unexported fields
}

A container that specifies S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. This is not supported by Amazon S3 on Outposts buckets.

type ReplicationTimeStatus added in v1.30.0 

type ReplicationTimeStatus string
const (
	ReplicationTimeStatusEnabled  ReplicationTimeStatus = "Enabled"
	ReplicationTimeStatusDisabled ReplicationTimeStatus = "Disabled"
)

Enum values for ReplicationTimeStatus

func (ReplicationTimeStatus) Values added in v1.30.0 

func (ReplicationTimeStatus) Values() []ReplicationTimeStatus

Values returns all known values for ReplicationTimeStatus. 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 ReplicationTimeValue added in v1.30.0 

type ReplicationTimeValue struct {

	// Contains an integer that specifies the time period in minutes. Valid value: 15
	Minutes *int32
	// contains filtered or unexported fields
}

A container that specifies the time value for S3 Replication Time Control (S3 RTC). This value is also used for the replication metrics EventThreshold element. This is not supported by Amazon S3 on Outposts buckets.

type RequestedJobStatus 

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

Enum values for RequestedJobStatus

func (RequestedJobStatus) Values added in v0.29.0 

func (RequestedJobStatus) Values() []RequestedJobStatus

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 

func (S3CannedAccessControlList) Values() []S3CannedAccessControlList

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 S3ChecksumAlgorithm added in v1.20.0 

type S3ChecksumAlgorithm string
const (
	S3ChecksumAlgorithmCrc32  S3ChecksumAlgorithm = "CRC32"
	S3ChecksumAlgorithmCrc32c S3ChecksumAlgorithm = "CRC32C"
	S3ChecksumAlgorithmSha1   S3ChecksumAlgorithm = "SHA1"
	S3ChecksumAlgorithmSha256 S3ChecksumAlgorithm = "SHA256"
)

Enum values for S3ChecksumAlgorithm

func (S3ChecksumAlgorithm) Values added in v1.20.0 

func (S3ChecksumAlgorithm) Values() []S3ChecksumAlgorithm

Values returns all known values for S3ChecksumAlgorithm. 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 {

	// This functionality is not supported by directory buckets.
	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. This functionality is not
	// supported by directory buckets.
	BucketKeyEnabled bool

	// This functionality is not supported by directory buckets.
	CannedAccessControlList S3CannedAccessControlList

	// Indicates the algorithm that you want Amazon S3 to use to create the checksum.
	// For more information, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
	// in the Amazon S3 User Guide.
	ChecksumAlgorithm S3ChecksumAlgorithm

	//
	MetadataDirective S3MetadataDirective

	//
	ModifiedSinceConstraint *time.Time

	// If you don't provide this parameter, Amazon S3 copies all the metadata from the
	// original objects. If you specify an empty set, the new objects will have no
	// tags. Otherwise, Amazon S3 assigns the supplied tags to the new objects.
	NewObjectMetadata *S3ObjectMetadata

	// Specifies a list of tags to add to the destination objects after they are
	// copied. If NewObjectTagging is not specified, the tags of the source objects
	// are copied to destination objects by default. Directory buckets - Tags aren't
	// supported by directory buckets. If your source objects have tags and your
	// destination bucket is a directory bucket, specify an empty tag set in the
	// NewObjectTagging field to prevent copying the source object tags to the
	// directory bucket.
	NewObjectTagging []S3Tag

	// The legal hold status to be applied to all objects in the Batch Operations job.
	// This functionality is not supported by directory buckets.
	ObjectLockLegalHoldStatus S3ObjectLockLegalHoldStatus

	// The retention mode to be applied to all objects in the Batch Operations job.
	// This functionality is not supported by directory buckets.
	ObjectLockMode S3ObjectLockMode

	// The date when the applied object retention configuration expires on all objects
	// in the Batch Operations job. This functionality is not supported by directory
	// buckets.
	ObjectLockRetainUntilDate *time.Time

	// If the destination bucket is configured as a website, specifies an optional
	// metadata property for website redirects, x-amz-website-redirect-location .
	// Allows webpage redirects if the object copy is accessed through a website
	// endpoint. This functionality is not supported by directory buckets.
	RedirectLocation *string

	// This functionality is not supported by directory buckets.
	RequesterPays bool

	// This functionality is not supported by directory buckets.
	SSEAwsKmsKeyId *string

	// Specify the storage class for the destination objects in a Copy operation.
	// Directory buckets - This functionality is not supported by directory buckets.
	StorageClass S3StorageClass

	// Specifies the folder prefix that you want the objects to be copied into. For
	// example, to copy objects into a folder named Folder1 in the destination bucket,
	// set the TargetKeyPrefix property to Folder1 .
	TargetKeyPrefix *string

	// Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy
	// operation.
	//   - General purpose buckets - For example, to copy objects to a general purpose
	//   bucket named destinationBucket , set the TargetResource property to
	//   arn:aws:s3:::destinationBucket .
	//   - Directory buckets - For example, to copy objects to a directory bucket
	//   named destinationBucket in the Availability Zone; identified by the AZ ID
	//   usw2-az1 , set the TargetResource property to
	//   arn:aws:s3express:region:account_id:/bucket/destination_bucket_base_name--usw2-az1--x-s3
	//   .
	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 CopyObject API operation. For more information about the parameters for this operation, see CopyObject (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 ( DeleteObjectTagging ) API operation accepts only the bucket name and key name as parameters, which are defined in the job's manifest.

type S3GeneratedManifestDescriptor added in v1.19.0 

type S3GeneratedManifestDescriptor struct {

	// The format of the generated manifest.
	Format GeneratedManifestFormat

	// Contains the information required to locate a manifest object. Manifests can't
	// be imported from directory buckets. For more information, see Directory buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html)
	// .
	Location *JobManifestLocation
	// contains filtered or unexported fields
}

Describes the specified job's generated manifest. Batch Operations jobs created with a ManifestGenerator populate details of this descriptor after execution of the ManifestGenerator.

type S3GlacierJobTier 

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

Enum values for S3GlacierJobTier

func (S3GlacierJobTier) Values added in v0.29.0 

func (S3GlacierJobTier) Values() []S3GlacierJobTier

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 

func (S3GranteeTypeIdentifier) Values() []S3GranteeTypeIdentifier

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 a POST Object restore job. S3 Batch Operations passes every object to the underlying RestoreObject API operation. 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 S3JobManifestGenerator added in v1.19.0 

type S3JobManifestGenerator struct {

	// Determines whether or not to write the job's generated manifest to a bucket.
	//
	// This member is required.
	EnableManifestOutput bool

	// The source bucket used by the ManifestGenerator. Directory buckets - Directory
	// buckets aren't supported as the source buckets used by S3JobManifestGenerator
	// to generate the job manifest.
	//
	// This member is required.
	SourceBucket *string

	// The Amazon Web Services account ID that owns the bucket the generated manifest
	// is written to. If provided the generated manifest bucket's owner Amazon Web
	// Services account ID must match this value, else the job fails.
	ExpectedBucketOwner *string

	// Specifies rules the S3JobManifestGenerator should use to decide whether an
	// object in the source bucket should or should not be included in the generated
	// job manifest.
	Filter *JobManifestGeneratorFilter

	// Specifies the location the generated manifest will be written to. Manifests
	// can't be written to directory buckets. For more information, see Directory
	// buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html)
	// .
	ManifestOutputLocation *S3ManifestOutputLocation
	// contains filtered or unexported fields
}

The container for the service that will create the S3 manifest.

type S3ManifestOutputLocation added in v1.19.0 

type S3ManifestOutputLocation struct {

	// The bucket ARN the generated manifest should be written to. Directory buckets -
	// Directory buckets aren't supported as the buckets to store the generated
	// manifest.
	//
	// This member is required.
	Bucket *string

	// The format of the generated manifest.
	//
	// This member is required.
	ManifestFormat GeneratedManifestFormat

	// The Account ID that owns the bucket the generated manifest is written to.
	ExpectedManifestBucketOwner *string

	// Specifies what encryption should be used when the generated manifest objects
	// are written.
	ManifestEncryption *GeneratedManifestEncryption

	// Prefix identifying one or more objects to which the manifest applies.
	ManifestPrefix *string
	// contains filtered or unexported fields
}

Location details for where the generated manifest should be written.

type S3MetadataDirective 

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

Enum values for S3MetadataDirective

func (S3MetadataDirective) Values added in v0.29.0 

func (S3MetadataDirective) Values() []S3MetadataDirective

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 

func (S3ObjectLockLegalHoldStatus) Values() []S3ObjectLockLegalHoldStatus

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 

func (S3ObjectLockMode) Values() []S3ObjectLockMode

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 

func (S3ObjectLockRetentionMode) Values() []S3ObjectLockRetentionMode

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

	// This member has been deprecated.
	ContentLength *int64

	// This member has been deprecated.
	ContentMD5 *string

	//
	ContentType *string

	//
	HttpExpiresDate *time.Time

	// This member has been deprecated.
	RequesterCharged bool

	// For directory buckets, only the server-side encryption with Amazon S3 managed
	// keys (SSE-S3) ( AES256 ) is supported.
	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 S3PrefixType added in v1.39.0 

type S3PrefixType string
const (
	S3PrefixTypeObject S3PrefixType = "Object"
)

Enum values for S3PrefixType

func (S3PrefixType) Values added in v1.39.0 

func (S3PrefixType) Values() []S3PrefixType

Values returns all known values for S3PrefixType. 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 S3ReplicateObjectOperation added in v1.19.0 

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

Directs the specified job to invoke ReplicateObject on every object in the job's manifest.

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 PUT Object ACL operation. S3 Batch Operations passes every object to the underlying PutObjectAcl API operation. For more information about the parameters for this operation, see PutObjectAcl (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 to every object to the underlying PutObjectLegalHold API operation. 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. This functionality is not supported by directory buckets.

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 operation. 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 functionality is not supported by directory buckets.

type S3SetObjectTaggingOperation 

type S3SetObjectTaggingOperation struct {

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

Contains the configuration parameters for a PUT Object Tagging operation. S3 Batch Operations passes every object to the underlying PutObjectTagging API operation. For more information about the parameters for this operation, see PutObjectTagging (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"
	S3StorageClassGlacierIr          S3StorageClass = "GLACIER_IR"
)

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 {

	// Key of the tag
	//
	// This member is required.
	Key *string

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

A container for a key-value name pair.

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 SSEKMSEncryption added in v1.19.0 

type SSEKMSEncryption struct {

	// Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web
	// Services KMS) symmetric encryption customer managed key to use for encrypting
	// generated manifest objects.
	//
	// This member is required.
	KeyId *string
	// contains filtered or unexported fields
}

Configuration for the use of SSE-KMS to encrypt generated manifest objects.

type SSES3 added in v0.30.0 

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

type SSES3Encryption added in v1.19.0 

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

Configuration for the use of SSE-S3 to encrypt generated manifest objects.

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 SourceSelectionCriteria added in v1.30.0 

type SourceSelectionCriteria struct {

	// A filter that you can use to specify whether replica modification sync is
	// enabled. S3 on Outposts replica modification sync can help you keep object
	// metadata synchronized between replicas and source objects. By default, S3 on
	// Outposts replicates metadata from the source objects to the replicas only. When
	// replica modification sync is enabled, S3 on Outposts replicates metadata changes
	// made to the replica copies back to the source object, making the replication
	// bidirectional. To replicate object metadata modifications on replicas, you can
	// specify this element and set the Status of this element to Enabled . You must
	// enable replica modification sync on the source and destination buckets to
	// replicate replica metadata changes between the source and the replicas.
	ReplicaModifications *ReplicaModifications

	// A filter that you can use to select Amazon S3 objects that are encrypted with
	// server-side encryption by using Key Management Service (KMS) keys. If you
	// include SourceSelectionCriteria in the replication configuration, this element
	// is required. This is not supported by Amazon S3 on Outposts buckets.
	SseKmsEncryptedObjects *SseKmsEncryptedObjects
	// contains filtered or unexported fields
}

A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects.

type SseKmsEncryptedObjects added in v1.30.0 

type SseKmsEncryptedObjects struct {

	// Specifies whether Amazon S3 replicates objects that are created with
	// server-side encryption by using an KMS key stored in Key Management Service.
	//
	// This member is required.
	Status SseKmsEncryptedObjectsStatus
	// contains filtered or unexported fields
}

A container for filter information that you can use to select S3 objects that are encrypted with Key Management Service (KMS). This is not supported by Amazon S3 on Outposts buckets.

type SseKmsEncryptedObjectsStatus added in v1.30.0 

type SseKmsEncryptedObjectsStatus string
const (
	SseKmsEncryptedObjectsStatusEnabled  SseKmsEncryptedObjectsStatus = "Enabled"
	SseKmsEncryptedObjectsStatusDisabled SseKmsEncryptedObjectsStatus = "Disabled"
)

Enum values for SseKmsEncryptedObjectsStatus

func (SseKmsEncryptedObjectsStatus) Values added in v1.30.0 

func (SseKmsEncryptedObjectsStatus) Values() []SseKmsEncryptedObjectsStatus

Values returns all known values for SseKmsEncryptedObjectsStatus. 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 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 enabling Amazon CloudWatch publishing for S3 Storage Lens
	// metrics.
	CloudWatchMetrics *CloudWatchMetrics

	// 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.
	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 StorageLensGroup added in v1.37.0 

type StorageLensGroup struct {

	// Sets the criteria for the Storage Lens group data that is displayed. For
	// multiple filter conditions, the AND or OR logical operator is used.
	//
	// This member is required.
	Filter *StorageLensGroupFilter

	// Contains the name of the Storage Lens group.
	//
	// This member is required.
	Name *string

	// Contains the Amazon Resource Name (ARN) of the Storage Lens group. This
	// property is read-only.
	StorageLensGroupArn *string
	// contains filtered or unexported fields
}

A custom grouping of objects that include filters for prefixes, suffixes, object tags, object size, or object age. You can create an S3 Storage Lens group that includes a single filter or multiple filter conditions. To specify multiple filter conditions, you use AND or OR logical operators.

type StorageLensGroupAndOperator added in v1.37.0 

type StorageLensGroupAndOperator struct {

	// Contains a list of prefixes. At least one prefix must be specified. Up to 10
	// prefixes are allowed.
	MatchAnyPrefix []string

	// Contains a list of suffixes. At least one suffix must be specified. Up to 10
	// suffixes are allowed.
	MatchAnySuffix []string

	// Contains the list of object tags. At least one object tag must be specified. Up
	// to 10 object tags are allowed.
	MatchAnyTag []S3Tag

	// Contains DaysGreaterThan and DaysLessThan to define the object age range
	// (minimum and maximum number of days).
	MatchObjectAge *MatchObjectAge

	// Contains BytesGreaterThan and BytesLessThan to define the object size range
	// (minimum and maximum number of Bytes).
	MatchObjectSize *MatchObjectSize
	// contains filtered or unexported fields
}

A logical operator that allows multiple filter conditions to be joined for more complex comparisons of Storage Lens group data.

type StorageLensGroupFilter added in v1.37.0 

type StorageLensGroupFilter struct {

	// A logical operator that allows multiple filter conditions to be joined for more
	// complex comparisons of Storage Lens group data. Objects must match all of the
	// listed filter conditions that are joined by the And logical operator. Only one
	// of each filter condition is allowed.
	And *StorageLensGroupAndOperator

	// Contains a list of prefixes. At least one prefix must be specified. Up to 10
	// prefixes are allowed.
	MatchAnyPrefix []string

	// Contains a list of suffixes. At least one suffix must be specified. Up to 10
	// suffixes are allowed.
	MatchAnySuffix []string

	// Contains the list of S3 object tags. At least one object tag must be specified.
	// Up to 10 object tags are allowed.
	MatchAnyTag []S3Tag

	// Contains DaysGreaterThan and DaysLessThan to define the object age range
	// (minimum and maximum number of days).
	MatchObjectAge *MatchObjectAge

	// Contains BytesGreaterThan and BytesLessThan to define the object size range
	// (minimum and maximum number of Bytes).
	MatchObjectSize *MatchObjectSize

	// A single logical operator that allows multiple filter conditions to be joined.
	// Objects can match any of the listed filter conditions, which are joined by the
	// Or logical operator. Only one of each filter condition is allowed.
	Or *StorageLensGroupOrOperator
	// contains filtered or unexported fields
}

The filter element sets the criteria for the Storage Lens group data that is displayed. For multiple filter conditions, the AND or OR logical operator is used.

type StorageLensGroupLevel added in v1.37.0 

type StorageLensGroupLevel struct {

	// Indicates which Storage Lens group ARNs to include or exclude in the Storage
	// Lens group aggregation. If this value is left null, then all Storage Lens groups
	// are selected.
	SelectionCriteria *StorageLensGroupLevelSelectionCriteria
	// contains filtered or unexported fields
}

Specifies the Storage Lens groups to include in the Storage Lens group aggregation.

type StorageLensGroupLevelSelectionCriteria added in v1.37.0 

type StorageLensGroupLevelSelectionCriteria struct {

	// Indicates which Storage Lens group ARNs to exclude from the Storage Lens group
	// aggregation.
	Exclude []string

	// Indicates which Storage Lens group ARNs to include in the Storage Lens group
	// aggregation.
	Include []string
	// contains filtered or unexported fields
}

Indicates which Storage Lens group ARNs to include or exclude in the Storage Lens group aggregation. You can only attach Storage Lens groups to your Storage Lens dashboard if they're included in your Storage Lens group aggregation. If this value is left null, then all Storage Lens groups are selected.

type StorageLensGroupOrOperator added in v1.37.0 

type StorageLensGroupOrOperator struct {

	// Filters objects that match any of the specified prefixes.
	MatchAnyPrefix []string

	// Filters objects that match any of the specified suffixes.
	MatchAnySuffix []string

	// Filters objects that match any of the specified S3 object tags.
	MatchAnyTag []S3Tag

	// Filters objects that match the specified object age range.
	MatchObjectAge *MatchObjectAge

	// Filters objects that match the specified object size range.
	MatchObjectSize *MatchObjectSize
	// contains filtered or unexported fields
}

A container element for specifying Or rule conditions. The rule conditions determine the subset of objects to which the Or rule applies. Objects can match any of the listed filter conditions, which are joined by the Or logical operator. Only one of each filter condition is allowed.

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 Tag added in v1.37.0 

type Tag struct {

	// The key of the key-value pair of a tag added to your Amazon Web Services
	// resource. A tag key can be up to 128 Unicode characters in length and is
	// case-sensitive. System created tags that begin with aws: aren’t supported.
	//
	// This member is required.
	Key *string

	// The value of the key-value pair of a tag added to your Amazon Web Services
	// resource. A tag value can be up to 256 Unicode characters in length and is
	// case-sensitive.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

An Amazon Web Services resource tag that's associated with your S3 resource. You can add tags to new objects when you upload them, or you can add object tags to existing objects. This operation is only supported for S3 Storage Lens groups (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-lens-groups.html) and for S3 Access Grants (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-grants-tagging.html) . The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.

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

	ErrorCodeOverride *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

	ErrorCodeOverride *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 

func (TransitionStorageClass) Values() []TransitionStorageClass

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 VersioningConfiguration added in v1.23.0 

type VersioningConfiguration struct {

	// Specifies whether MFA delete is enabled or disabled in the bucket versioning
	// configuration for the S3 on Outposts bucket.
	MFADelete MFADelete

	// Sets the versioning state of the S3 on Outposts bucket.
	Status BucketVersioningStatus
	// contains filtered or unexported fields
}

Describes the versioning state of an Amazon S3 on Outposts bucket. For more information, see PutBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketVersioning.html) .

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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.