s3control

package
v1.35.6 Latest Latest
Warning

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

 Go to latest Published: Oct 8, 2020 License: Apache-2.0 Imports: 19 Imported by: 67

Documentation

Overview

Package s3control provides the client and types for making API requests to AWS S3 Control.

AWS S3 Control provides access to Amazon S3 control plane operations.

See https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20 for more information on this service.

See s3control package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/s3control/

Using the Client

To contact AWS S3 Control with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS S3 Control client S3Control for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/s3control/#New

Index

Constants

View Source 
const (
	// BucketCannedACLPrivate is a BucketCannedACL enum value
	BucketCannedACLPrivate = "private"

	// BucketCannedACLPublicRead is a BucketCannedACL enum value
	BucketCannedACLPublicRead = "public-read"

	// BucketCannedACLPublicReadWrite is a BucketCannedACL enum value
	BucketCannedACLPublicReadWrite = "public-read-write"

	// BucketCannedACLAuthenticatedRead is a BucketCannedACL enum value
	BucketCannedACLAuthenticatedRead = "authenticated-read"
)
View Source 
const (
	// BucketLocationConstraintEu is a BucketLocationConstraint enum value
	BucketLocationConstraintEu = "EU"

	// BucketLocationConstraintEuWest1 is a BucketLocationConstraint enum value
	BucketLocationConstraintEuWest1 = "eu-west-1"

	// BucketLocationConstraintUsWest1 is a BucketLocationConstraint enum value
	BucketLocationConstraintUsWest1 = "us-west-1"

	// BucketLocationConstraintUsWest2 is a BucketLocationConstraint enum value
	BucketLocationConstraintUsWest2 = "us-west-2"

	// BucketLocationConstraintApSouth1 is a BucketLocationConstraint enum value
	BucketLocationConstraintApSouth1 = "ap-south-1"

	// BucketLocationConstraintApSoutheast1 is a BucketLocationConstraint enum value
	BucketLocationConstraintApSoutheast1 = "ap-southeast-1"

	// BucketLocationConstraintApSoutheast2 is a BucketLocationConstraint enum value
	BucketLocationConstraintApSoutheast2 = "ap-southeast-2"

	// BucketLocationConstraintApNortheast1 is a BucketLocationConstraint enum value
	BucketLocationConstraintApNortheast1 = "ap-northeast-1"

	// BucketLocationConstraintSaEast1 is a BucketLocationConstraint enum value
	BucketLocationConstraintSaEast1 = "sa-east-1"

	// BucketLocationConstraintCnNorth1 is a BucketLocationConstraint enum value
	BucketLocationConstraintCnNorth1 = "cn-north-1"

	// BucketLocationConstraintEuCentral1 is a BucketLocationConstraint enum value
	BucketLocationConstraintEuCentral1 = "eu-central-1"
)
View Source 
const (
	// ExpirationStatusEnabled is a ExpirationStatus enum value
	ExpirationStatusEnabled = "Enabled"

	// ExpirationStatusDisabled is a ExpirationStatus enum value
	ExpirationStatusDisabled = "Disabled"
)
View Source 
const (
	// JobManifestFieldNameIgnore is a JobManifestFieldName enum value
	JobManifestFieldNameIgnore = "Ignore"

	// JobManifestFieldNameBucket is a JobManifestFieldName enum value
	JobManifestFieldNameBucket = "Bucket"

	// JobManifestFieldNameKey is a JobManifestFieldName enum value
	JobManifestFieldNameKey = "Key"

	// JobManifestFieldNameVersionId is a JobManifestFieldName enum value
	JobManifestFieldNameVersionId = "VersionId"
)
View Source 
const (
	// JobManifestFormatS3batchOperationsCsv20180820 is a JobManifestFormat enum value
	JobManifestFormatS3batchOperationsCsv20180820 = "S3BatchOperations_CSV_20180820"

	// JobManifestFormatS3inventoryReportCsv20161130 is a JobManifestFormat enum value
	JobManifestFormatS3inventoryReportCsv20161130 = "S3InventoryReport_CSV_20161130"
)
View Source 
const (
	// JobReportScopeAllTasks is a JobReportScope enum value
	JobReportScopeAllTasks = "AllTasks"

	// JobReportScopeFailedTasksOnly is a JobReportScope enum value
	JobReportScopeFailedTasksOnly = "FailedTasksOnly"
)
View Source 
const (
	// JobStatusActive is a JobStatus enum value
	JobStatusActive = "Active"

	// JobStatusCancelled is a JobStatus enum value
	JobStatusCancelled = "Cancelled"

	// JobStatusCancelling is a JobStatus enum value
	JobStatusCancelling = "Cancelling"

	// JobStatusComplete is a JobStatus enum value
	JobStatusComplete = "Complete"

	// JobStatusCompleting is a JobStatus enum value
	JobStatusCompleting = "Completing"

	// JobStatusFailed is a JobStatus enum value
	JobStatusFailed = "Failed"

	// JobStatusFailing is a JobStatus enum value
	JobStatusFailing = "Failing"

	// JobStatusNew is a JobStatus enum value
	JobStatusNew = "New"

	// JobStatusPaused is a JobStatus enum value
	JobStatusPaused = "Paused"

	// JobStatusPausing is a JobStatus enum value
	JobStatusPausing = "Pausing"

	// JobStatusPreparing is a JobStatus enum value
	JobStatusPreparing = "Preparing"

	// JobStatusReady is a JobStatus enum value
	JobStatusReady = "Ready"

	// JobStatusSuspended is a JobStatus enum value
	JobStatusSuspended = "Suspended"
)
View Source 
const (
	// NetworkOriginInternet is a NetworkOrigin enum value
	NetworkOriginInternet = "Internet"

	// NetworkOriginVpc is a NetworkOrigin enum value
	NetworkOriginVpc = "VPC"
)
View Source 
const (
	// OperationNameLambdaInvoke is a OperationName enum value
	OperationNameLambdaInvoke = "LambdaInvoke"

	// OperationNameS3putObjectCopy is a OperationName enum value
	OperationNameS3putObjectCopy = "S3PutObjectCopy"

	// OperationNameS3putObjectAcl is a OperationName enum value
	OperationNameS3putObjectAcl = "S3PutObjectAcl"

	// OperationNameS3putObjectTagging is a OperationName enum value
	OperationNameS3putObjectTagging = "S3PutObjectTagging"

	// OperationNameS3initiateRestoreObject is a OperationName enum value
	OperationNameS3initiateRestoreObject = "S3InitiateRestoreObject"

	// OperationNameS3putObjectLegalHold is a OperationName enum value
	OperationNameS3putObjectLegalHold = "S3PutObjectLegalHold"

	// OperationNameS3putObjectRetention is a OperationName enum value
	OperationNameS3putObjectRetention = "S3PutObjectRetention"
)
View Source 
const (
	// RequestedJobStatusCancelled is a RequestedJobStatus enum value
	RequestedJobStatusCancelled = "Cancelled"

	// RequestedJobStatusReady is a RequestedJobStatus enum value
	RequestedJobStatusReady = "Ready"
)
View Source 
const (
	// S3CannedAccessControlListPrivate is a S3CannedAccessControlList enum value
	S3CannedAccessControlListPrivate = "private"

	// S3CannedAccessControlListPublicRead is a S3CannedAccessControlList enum value
	S3CannedAccessControlListPublicRead = "public-read"

	// S3CannedAccessControlListPublicReadWrite is a S3CannedAccessControlList enum value
	S3CannedAccessControlListPublicReadWrite = "public-read-write"

	// S3CannedAccessControlListAwsExecRead is a S3CannedAccessControlList enum value
	S3CannedAccessControlListAwsExecRead = "aws-exec-read"

	// S3CannedAccessControlListAuthenticatedRead is a S3CannedAccessControlList enum value
	S3CannedAccessControlListAuthenticatedRead = "authenticated-read"

	// S3CannedAccessControlListBucketOwnerRead is a S3CannedAccessControlList enum value
	S3CannedAccessControlListBucketOwnerRead = "bucket-owner-read"

	// S3CannedAccessControlListBucketOwnerFullControl is a S3CannedAccessControlList enum value
	S3CannedAccessControlListBucketOwnerFullControl = "bucket-owner-full-control"
)
View Source 
const (
	// S3GlacierJobTierBulk is a S3GlacierJobTier enum value
	S3GlacierJobTierBulk = "BULK"

	// S3GlacierJobTierStandard is a S3GlacierJobTier enum value
	S3GlacierJobTierStandard = "STANDARD"
)
View Source 
const (
	// S3GranteeTypeIdentifierId is a S3GranteeTypeIdentifier enum value
	S3GranteeTypeIdentifierId = "id"

	// S3GranteeTypeIdentifierEmailAddress is a S3GranteeTypeIdentifier enum value
	S3GranteeTypeIdentifierEmailAddress = "emailAddress"

	// S3GranteeTypeIdentifierUri is a S3GranteeTypeIdentifier enum value
	S3GranteeTypeIdentifierUri = "uri"
)
View Source 
const (
	// S3MetadataDirectiveCopy is a S3MetadataDirective enum value
	S3MetadataDirectiveCopy = "COPY"

	// S3MetadataDirectiveReplace is a S3MetadataDirective enum value
	S3MetadataDirectiveReplace = "REPLACE"
)
View Source 
const (
	// S3ObjectLockLegalHoldStatusOff is a S3ObjectLockLegalHoldStatus enum value
	S3ObjectLockLegalHoldStatusOff = "OFF"

	// S3ObjectLockLegalHoldStatusOn is a S3ObjectLockLegalHoldStatus enum value
	S3ObjectLockLegalHoldStatusOn = "ON"
)
View Source 
const (
	// S3ObjectLockModeCompliance is a S3ObjectLockMode enum value
	S3ObjectLockModeCompliance = "COMPLIANCE"

	// S3ObjectLockModeGovernance is a S3ObjectLockMode enum value
	S3ObjectLockModeGovernance = "GOVERNANCE"
)
View Source 
const (
	// S3ObjectLockRetentionModeCompliance is a S3ObjectLockRetentionMode enum value
	S3ObjectLockRetentionModeCompliance = "COMPLIANCE"

	// S3ObjectLockRetentionModeGovernance is a S3ObjectLockRetentionMode enum value
	S3ObjectLockRetentionModeGovernance = "GOVERNANCE"
)
View Source 
const (
	// S3PermissionFullControl is a S3Permission enum value
	S3PermissionFullControl = "FULL_CONTROL"

	// S3PermissionRead is a S3Permission enum value
	S3PermissionRead = "READ"

	// S3PermissionWrite is a S3Permission enum value
	S3PermissionWrite = "WRITE"

	// S3PermissionReadAcp is a S3Permission enum value
	S3PermissionReadAcp = "READ_ACP"

	// S3PermissionWriteAcp is a S3Permission enum value
	S3PermissionWriteAcp = "WRITE_ACP"
)
View Source 
const (
	// S3SSEAlgorithmAes256 is a S3SSEAlgorithm enum value
	S3SSEAlgorithmAes256 = "AES256"

	// S3SSEAlgorithmKms is a S3SSEAlgorithm enum value
	S3SSEAlgorithmKms = "KMS"
)
View Source 
const (
	// S3StorageClassStandard is a S3StorageClass enum value
	S3StorageClassStandard = "STANDARD"

	// S3StorageClassStandardIa is a S3StorageClass enum value
	S3StorageClassStandardIa = "STANDARD_IA"

	// S3StorageClassOnezoneIa is a S3StorageClass enum value
	S3StorageClassOnezoneIa = "ONEZONE_IA"

	// S3StorageClassGlacier is a S3StorageClass enum value
	S3StorageClassGlacier = "GLACIER"

	// S3StorageClassIntelligentTiering is a S3StorageClass enum value
	S3StorageClassIntelligentTiering = "INTELLIGENT_TIERING"

	// S3StorageClassDeepArchive is a S3StorageClass enum value
	S3StorageClassDeepArchive = "DEEP_ARCHIVE"
)
View Source 
const (
	// TransitionStorageClassGlacier is a TransitionStorageClass enum value
	TransitionStorageClassGlacier = "GLACIER"

	// TransitionStorageClassStandardIa is a TransitionStorageClass enum value
	TransitionStorageClassStandardIa = "STANDARD_IA"

	// TransitionStorageClassOnezoneIa is a TransitionStorageClass enum value
	TransitionStorageClassOnezoneIa = "ONEZONE_IA"

	// TransitionStorageClassIntelligentTiering is a TransitionStorageClass enum value
	TransitionStorageClassIntelligentTiering = "INTELLIGENT_TIERING"

	// TransitionStorageClassDeepArchive is a TransitionStorageClass enum value
	TransitionStorageClassDeepArchive = "DEEP_ARCHIVE"
)
View Source 
const (

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeBucketAlreadyExists for service response error code
	// "BucketAlreadyExists".
	//
	// The requested Outposts bucket name is not available. The bucket namespace
	// is shared by all users of the AWS Outposts in this Region. Select a different
	// name and try again.
	ErrCodeBucketAlreadyExists = "BucketAlreadyExists"

	// ErrCodeBucketAlreadyOwnedByYou for service response error code
	// "BucketAlreadyOwnedByYou".
	//
	// The Outposts bucket you tried to create already exists, and you own it.
	ErrCodeBucketAlreadyOwnedByYou = "BucketAlreadyOwnedByYou"

	// ErrCodeIdempotencyException for service response error code
	// "IdempotencyException".
	ErrCodeIdempotencyException = "IdempotencyException"

	// ErrCodeInternalServiceException for service response error code
	// "InternalServiceException".
	ErrCodeInternalServiceException = "InternalServiceException"

	// ErrCodeInvalidNextTokenException for service response error code
	// "InvalidNextTokenException".
	ErrCodeInvalidNextTokenException = "InvalidNextTokenException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeJobStatusException for service response error code
	// "JobStatusException".
	ErrCodeJobStatusException = "JobStatusException"

	// ErrCodeNoSuchPublicAccessBlockConfiguration for service response error code
	// "NoSuchPublicAccessBlockConfiguration".
	//
	// Amazon S3 throws this exception if you make a GetPublicAccessBlock request
	// against an account that doesn't have a PublicAccessBlockConfiguration set.
	ErrCodeNoSuchPublicAccessBlockConfiguration = "NoSuchPublicAccessBlockConfiguration"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	ErrCodeTooManyRequestsException = "TooManyRequestsException"

	// ErrCodeTooManyTagsException for service response error code
	// "TooManyTagsException".
	//
	// Amazon S3 throws this exception if you have too many tags in your tag set.
	ErrCodeTooManyTagsException = "TooManyTagsException"
)
View Source 
const (
	ServiceName = "S3 Control" // Name of service.
	EndpointsID = "s3-control" // ID to lookup a service endpoint with.
	ServiceID   = "S3 Control" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// JobReportFormatReportCsv20180820 is a JobReportFormat enum value
	JobReportFormatReportCsv20180820 = "Report_CSV_20180820"
)

Variables

This section is empty.

Functions

func BucketCannedACL_Values added in v1.35.0 

func BucketCannedACL_Values() []string

BucketCannedACL_Values returns all elements of the BucketCannedACL enum

func BucketLocationConstraint_Values added in v1.35.0 

func BucketLocationConstraint_Values() []string

BucketLocationConstraint_Values returns all elements of the BucketLocationConstraint enum

func ExpirationStatus_Values added in v1.35.0 

func ExpirationStatus_Values() []string

ExpirationStatus_Values returns all elements of the ExpirationStatus enum

func JobManifestFieldName_Values added in v1.34.3 

func JobManifestFieldName_Values() []string

JobManifestFieldName_Values returns all elements of the JobManifestFieldName enum

func JobManifestFormat_Values added in v1.34.3 

func JobManifestFormat_Values() []string

JobManifestFormat_Values returns all elements of the JobManifestFormat enum

func JobReportFormat_Values added in v1.34.3 

func JobReportFormat_Values() []string

JobReportFormat_Values returns all elements of the JobReportFormat enum

func JobReportScope_Values added in v1.34.3 

func JobReportScope_Values() []string

JobReportScope_Values returns all elements of the JobReportScope enum

func JobStatus_Values added in v1.34.3 

func JobStatus_Values() []string

JobStatus_Values returns all elements of the JobStatus enum

func NetworkOrigin_Values added in v1.34.3 

func NetworkOrigin_Values() []string

NetworkOrigin_Values returns all elements of the NetworkOrigin enum

func OperationName_Values added in v1.34.3 

func OperationName_Values() []string

OperationName_Values returns all elements of the OperationName enum

func RequestedJobStatus_Values added in v1.34.3 

func RequestedJobStatus_Values() []string

RequestedJobStatus_Values returns all elements of the RequestedJobStatus enum

func S3CannedAccessControlList_Values added in v1.34.3 

func S3CannedAccessControlList_Values() []string

S3CannedAccessControlList_Values returns all elements of the S3CannedAccessControlList enum

func S3GlacierJobTier_Values added in v1.34.3 

func S3GlacierJobTier_Values() []string

S3GlacierJobTier_Values returns all elements of the S3GlacierJobTier enum

func S3GranteeTypeIdentifier_Values added in v1.34.3 

func S3GranteeTypeIdentifier_Values() []string

S3GranteeTypeIdentifier_Values returns all elements of the S3GranteeTypeIdentifier enum

func S3MetadataDirective_Values added in v1.34.3 

func S3MetadataDirective_Values() []string

S3MetadataDirective_Values returns all elements of the S3MetadataDirective enum

func S3ObjectLockLegalHoldStatus_Values added in v1.34.3 

func S3ObjectLockLegalHoldStatus_Values() []string

S3ObjectLockLegalHoldStatus_Values returns all elements of the S3ObjectLockLegalHoldStatus enum

func S3ObjectLockMode_Values added in v1.34.3 

func S3ObjectLockMode_Values() []string

S3ObjectLockMode_Values returns all elements of the S3ObjectLockMode enum

func S3ObjectLockRetentionMode_Values added in v1.34.3 

func S3ObjectLockRetentionMode_Values() []string

S3ObjectLockRetentionMode_Values returns all elements of the S3ObjectLockRetentionMode enum

func S3Permission_Values added in v1.34.3 

func S3Permission_Values() []string

S3Permission_Values returns all elements of the S3Permission enum

func S3SSEAlgorithm_Values added in v1.34.3 

func S3SSEAlgorithm_Values() []string

S3SSEAlgorithm_Values returns all elements of the S3SSEAlgorithm enum

func S3StorageClass_Values added in v1.34.3 

func S3StorageClass_Values() []string

S3StorageClass_Values returns all elements of the S3StorageClass enum

func TransitionStorageClass_Values added in v1.35.0 

func TransitionStorageClass_Values() []string

TransitionStorageClass_Values returns all elements of the TransitionStorageClass enum

Types

type AbortIncompleteMultipartUpload added in v1.35.0 

type AbortIncompleteMultipartUpload struct {

	// Specifies the number of days after which Amazon S3 aborts an incomplete multipart
	// upload to the Outposts bucket.
	DaysAfterInitiation *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The container for abort incomplete multipart upload

func (AbortIncompleteMultipartUpload) GoString added in v1.35.0 

func (s AbortIncompleteMultipartUpload) GoString() string

GoString returns the string representation

func (*AbortIncompleteMultipartUpload) SetDaysAfterInitiation added in v1.35.0 

func (s *AbortIncompleteMultipartUpload) SetDaysAfterInitiation(v int64) *AbortIncompleteMultipartUpload

SetDaysAfterInitiation sets the DaysAfterInitiation field's value.

func (AbortIncompleteMultipartUpload) String added in v1.35.0 

func (s AbortIncompleteMultipartUpload) String() string

String returns the string representation

type AccessPoint added in v1.25.46 

type AccessPoint struct {

	// The ARN for the access point.
	AccessPointArn *string `min:"4" type:"string"`

	// The name of the bucket associated with this access point.
	//
	// Bucket is a required field
	Bucket *string `min:"3" type:"string" required:"true"`

	// The name of this access point.
	//
	// Name is a required field
	Name *string `min:"3" type:"string" required:"true"`

	// 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.
	//
	// NetworkOrigin is a required field
	NetworkOrigin *string `type:"string" required:"true" enum:"NetworkOrigin"`

	// The virtual private cloud (VPC) configuration for this access point, if one
	// exists.
	VpcConfiguration *VpcConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

An access point used to access a bucket.

func (AccessPoint) GoString added in v1.25.46 

func (s AccessPoint) GoString() string

GoString returns the string representation

func (*AccessPoint) SetAccessPointArn added in v1.35.0 

func (s *AccessPoint) SetAccessPointArn(v string) *AccessPoint

SetAccessPointArn sets the AccessPointArn field's value.

func (*AccessPoint) SetBucket added in v1.25.46 

func (s *AccessPoint) SetBucket(v string) *AccessPoint

SetBucket sets the Bucket field's value.

func (*AccessPoint) SetName added in v1.25.46 

func (s *AccessPoint) SetName(v string) *AccessPoint

SetName sets the Name field's value.

func (*AccessPoint) SetNetworkOrigin added in v1.25.46 

func (s *AccessPoint) SetNetworkOrigin(v string) *AccessPoint

SetNetworkOrigin sets the NetworkOrigin field's value.

func (*AccessPoint) SetVpcConfiguration added in v1.25.46 

func (s *AccessPoint) SetVpcConfiguration(v *VpcConfiguration) *AccessPoint

SetVpcConfiguration sets the VpcConfiguration field's value.

func (AccessPoint) String added in v1.25.46 

func (s AccessPoint) String() string

String returns the string representation

type CreateAccessPointInput added in v1.25.46 

type CreateAccessPointInput struct {

	// The AWS account ID for the owner of the bucket for which you want to create
	// an access point.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The name of the bucket that you want to associate this access point with.
	//
	// For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format
	// arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>.
	// For example, to access the bucket reports through outpost my-outpost owned
	// by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports.
	// The value must be URL encoded.
	//
	// Bucket is a required field
	Bucket *string `min:"3" type:"string" required:"true"`

	// The name you want to assign to this access point.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"name" min:"3" type:"string" required:"true"`

	// The PublicAccessBlock configuration that you want to apply to this Amazon
	// S3 bucket. 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 Simple Storage Service Developer Guide.
	//
	// This is not supported for Amazon S3 on Outposts.
	PublicAccessBlockConfiguration *PublicAccessBlockConfiguration `type:"structure"`

	// If you include this field, Amazon S3 restricts access to this access point
	// to requests from the specified virtual private cloud (VPC).
	//
	// This is required for creating an access point for Amazon S3 on Outposts buckets.
	VpcConfiguration *VpcConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateAccessPointInput) GoString added in v1.25.46 

func (s CreateAccessPointInput) GoString() string

GoString returns the string representation

func (*CreateAccessPointInput) SetAccountId added in v1.25.46 

func (s *CreateAccessPointInput) SetAccountId(v string) *CreateAccessPointInput

SetAccountId sets the AccountId field's value.

func (*CreateAccessPointInput) SetBucket added in v1.25.46 

func (s *CreateAccessPointInput) SetBucket(v string) *CreateAccessPointInput

SetBucket sets the Bucket field's value.

func (*CreateAccessPointInput) SetName added in v1.25.46 

func (s *CreateAccessPointInput) SetName(v string) *CreateAccessPointInput

SetName sets the Name field's value.

func (*CreateAccessPointInput) SetPublicAccessBlockConfiguration added in v1.25.46 

func (s *CreateAccessPointInput) SetPublicAccessBlockConfiguration(v *PublicAccessBlockConfiguration) *CreateAccessPointInput

SetPublicAccessBlockConfiguration sets the PublicAccessBlockConfiguration field's value.

func (*CreateAccessPointInput) SetVpcConfiguration added in v1.25.46 

func (s *CreateAccessPointInput) SetVpcConfiguration(v *VpcConfiguration) *CreateAccessPointInput

SetVpcConfiguration sets the VpcConfiguration field's value.

func (CreateAccessPointInput) String added in v1.25.46 

func (s CreateAccessPointInput) String() string

String returns the string representation

func (*CreateAccessPointInput) Validate added in v1.25.46 

func (s *CreateAccessPointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAccessPointOutput added in v1.25.46 

type CreateAccessPointOutput struct {

	// The ARN of the access point.
	AccessPointArn *string `min:"4" type:"string"`
	// contains filtered or unexported fields
}

func (CreateAccessPointOutput) GoString added in v1.25.46 

func (s CreateAccessPointOutput) GoString() string

GoString returns the string representation

func (*CreateAccessPointOutput) SetAccessPointArn added in v1.35.0 

func (s *CreateAccessPointOutput) SetAccessPointArn(v string) *CreateAccessPointOutput

SetAccessPointArn sets the AccessPointArn field's value.

func (CreateAccessPointOutput) String added in v1.25.46 

func (s CreateAccessPointOutput) String() string

String returns the string representation

type CreateBucketConfiguration added in v1.35.0 

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 *string `type:"string" enum:"BucketLocationConstraint"`
	// contains filtered or unexported fields
}

The container for the bucket configuration.

This is not supported by Amazon S3 on Outposts buckets.

func (CreateBucketConfiguration) GoString added in v1.35.0 

func (s CreateBucketConfiguration) GoString() string

GoString returns the string representation

func (*CreateBucketConfiguration) SetLocationConstraint added in v1.35.0 

func (s *CreateBucketConfiguration) SetLocationConstraint(v string) *CreateBucketConfiguration

SetLocationConstraint sets the LocationConstraint field's value.

func (CreateBucketConfiguration) String added in v1.35.0 

func (s CreateBucketConfiguration) String() string

String returns the string representation

type CreateBucketInput added in v1.35.0 

type CreateBucketInput struct {

	// The canned ACL to apply to the bucket.
	//
	// This is not supported by Amazon S3 on Outposts buckets.
	ACL *string `location:"header" locationName:"x-amz-acl" type:"string" enum:"BucketCannedACL"`

	// The name of the bucket.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"name" min:"3" type:"string" required:"true"`

	// The configuration information for the bucket.
	//
	// This is not supported by Amazon S3 on Outposts buckets.
	CreateBucketConfiguration *CreateBucketConfiguration `locationName:"CreateBucketConfiguration" type:"structure" xmlURI:"http://awss3control.amazonaws.com/doc/2018-08-20/"`

	// Allows grantee the read, write, read ACP, and write ACP permissions on the
	// bucket.
	//
	// This is not supported by Amazon S3 on Outposts buckets.
	GrantFullControl *string `location:"header" locationName:"x-amz-grant-full-control" type:"string"`

	// Allows grantee to list the objects in the bucket.
	//
	// This is not supported by Amazon S3 on Outposts buckets.
	GrantRead *string `location:"header" locationName:"x-amz-grant-read" type:"string"`

	// Allows grantee to read the bucket ACL.
	//
	// This is not supported by Amazon S3 on Outposts buckets.
	GrantReadACP *string `location:"header" locationName:"x-amz-grant-read-acp" type:"string"`

	// Allows grantee to create, overwrite, and delete any object in the bucket.
	//
	// This is not supported by Amazon S3 on Outposts buckets.
	GrantWrite *string `location:"header" locationName:"x-amz-grant-write" type:"string"`

	// Allows grantee to write the ACL for the applicable bucket.
	//
	// This is not supported by Amazon S3 on Outposts buckets.
	GrantWriteACP *string `location:"header" locationName:"x-amz-grant-write-acp" type:"string"`

	// Specifies whether you want S3 Object Lock to be enabled for the new bucket.
	//
	// This is not supported by Amazon S3 on Outposts buckets.
	ObjectLockEnabledForBucket *bool `location:"header" locationName:"x-amz-bucket-object-lock-enabled" type:"boolean"`

	// The ID of the Outposts where the bucket is being created.
	//
	// This is required by Amazon S3 on Outposts buckets.
	OutpostId *string `location:"header" locationName:"x-amz-outpost-id" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateBucketInput) GoString added in v1.35.0 

func (s CreateBucketInput) GoString() string

GoString returns the string representation

func (*CreateBucketInput) SetACL added in v1.35.0 

func (s *CreateBucketInput) SetACL(v string) *CreateBucketInput

SetACL sets the ACL field's value.

func (*CreateBucketInput) SetBucket added in v1.35.0 

func (s *CreateBucketInput) SetBucket(v string) *CreateBucketInput

SetBucket sets the Bucket field's value.

func (*CreateBucketInput) SetCreateBucketConfiguration added in v1.35.0 

func (s *CreateBucketInput) SetCreateBucketConfiguration(v *CreateBucketConfiguration) *CreateBucketInput

SetCreateBucketConfiguration sets the CreateBucketConfiguration field's value.

func (*CreateBucketInput) SetGrantFullControl added in v1.35.0 

func (s *CreateBucketInput) SetGrantFullControl(v string) *CreateBucketInput

SetGrantFullControl sets the GrantFullControl field's value.

func (*CreateBucketInput) SetGrantRead added in v1.35.0 

func (s *CreateBucketInput) SetGrantRead(v string) *CreateBucketInput

SetGrantRead sets the GrantRead field's value.

func (*CreateBucketInput) SetGrantReadACP added in v1.35.0 

func (s *CreateBucketInput) SetGrantReadACP(v string) *CreateBucketInput

SetGrantReadACP sets the GrantReadACP field's value.

func (*CreateBucketInput) SetGrantWrite added in v1.35.0 

func (s *CreateBucketInput) SetGrantWrite(v string) *CreateBucketInput

SetGrantWrite sets the GrantWrite field's value.

func (*CreateBucketInput) SetGrantWriteACP added in v1.35.0 

func (s *CreateBucketInput) SetGrantWriteACP(v string) *CreateBucketInput

SetGrantWriteACP sets the GrantWriteACP field's value.

func (*CreateBucketInput) SetObjectLockEnabledForBucket added in v1.35.0 

func (s *CreateBucketInput) SetObjectLockEnabledForBucket(v bool) *CreateBucketInput

SetObjectLockEnabledForBucket sets the ObjectLockEnabledForBucket field's value.

func (*CreateBucketInput) SetOutpostId added in v1.35.0 

func (s *CreateBucketInput) SetOutpostId(v string) *CreateBucketInput

SetOutpostId sets the OutpostId field's value.

func (CreateBucketInput) String added in v1.35.0 

func (s CreateBucketInput) String() string

String returns the string representation

func (*CreateBucketInput) Validate added in v1.35.0 

func (s *CreateBucketInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateBucketOutput added in v1.35.0 

type CreateBucketOutput struct {

	// The Amazon Resource Name (ARN) of the bucket.
	//
	// For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format
	// arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>.
	// For example, to access the bucket reports through outpost my-outpost owned
	// by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports.
	// The value must be URL encoded.
	BucketArn *string `min:"4" type:"string"`

	// The location of the bucket.
	Location *string `location:"header" locationName:"Location" type:"string"`
	// contains filtered or unexported fields
}

func (CreateBucketOutput) GoString added in v1.35.0 

func (s CreateBucketOutput) GoString() string

GoString returns the string representation

func (*CreateBucketOutput) SetBucketArn added in v1.35.0 

func (s *CreateBucketOutput) SetBucketArn(v string) *CreateBucketOutput

SetBucketArn sets the BucketArn field's value.

func (*CreateBucketOutput) SetLocation added in v1.35.0 

func (s *CreateBucketOutput) SetLocation(v string) *CreateBucketOutput

SetLocation sets the Location field's value.

func (CreateBucketOutput) String added in v1.35.0 

func (s CreateBucketOutput) String() string

String returns the string representation

type CreateJobInput added in v1.19.21 

type CreateJobInput struct {

	// The AWS account ID that creates the job.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// An idempotency token to ensure that you don't accidentally submit the same
	// request twice. You can use any string up to the maximum length.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// Indicates whether confirmation is required before Amazon S3 runs the job.
	// Confirmation is only required for jobs created through the Amazon S3 console.
	ConfirmationRequired *bool `type:"boolean"`

	// A description for this job. You can use any string within the permitted length.
	// Descriptions don't need to be unique and can be used for multiple jobs.
	Description *string `min:"1" type:"string"`

	// Configuration parameters for the manifest.
	//
	// Manifest is a required field
	Manifest *JobManifest `type:"structure" required:"true"`

	// The operation that you want this job to perform on each 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 Simple Storage Service Developer Guide.
	//
	// Operation is a required field
	Operation *JobOperation `type:"structure" required:"true"`

	// The numerical priority for this job. Higher numbers indicate higher priority.
	//
	// Priority is a required field
	Priority *int64 `type:"integer" required:"true"`

	// Configuration parameters for the optional job-completion report.
	//
	// Report is a required field
	Report *JobReport `type:"structure" required:"true"`

	// The Amazon Resource Name (ARN) for the AWS Identity and Access Management
	// (IAM) role that Batch Operations will use to run this job's operation on
	// each object in the manifest.
	//
	// RoleArn is a required field
	RoleArn *string `min:"1" type:"string" required:"true"`

	// A set of tags to associate with the S3 Batch Operations job. This is an optional
	// parameter.
	Tags []*S3Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateJobInput) GoString added in v1.19.21 

func (s CreateJobInput) GoString() string

GoString returns the string representation

func (*CreateJobInput) SetAccountId added in v1.19.21 

func (s *CreateJobInput) SetAccountId(v string) *CreateJobInput

SetAccountId sets the AccountId field's value.

func (*CreateJobInput) SetClientRequestToken added in v1.19.21 

func (s *CreateJobInput) SetClientRequestToken(v string) *CreateJobInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateJobInput) SetConfirmationRequired added in v1.19.21 

func (s *CreateJobInput) SetConfirmationRequired(v bool) *CreateJobInput

SetConfirmationRequired sets the ConfirmationRequired field's value.

func (*CreateJobInput) SetDescription added in v1.19.21 

func (s *CreateJobInput) SetDescription(v string) *CreateJobInput

SetDescription sets the Description field's value.

func (*CreateJobInput) SetManifest added in v1.19.21 

func (s *CreateJobInput) SetManifest(v *JobManifest) *CreateJobInput

SetManifest sets the Manifest field's value.

func (*CreateJobInput) SetOperation added in v1.19.21 

func (s *CreateJobInput) SetOperation(v *JobOperation) *CreateJobInput

SetOperation sets the Operation field's value.

func (*CreateJobInput) SetPriority added in v1.19.21 

func (s *CreateJobInput) SetPriority(v int64) *CreateJobInput

SetPriority sets the Priority field's value.

func (*CreateJobInput) SetReport added in v1.19.21 

func (s *CreateJobInput) SetReport(v *JobReport) *CreateJobInput

SetReport sets the Report field's value.

func (*CreateJobInput) SetRoleArn added in v1.19.21 

func (s *CreateJobInput) SetRoleArn(v string) *CreateJobInput

SetRoleArn sets the RoleArn field's value.

func (*CreateJobInput) SetTags added in v1.29.25 

func (s *CreateJobInput) SetTags(v []*S3Tag) *CreateJobInput

SetTags sets the Tags field's value.

func (CreateJobInput) String added in v1.19.21 

func (s CreateJobInput) String() string

String returns the string representation

func (*CreateJobInput) Validate added in v1.19.21 

func (s *CreateJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateJobOutput added in v1.19.21 

type CreateJobOutput struct {

	// The ID for this job. Amazon S3 generates this ID automatically and returns
	// it after a successful Create Job request.
	JobId *string `min:"5" type:"string"`
	// contains filtered or unexported fields
}

func (CreateJobOutput) GoString added in v1.19.21 

func (s CreateJobOutput) GoString() string

GoString returns the string representation

func (*CreateJobOutput) SetJobId added in v1.19.21 

func (s *CreateJobOutput) SetJobId(v string) *CreateJobOutput

SetJobId sets the JobId field's value.

func (CreateJobOutput) String added in v1.19.21 

func (s CreateJobOutput) String() string

String returns the string representation

type DeleteAccessPointInput added in v1.25.46 

type DeleteAccessPointInput struct {

	// The account ID for the account that owns the specified access point.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The name of the access point you want to delete.
	//
	// For Amazon S3 on Outposts specify the ARN of the access point accessed in
	// the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>.
	// For example, to access the access point reports-ap through outpost my-outpost
	// owned by account 123456789012 in Region us-west-2, use the URL encoding of
	// arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap.
	// The value must be URL encoded.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"name" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAccessPointInput) GoString added in v1.25.46 

func (s DeleteAccessPointInput) GoString() string

GoString returns the string representation

func (*DeleteAccessPointInput) SetAccountId added in v1.25.46 

func (s *DeleteAccessPointInput) SetAccountId(v string) *DeleteAccessPointInput

SetAccountId sets the AccountId field's value.

func (*DeleteAccessPointInput) SetName added in v1.25.46 

func (s *DeleteAccessPointInput) SetName(v string) *DeleteAccessPointInput

SetName sets the Name field's value.

func (DeleteAccessPointInput) String added in v1.25.46 

func (s DeleteAccessPointInput) String() string

String returns the string representation

func (*DeleteAccessPointInput) Validate added in v1.25.46 

func (s *DeleteAccessPointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAccessPointOutput added in v1.25.46 

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

func (DeleteAccessPointOutput) GoString added in v1.25.46 

func (s DeleteAccessPointOutput) GoString() string

GoString returns the string representation

func (DeleteAccessPointOutput) String added in v1.25.46 

func (s DeleteAccessPointOutput) String() string

String returns the string representation

type DeleteAccessPointPolicyInput added in v1.25.46 

type DeleteAccessPointPolicyInput struct {

	// The account ID for the account that owns the specified access point.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The name of the access point whose policy you want to delete.
	//
	// For Amazon S3 on Outposts specify the ARN of the access point accessed in
	// the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>.
	// For example, to access the access point reports-ap through outpost my-outpost
	// owned by account 123456789012 in Region us-west-2, use the URL encoding of
	// arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap.
	// The value must be URL encoded.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"name" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAccessPointPolicyInput) GoString added in v1.25.46 

func (s DeleteAccessPointPolicyInput) GoString() string

GoString returns the string representation

func (*DeleteAccessPointPolicyInput) SetAccountId added in v1.25.46 

func (s *DeleteAccessPointPolicyInput) SetAccountId(v string) *DeleteAccessPointPolicyInput

SetAccountId sets the AccountId field's value.

func (*DeleteAccessPointPolicyInput) SetName added in v1.25.46 

func (s *DeleteAccessPointPolicyInput) SetName(v string) *DeleteAccessPointPolicyInput

SetName sets the Name field's value.

func (DeleteAccessPointPolicyInput) String added in v1.25.46 

func (s DeleteAccessPointPolicyInput) String() string

String returns the string representation

func (*DeleteAccessPointPolicyInput) Validate added in v1.25.46 

func (s *DeleteAccessPointPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAccessPointPolicyOutput added in v1.25.46 

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

func (DeleteAccessPointPolicyOutput) GoString added in v1.25.46 

func (s DeleteAccessPointPolicyOutput) GoString() string

GoString returns the string representation

func (DeleteAccessPointPolicyOutput) String added in v1.25.46 

func (s DeleteAccessPointPolicyOutput) String() string

String returns the string representation

type DeleteBucketInput added in v1.35.0 

type DeleteBucketInput struct {

	// The account ID that owns the Outposts bucket.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// Specifies the bucket being deleted.
	//
	// For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format
	// arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>.
	// For example, to access the bucket reports through outpost my-outpost owned
	// by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports.
	// The value must be URL encoded.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"name" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBucketInput) GoString added in v1.35.0 

func (s DeleteBucketInput) GoString() string

GoString returns the string representation

func (*DeleteBucketInput) SetAccountId added in v1.35.0 

func (s *DeleteBucketInput) SetAccountId(v string) *DeleteBucketInput

SetAccountId sets the AccountId field's value.

func (*DeleteBucketInput) SetBucket added in v1.35.0 

func (s *DeleteBucketInput) SetBucket(v string) *DeleteBucketInput

SetBucket sets the Bucket field's value.

func (DeleteBucketInput) String added in v1.35.0 

func (s DeleteBucketInput) String() string

String returns the string representation

func (*DeleteBucketInput) Validate added in v1.35.0 

func (s *DeleteBucketInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBucketLifecycleConfigurationInput added in v1.35.0 

type DeleteBucketLifecycleConfigurationInput struct {

	// The account ID of the lifecycle configuration to delete.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The bucket ARN of the bucket.
	//
	// For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format
	// arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>.
	// For example, to access the bucket reports through outpost my-outpost owned
	// by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports.
	// The value must be URL encoded.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"name" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBucketLifecycleConfigurationInput) GoString added in v1.35.0 

func (s DeleteBucketLifecycleConfigurationInput) GoString() string

GoString returns the string representation

func (*DeleteBucketLifecycleConfigurationInput) SetAccountId added in v1.35.0 

func (s *DeleteBucketLifecycleConfigurationInput) SetAccountId(v string) *DeleteBucketLifecycleConfigurationInput

SetAccountId sets the AccountId field's value.

func (*DeleteBucketLifecycleConfigurationInput) SetBucket added in v1.35.0 

func (s *DeleteBucketLifecycleConfigurationInput) SetBucket(v string) *DeleteBucketLifecycleConfigurationInput

SetBucket sets the Bucket field's value.

func (DeleteBucketLifecycleConfigurationInput) String added in v1.35.0 

func (s DeleteBucketLifecycleConfigurationInput) String() string

String returns the string representation

func (*DeleteBucketLifecycleConfigurationInput) Validate added in v1.35.0 

func (s *DeleteBucketLifecycleConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBucketLifecycleConfigurationOutput added in v1.35.0 

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

func (DeleteBucketLifecycleConfigurationOutput) GoString added in v1.35.0 

func (s DeleteBucketLifecycleConfigurationOutput) GoString() string

GoString returns the string representation

func (DeleteBucketLifecycleConfigurationOutput) String added in v1.35.0 

func (s DeleteBucketLifecycleConfigurationOutput) String() string

String returns the string representation

type DeleteBucketOutput added in v1.35.0 

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

func (DeleteBucketOutput) GoString added in v1.35.0 

func (s DeleteBucketOutput) GoString() string

GoString returns the string representation

func (DeleteBucketOutput) String added in v1.35.0 

func (s DeleteBucketOutput) String() string

String returns the string representation

type DeleteBucketPolicyInput added in v1.35.0 

type DeleteBucketPolicyInput struct {

	// The account ID of the Outposts bucket.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The ARN of the bucket.
	//
	// For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format
	// arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>.
	// For example, to access the bucket reports through outpost my-outpost owned
	// by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports.
	// The value must be URL encoded.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"name" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBucketPolicyInput) GoString added in v1.35.0 

func (s DeleteBucketPolicyInput) GoString() string

GoString returns the string representation

func (*DeleteBucketPolicyInput) SetAccountId added in v1.35.0 

func (s *DeleteBucketPolicyInput) SetAccountId(v string) *DeleteBucketPolicyInput

SetAccountId sets the AccountId field's value.

func (*DeleteBucketPolicyInput) SetBucket added in v1.35.0 

func (s *DeleteBucketPolicyInput) SetBucket(v string) *DeleteBucketPolicyInput

SetBucket sets the Bucket field's value.

func (DeleteBucketPolicyInput) String added in v1.35.0 

func (s DeleteBucketPolicyInput) String() string

String returns the string representation

func (*DeleteBucketPolicyInput) Validate added in v1.35.0 

func (s *DeleteBucketPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBucketPolicyOutput added in v1.35.0 

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

func (DeleteBucketPolicyOutput) GoString added in v1.35.0 

func (s DeleteBucketPolicyOutput) GoString() string

GoString returns the string representation

func (DeleteBucketPolicyOutput) String added in v1.35.0 

func (s DeleteBucketPolicyOutput) String() string

String returns the string representation

type DeleteBucketTaggingInput added in v1.35.0 

type DeleteBucketTaggingInput struct {

	// The AWS account ID of the Outposts bucket tag set to be removed.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The bucket ARN that has the tag set to be removed.
	//
	// For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format
	// arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>.
	// For example, to access the bucket reports through outpost my-outpost owned
	// by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports.
	// The value must be URL encoded.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"name" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBucketTaggingInput) GoString added in v1.35.0 

func (s DeleteBucketTaggingInput) GoString() string

GoString returns the string representation

func (*DeleteBucketTaggingInput) SetAccountId added in v1.35.0 

func (s *DeleteBucketTaggingInput) SetAccountId(v string) *DeleteBucketTaggingInput

SetAccountId sets the AccountId field's value.

func (*DeleteBucketTaggingInput) SetBucket added in v1.35.0 

func (s *DeleteBucketTaggingInput) SetBucket(v string) *DeleteBucketTaggingInput

SetBucket sets the Bucket field's value.

func (DeleteBucketTaggingInput) String added in v1.35.0 

func (s DeleteBucketTaggingInput) String() string

String returns the string representation

func (*DeleteBucketTaggingInput) Validate added in v1.35.0 

func (s *DeleteBucketTaggingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBucketTaggingOutput added in v1.35.0 

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

func (DeleteBucketTaggingOutput) GoString added in v1.35.0 

func (s DeleteBucketTaggingOutput) GoString() string

GoString returns the string representation

func (DeleteBucketTaggingOutput) String added in v1.35.0 

func (s DeleteBucketTaggingOutput) String() string

String returns the string representation

type DeleteJobTaggingInput added in v1.29.25 

type DeleteJobTaggingInput struct {

	// The AWS account ID associated with the S3 Batch Operations job.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The ID for the S3 Batch Operations job whose tags you want to delete.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"id" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteJobTaggingInput) GoString added in v1.29.25 

func (s DeleteJobTaggingInput) GoString() string

GoString returns the string representation

func (*DeleteJobTaggingInput) SetAccountId added in v1.29.25 

func (s *DeleteJobTaggingInput) SetAccountId(v string) *DeleteJobTaggingInput

SetAccountId sets the AccountId field's value.

func (*DeleteJobTaggingInput) SetJobId added in v1.29.25 

func (s *DeleteJobTaggingInput) SetJobId(v string) *DeleteJobTaggingInput

SetJobId sets the JobId field's value.

func (DeleteJobTaggingInput) String added in v1.29.25 

func (s DeleteJobTaggingInput) String() string

String returns the string representation

func (*DeleteJobTaggingInput) Validate added in v1.29.25 

func (s *DeleteJobTaggingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteJobTaggingOutput added in v1.29.25 

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

func (DeleteJobTaggingOutput) GoString added in v1.29.25 

func (s DeleteJobTaggingOutput) GoString() string

GoString returns the string representation

func (DeleteJobTaggingOutput) String added in v1.29.25 

func (s DeleteJobTaggingOutput) String() string

String returns the string representation

type DeletePublicAccessBlockInput 

type DeletePublicAccessBlockInput struct {

	// The account ID for the AWS account whose PublicAccessBlock configuration
	// you want to remove.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeletePublicAccessBlockInput) GoString 

func (s DeletePublicAccessBlockInput) GoString() string

GoString returns the string representation

func (*DeletePublicAccessBlockInput) SetAccountId 

func (s *DeletePublicAccessBlockInput) SetAccountId(v string) *DeletePublicAccessBlockInput

SetAccountId sets the AccountId field's value.

func (DeletePublicAccessBlockInput) String 

func (s DeletePublicAccessBlockInput) String() string

String returns the string representation

func (*DeletePublicAccessBlockInput) Validate 

func (s *DeletePublicAccessBlockInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeletePublicAccessBlockOutput 

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

func (DeletePublicAccessBlockOutput) GoString 

func (s DeletePublicAccessBlockOutput) GoString() string

GoString returns the string representation

func (DeletePublicAccessBlockOutput) String 

func (s DeletePublicAccessBlockOutput) String() string

String returns the string representation

type DescribeJobInput added in v1.19.21 

type DescribeJobInput struct {

	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The ID for the job whose information you want to retrieve.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"id" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeJobInput) GoString added in v1.19.21 

func (s DescribeJobInput) GoString() string

GoString returns the string representation

func (*DescribeJobInput) SetAccountId added in v1.19.21 

func (s *DescribeJobInput) SetAccountId(v string) *DescribeJobInput

SetAccountId sets the AccountId field's value.

func (*DescribeJobInput) SetJobId added in v1.19.21 

func (s *DescribeJobInput) SetJobId(v string) *DescribeJobInput

SetJobId sets the JobId field's value.

func (DescribeJobInput) String added in v1.19.21 

func (s DescribeJobInput) String() string

String returns the string representation

func (*DescribeJobInput) Validate added in v1.19.21 

func (s *DescribeJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeJobOutput added in v1.19.21 

type DescribeJobOutput struct {

	// Contains the configuration parameters and status for the job specified in
	// the Describe Job request.
	Job *JobDescriptor `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeJobOutput) GoString added in v1.19.21 

func (s DescribeJobOutput) GoString() string

GoString returns the string representation

func (*DescribeJobOutput) SetJob added in v1.19.21 

func (s *DescribeJobOutput) SetJob(v *JobDescriptor) *DescribeJobOutput

SetJob sets the Job field's value.

func (DescribeJobOutput) String added in v1.19.21 

func (s DescribeJobOutput) String() string

String returns the string representation

type GetAccessPointInput added in v1.25.46 

type GetAccessPointInput struct {

	// The account ID for the account that owns the specified access point.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The name of the access point whose configuration information you want to
	// retrieve.
	//
	// For Amazon S3 on Outposts specify the ARN of the access point accessed in
	// the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>.
	// For example, to access the access point reports-ap through outpost my-outpost
	// owned by account 123456789012 in Region us-west-2, use the URL encoding of
	// arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap.
	// The value must be URL encoded.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"name" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetAccessPointInput) GoString added in v1.25.46 

func (s GetAccessPointInput) GoString() string

GoString returns the string representation

func (*GetAccessPointInput) SetAccountId added in v1.25.46 

func (s *GetAccessPointInput) SetAccountId(v string) *GetAccessPointInput

SetAccountId sets the AccountId field's value.

func (*GetAccessPointInput) SetName added in v1.25.46 

func (s *GetAccessPointInput) SetName(v string) *GetAccessPointInput

SetName sets the Name field's value.

func (GetAccessPointInput) String added in v1.25.46 

func (s GetAccessPointInput) String() string

String returns the string representation

func (*GetAccessPointInput) Validate added in v1.25.46 

func (s *GetAccessPointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAccessPointOutput added in v1.25.46 

type GetAccessPointOutput struct {

	// The name of the bucket associated with the specified access point.
	Bucket *string `min:"3" type:"string"`

	// The date and time when the specified access point was created.
	CreationDate *time.Time `type:"timestamp"`

	// The name of the specified access point.
	Name *string `min:"3" type:"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 will always be true for an Amazon S3 on Outposts access point
	NetworkOrigin *string `type:"string" enum:"NetworkOrigin"`

	// The PublicAccessBlock configuration that you want to apply to this Amazon
	// S3 bucket. 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 Simple Storage Service Developer Guide.
	//
	// This is not supported for Amazon S3 on Outposts.
	PublicAccessBlockConfiguration *PublicAccessBlockConfiguration `type:"structure"`

	// Contains the virtual private cloud (VPC) configuration for the specified
	// access point.
	VpcConfiguration *VpcConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (GetAccessPointOutput) GoString added in v1.25.46 

func (s GetAccessPointOutput) GoString() string

GoString returns the string representation

func (*GetAccessPointOutput) SetBucket added in v1.25.46 

func (s *GetAccessPointOutput) SetBucket(v string) *GetAccessPointOutput

SetBucket sets the Bucket field's value.

func (*GetAccessPointOutput) SetCreationDate added in v1.25.46 

func (s *GetAccessPointOutput) SetCreationDate(v time.Time) *GetAccessPointOutput

SetCreationDate sets the CreationDate field's value.

func (*GetAccessPointOutput) SetName added in v1.25.46 

func (s *GetAccessPointOutput) SetName(v string) *GetAccessPointOutput

SetName sets the Name field's value.

func (*GetAccessPointOutput) SetNetworkOrigin added in v1.25.46 

func (s *GetAccessPointOutput) SetNetworkOrigin(v string) *GetAccessPointOutput

SetNetworkOrigin sets the NetworkOrigin field's value.

func (*GetAccessPointOutput) SetPublicAccessBlockConfiguration added in v1.25.46 

func (s *GetAccessPointOutput) SetPublicAccessBlockConfiguration(v *PublicAccessBlockConfiguration) *GetAccessPointOutput

SetPublicAccessBlockConfiguration sets the PublicAccessBlockConfiguration field's value.

func (*GetAccessPointOutput) SetVpcConfiguration added in v1.25.46 

func (s *GetAccessPointOutput) SetVpcConfiguration(v *VpcConfiguration) *GetAccessPointOutput

SetVpcConfiguration sets the VpcConfiguration field's value.

func (GetAccessPointOutput) String added in v1.25.46 

func (s GetAccessPointOutput) String() string

String returns the string representation

type GetAccessPointPolicyInput added in v1.25.46 

type GetAccessPointPolicyInput struct {

	// The account ID for the account that owns the specified access point.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The name of the access point whose policy you want to retrieve.
	//
	// For Amazon S3 on Outposts specify the ARN of the access point accessed in
	// the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>.
	// For example, to access the access point reports-ap through outpost my-outpost
	// owned by account 123456789012 in Region us-west-2, use the URL encoding of
	// arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap.
	// The value must be URL encoded.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"name" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetAccessPointPolicyInput) GoString added in v1.25.46 

func (s GetAccessPointPolicyInput) GoString() string

GoString returns the string representation

func (*GetAccessPointPolicyInput) SetAccountId added in v1.25.46 

func (s *GetAccessPointPolicyInput) SetAccountId(v string) *GetAccessPointPolicyInput

SetAccountId sets the AccountId field's value.

func (*GetAccessPointPolicyInput) SetName added in v1.25.46 

func (s *GetAccessPointPolicyInput) SetName(v string) *GetAccessPointPolicyInput

SetName sets the Name field's value.

func (GetAccessPointPolicyInput) String added in v1.25.46 

func (s GetAccessPointPolicyInput) String() string

String returns the string representation

func (*GetAccessPointPolicyInput) Validate added in v1.25.46 

func (s *GetAccessPointPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAccessPointPolicyOutput added in v1.25.46 

type GetAccessPointPolicyOutput struct {

	// The access point policy associated with the specified access point.
	Policy *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetAccessPointPolicyOutput) GoString added in v1.25.46 

func (s GetAccessPointPolicyOutput) GoString() string

GoString returns the string representation

func (*GetAccessPointPolicyOutput) SetPolicy added in v1.25.46 

func (s *GetAccessPointPolicyOutput) SetPolicy(v string) *GetAccessPointPolicyOutput

SetPolicy sets the Policy field's value.

func (GetAccessPointPolicyOutput) String added in v1.25.46 

func (s GetAccessPointPolicyOutput) String() string

String returns the string representation

type GetAccessPointPolicyStatusInput added in v1.25.46 

type GetAccessPointPolicyStatusInput struct {

	// The account ID for the account that owns the specified access point.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The name of the access point whose policy status you want to retrieve.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"name" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetAccessPointPolicyStatusInput) GoString added in v1.25.46 

func (s GetAccessPointPolicyStatusInput) GoString() string

GoString returns the string representation

func (*GetAccessPointPolicyStatusInput) SetAccountId added in v1.25.46 

func (s *GetAccessPointPolicyStatusInput) SetAccountId(v string) *GetAccessPointPolicyStatusInput

SetAccountId sets the AccountId field's value.

func (*GetAccessPointPolicyStatusInput) SetName added in v1.25.46 

func (s *GetAccessPointPolicyStatusInput) SetName(v string) *GetAccessPointPolicyStatusInput

SetName sets the Name field's value.

func (GetAccessPointPolicyStatusInput) String added in v1.25.46 

func (s GetAccessPointPolicyStatusInput) String() string

String returns the string representation

func (*GetAccessPointPolicyStatusInput) Validate added in v1.25.46 

func (s *GetAccessPointPolicyStatusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAccessPointPolicyStatusOutput added in v1.25.46 

type GetAccessPointPolicyStatusOutput struct {

	// Indicates the current policy status of the specified access point.
	PolicyStatus *PolicyStatus `type:"structure"`
	// contains filtered or unexported fields
}

func (GetAccessPointPolicyStatusOutput) GoString added in v1.25.46 

func (s GetAccessPointPolicyStatusOutput) GoString() string

GoString returns the string representation

func (*GetAccessPointPolicyStatusOutput) SetPolicyStatus added in v1.25.46 

func (s *GetAccessPointPolicyStatusOutput) SetPolicyStatus(v *PolicyStatus) *GetAccessPointPolicyStatusOutput

SetPolicyStatus sets the PolicyStatus field's value.

func (GetAccessPointPolicyStatusOutput) String added in v1.25.46 

func (s GetAccessPointPolicyStatusOutput) String() string

String returns the string representation

type GetBucketInput added in v1.35.0 

type GetBucketInput struct {

	// The AWS account ID of the Outposts bucket.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The ARN of the bucket.
	//
	// For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format
	// arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>.
	// For example, to access the bucket reports through outpost my-outpost owned
	// by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports.
	// The value must be URL encoded.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"name" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketInput) GoString added in v1.35.0 

func (s GetBucketInput) GoString() string

GoString returns the string representation

func (*GetBucketInput) SetAccountId added in v1.35.0 

func (s *GetBucketInput) SetAccountId(v string) *GetBucketInput

SetAccountId sets the AccountId field's value.

func (*GetBucketInput) SetBucket added in v1.35.0 

func (s *GetBucketInput) SetBucket(v string) *GetBucketInput

SetBucket sets the Bucket field's value.

func (GetBucketInput) String added in v1.35.0 

func (s GetBucketInput) String() string

String returns the string representation

func (*GetBucketInput) Validate added in v1.35.0 

func (s *GetBucketInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBucketLifecycleConfigurationInput added in v1.35.0 

type GetBucketLifecycleConfigurationInput struct {

	// The AWS account ID of the Outposts bucket.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the bucket.
	//
	// For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format
	// arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>.
	// For example, to access the bucket reports through outpost my-outpost owned
	// by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports.
	// The value must be URL encoded.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"name" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketLifecycleConfigurationInput) GoString added in v1.35.0 

func (s GetBucketLifecycleConfigurationInput) GoString() string

GoString returns the string representation

func (*GetBucketLifecycleConfigurationInput) SetAccountId added in v1.35.0 

func (s *GetBucketLifecycleConfigurationInput) SetAccountId(v string) *GetBucketLifecycleConfigurationInput

SetAccountId sets the AccountId field's value.

func (*GetBucketLifecycleConfigurationInput) SetBucket added in v1.35.0 

func (s *GetBucketLifecycleConfigurationInput) SetBucket(v string) *GetBucketLifecycleConfigurationInput

SetBucket sets the Bucket field's value.

func (GetBucketLifecycleConfigurationInput) String added in v1.35.0 

func (s GetBucketLifecycleConfigurationInput) String() string

String returns the string representation

func (*GetBucketLifecycleConfigurationInput) Validate added in v1.35.0 

func (s *GetBucketLifecycleConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBucketLifecycleConfigurationOutput added in v1.35.0 

type GetBucketLifecycleConfigurationOutput struct {

	// Container for the lifecycle rule of the Outposts bucket.
	Rules []*LifecycleRule `locationNameList:"Rule" type:"list"`
	// contains filtered or unexported fields
}

func (GetBucketLifecycleConfigurationOutput) GoString added in v1.35.0 

func (s GetBucketLifecycleConfigurationOutput) GoString() string

GoString returns the string representation

func (*GetBucketLifecycleConfigurationOutput) SetRules added in v1.35.0 

func (s *GetBucketLifecycleConfigurationOutput) SetRules(v []*LifecycleRule) *GetBucketLifecycleConfigurationOutput

SetRules sets the Rules field's value.

func (GetBucketLifecycleConfigurationOutput) String added in v1.35.0 

func (s GetBucketLifecycleConfigurationOutput) String() string

String returns the string representation

type GetBucketOutput added in v1.35.0 

type GetBucketOutput struct {

	// The Outposts bucket requested.
	Bucket *string `min:"3" type:"string"`

	// The creation date of the Outposts bucket.
	CreationDate *time.Time `type:"timestamp"`

	PublicAccessBlockEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (GetBucketOutput) GoString added in v1.35.0 

func (s GetBucketOutput) GoString() string

GoString returns the string representation

func (*GetBucketOutput) SetBucket added in v1.35.0 

func (s *GetBucketOutput) SetBucket(v string) *GetBucketOutput

SetBucket sets the Bucket field's value.

func (*GetBucketOutput) SetCreationDate added in v1.35.0 

func (s *GetBucketOutput) SetCreationDate(v time.Time) *GetBucketOutput

SetCreationDate sets the CreationDate field's value.

func (*GetBucketOutput) SetPublicAccessBlockEnabled added in v1.35.0 

func (s *GetBucketOutput) SetPublicAccessBlockEnabled(v bool) *GetBucketOutput

SetPublicAccessBlockEnabled sets the PublicAccessBlockEnabled field's value.

func (GetBucketOutput) String added in v1.35.0 

func (s GetBucketOutput) String() string

String returns the string representation

type GetBucketPolicyInput added in v1.35.0 

type GetBucketPolicyInput struct {

	// The AWS account ID of the Outposts bucket.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The ARN of the bucket.
	//
	// For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format
	// arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>.
	// For example, to access the bucket reports through outpost my-outpost owned
	// by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports.
	// The value must be URL encoded.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"name" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketPolicyInput) GoString added in v1.35.0 

func (s GetBucketPolicyInput) GoString() string

GoString returns the string representation

func (*GetBucketPolicyInput) SetAccountId added in v1.35.0 

func (s *GetBucketPolicyInput) SetAccountId(v string) *GetBucketPolicyInput

SetAccountId sets the AccountId field's value.

func (*GetBucketPolicyInput) SetBucket added in v1.35.0 

func (s *GetBucketPolicyInput) SetBucket(v string) *GetBucketPolicyInput

SetBucket sets the Bucket field's value.

func (GetBucketPolicyInput) String added in v1.35.0 

func (s GetBucketPolicyInput) String() string

String returns the string representation

func (*GetBucketPolicyInput) Validate added in v1.35.0 

func (s *GetBucketPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBucketPolicyOutput added in v1.35.0 

type GetBucketPolicyOutput struct {

	// The policy of the Outposts bucket.
	Policy *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetBucketPolicyOutput) GoString added in v1.35.0 

func (s GetBucketPolicyOutput) GoString() string

GoString returns the string representation

func (*GetBucketPolicyOutput) SetPolicy added in v1.35.0 

func (s *GetBucketPolicyOutput) SetPolicy(v string) *GetBucketPolicyOutput

SetPolicy sets the Policy field's value.

func (GetBucketPolicyOutput) String added in v1.35.0 

func (s GetBucketPolicyOutput) String() string

String returns the string representation

type GetBucketTaggingInput added in v1.35.0 

type GetBucketTaggingInput struct {

	// The AWS account ID of the Outposts bucket.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The ARN of the bucket.
	//
	// For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format
	// arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>.
	// For example, to access the bucket reports through outpost my-outpost owned
	// by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports.
	// The value must be URL encoded.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"name" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketTaggingInput) GoString added in v1.35.0 

func (s GetBucketTaggingInput) GoString() string

GoString returns the string representation

func (*GetBucketTaggingInput) SetAccountId added in v1.35.0 

func (s *GetBucketTaggingInput) SetAccountId(v string) *GetBucketTaggingInput

SetAccountId sets the AccountId field's value.

func (*GetBucketTaggingInput) SetBucket added in v1.35.0 

func (s *GetBucketTaggingInput) SetBucket(v string) *GetBucketTaggingInput

SetBucket sets the Bucket field's value.

func (GetBucketTaggingInput) String added in v1.35.0 

func (s GetBucketTaggingInput) String() string

String returns the string representation

func (*GetBucketTaggingInput) Validate added in v1.35.0 

func (s *GetBucketTaggingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBucketTaggingOutput added in v1.35.0 

type GetBucketTaggingOutput struct {

	// The tags set of the Outposts bucket.
	//
	// TagSet is a required field
	TagSet []*S3Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketTaggingOutput) GoString added in v1.35.0 

func (s GetBucketTaggingOutput) GoString() string

GoString returns the string representation

func (*GetBucketTaggingOutput) SetTagSet added in v1.35.0 

func (s *GetBucketTaggingOutput) SetTagSet(v []*S3Tag) *GetBucketTaggingOutput

SetTagSet sets the TagSet field's value.

func (GetBucketTaggingOutput) String added in v1.35.0 

func (s GetBucketTaggingOutput) String() string

String returns the string representation

type GetJobTaggingInput added in v1.29.25 

type GetJobTaggingInput struct {

	// The AWS account ID associated with the S3 Batch Operations job.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The ID for the S3 Batch Operations job whose tags you want to retrieve.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"id" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetJobTaggingInput) GoString added in v1.29.25 

func (s GetJobTaggingInput) GoString() string

GoString returns the string representation

func (*GetJobTaggingInput) SetAccountId added in v1.29.25 

func (s *GetJobTaggingInput) SetAccountId(v string) *GetJobTaggingInput

SetAccountId sets the AccountId field's value.

func (*GetJobTaggingInput) SetJobId added in v1.29.25 

func (s *GetJobTaggingInput) SetJobId(v string) *GetJobTaggingInput

SetJobId sets the JobId field's value.

func (GetJobTaggingInput) String added in v1.29.25 

func (s GetJobTaggingInput) String() string

String returns the string representation

func (*GetJobTaggingInput) Validate added in v1.29.25 

func (s *GetJobTaggingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetJobTaggingOutput added in v1.29.25 

type GetJobTaggingOutput struct {

	// The set of tags associated with the S3 Batch Operations job.
	Tags []*S3Tag `type:"list"`
	// contains filtered or unexported fields
}

func (GetJobTaggingOutput) GoString added in v1.29.25 

func (s GetJobTaggingOutput) GoString() string

GoString returns the string representation

func (*GetJobTaggingOutput) SetTags added in v1.29.25 

func (s *GetJobTaggingOutput) SetTags(v []*S3Tag) *GetJobTaggingOutput

SetTags sets the Tags field's value.

func (GetJobTaggingOutput) String added in v1.29.25 

func (s GetJobTaggingOutput) String() string

String returns the string representation

type GetPublicAccessBlockInput 

type GetPublicAccessBlockInput struct {

	// The account ID for the AWS account whose PublicAccessBlock configuration
	// you want to retrieve.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetPublicAccessBlockInput) GoString 

func (s GetPublicAccessBlockInput) GoString() string

GoString returns the string representation

func (*GetPublicAccessBlockInput) SetAccountId 

func (s *GetPublicAccessBlockInput) SetAccountId(v string) *GetPublicAccessBlockInput

SetAccountId sets the AccountId field's value.

func (GetPublicAccessBlockInput) String 

func (s GetPublicAccessBlockInput) String() string

String returns the string representation

func (*GetPublicAccessBlockInput) Validate 

func (s *GetPublicAccessBlockInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetPublicAccessBlockOutput 

type GetPublicAccessBlockOutput struct {

	// The PublicAccessBlock configuration currently in effect for this AWS account.
	PublicAccessBlockConfiguration *PublicAccessBlockConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (GetPublicAccessBlockOutput) GoString 

func (s GetPublicAccessBlockOutput) GoString() string

GoString returns the string representation

func (*GetPublicAccessBlockOutput) SetPublicAccessBlockConfiguration 

func (s *GetPublicAccessBlockOutput) SetPublicAccessBlockConfiguration(v *PublicAccessBlockConfiguration) *GetPublicAccessBlockOutput

SetPublicAccessBlockConfiguration sets the PublicAccessBlockConfiguration field's value.

func (GetPublicAccessBlockOutput) String 

func (s GetPublicAccessBlockOutput) String() string

String returns the string representation

type JobDescriptor added in v1.19.21 

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 `type:"boolean"`

	// A timestamp indicating when this job was created.
	CreationTime *time.Time `type:"timestamp"`

	// The description for this job, if one was provided in this job's Create Job
	// request.
	Description *string `min:"1" type:"string"`

	// If the specified job failed, this field contains information describing the
	// failure.
	FailureReasons []*JobFailure `type:"list"`

	// The Amazon Resource Name (ARN) for this job.
	JobArn *string `min:"1" type:"string"`

	// The ID for the specified job.
	JobId *string `min:"5" type:"string"`

	// The configuration information for the specified job's manifest object.
	Manifest *JobManifest `type:"structure"`

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

	// The priority of the specified job.
	Priority *int64 `type:"integer"`

	// 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 `type:"structure"`

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

	// The Amazon Resource Name (ARN) for the AWS Identity and Access Management
	// (IAM) role assigned to run the tasks for this job.
	RoleArn *string `min:"1" type:"string"`

	// The current status of the specified job.
	Status *string `type:"string" enum:"JobStatus"`

	// The reason for updating the job.
	StatusUpdateReason *string `min:"1" type:"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 `min:"1" type:"string"`

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

	// 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 `type:"timestamp"`
	// contains filtered or unexported fields
}

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

func (JobDescriptor) GoString added in v1.19.21 

func (s JobDescriptor) GoString() string

GoString returns the string representation

func (*JobDescriptor) SetConfirmationRequired added in v1.19.21 

func (s *JobDescriptor) SetConfirmationRequired(v bool) *JobDescriptor

SetConfirmationRequired sets the ConfirmationRequired field's value.

func (*JobDescriptor) SetCreationTime added in v1.19.21 

func (s *JobDescriptor) SetCreationTime(v time.Time) *JobDescriptor

SetCreationTime sets the CreationTime field's value.

func (*JobDescriptor) SetDescription added in v1.19.21 

func (s *JobDescriptor) SetDescription(v string) *JobDescriptor

SetDescription sets the Description field's value.

func (*JobDescriptor) SetFailureReasons added in v1.19.21 

func (s *JobDescriptor) SetFailureReasons(v []*JobFailure) *JobDescriptor

SetFailureReasons sets the FailureReasons field's value.

func (*JobDescriptor) SetJobArn added in v1.19.21 

func (s *JobDescriptor) SetJobArn(v string) *JobDescriptor

SetJobArn sets the JobArn field's value.

func (*JobDescriptor) SetJobId added in v1.19.21 

func (s *JobDescriptor) SetJobId(v string) *JobDescriptor

SetJobId sets the JobId field's value.

func (*JobDescriptor) SetManifest added in v1.19.21 

func (s *JobDescriptor) SetManifest(v *JobManifest) *JobDescriptor

SetManifest sets the Manifest field's value.

func (*JobDescriptor) SetOperation added in v1.19.21 

func (s *JobDescriptor) SetOperation(v *JobOperation) *JobDescriptor

SetOperation sets the Operation field's value.

func (*JobDescriptor) SetPriority added in v1.19.21 

func (s *JobDescriptor) SetPriority(v int64) *JobDescriptor

SetPriority sets the Priority field's value.

func (*JobDescriptor) SetProgressSummary added in v1.19.21 

func (s *JobDescriptor) SetProgressSummary(v *JobProgressSummary) *JobDescriptor

SetProgressSummary sets the ProgressSummary field's value.

func (*JobDescriptor) SetReport added in v1.19.21 

func (s *JobDescriptor) SetReport(v *JobReport) *JobDescriptor

SetReport sets the Report field's value.

func (*JobDescriptor) SetRoleArn added in v1.19.21 

func (s *JobDescriptor) SetRoleArn(v string) *JobDescriptor

SetRoleArn sets the RoleArn field's value.

func (*JobDescriptor) SetStatus added in v1.19.21 

func (s *JobDescriptor) SetStatus(v string) *JobDescriptor

SetStatus sets the Status field's value.

func (*JobDescriptor) SetStatusUpdateReason added in v1.19.21 

func (s *JobDescriptor) SetStatusUpdateReason(v string) *JobDescriptor

SetStatusUpdateReason sets the StatusUpdateReason field's value.

func (*JobDescriptor) SetSuspendedCause added in v1.19.21 

func (s *JobDescriptor) SetSuspendedCause(v string) *JobDescriptor

SetSuspendedCause sets the SuspendedCause field's value.

func (*JobDescriptor) SetSuspendedDate added in v1.19.21 

func (s *JobDescriptor) SetSuspendedDate(v time.Time) *JobDescriptor

SetSuspendedDate sets the SuspendedDate field's value.

func (*JobDescriptor) SetTerminationDate added in v1.19.21 

func (s *JobDescriptor) SetTerminationDate(v time.Time) *JobDescriptor

SetTerminationDate sets the TerminationDate field's value.

func (JobDescriptor) String added in v1.19.21 

func (s JobDescriptor) String() string

String returns the string representation

type JobFailure added in v1.19.21 

type JobFailure struct {

	// The failure code, if any, for the specified job.
	FailureCode *string `min:"1" type:"string"`

	// The failure reason, if any, for the specified job.
	FailureReason *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (JobFailure) GoString added in v1.19.21 

func (s JobFailure) GoString() string

GoString returns the string representation

func (*JobFailure) SetFailureCode added in v1.19.21 

func (s *JobFailure) SetFailureCode(v string) *JobFailure

SetFailureCode sets the FailureCode field's value.

func (*JobFailure) SetFailureReason added in v1.19.21 

func (s *JobFailure) SetFailureReason(v string) *JobFailure

SetFailureReason sets the FailureReason field's value.

func (JobFailure) String added in v1.19.21 

func (s JobFailure) String() string

String returns the string representation

type JobListDescriptor added in v1.19.21 

type JobListDescriptor struct {

	// A timestamp indicating when the specified job was created.
	CreationTime *time.Time `type:"timestamp"`

	// The user-specified description that was included in the specified job's Create
	// Job request.
	Description *string `min:"1" type:"string"`

	// The ID for the specified job.
	JobId *string `min:"5" type:"string"`

	// The operation that the specified job is configured to run on each object
	// listed in the manifest.
	Operation *string `type:"string" enum:"OperationName"`

	// The current priority for the specified job.
	Priority *int64 `type:"integer"`

	// 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 `type:"structure"`

	// The specified job's current status.
	Status *string `type:"string" enum:"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 `type:"timestamp"`
	// contains filtered or unexported fields
}

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

func (JobListDescriptor) GoString added in v1.19.21 

func (s JobListDescriptor) GoString() string

GoString returns the string representation

func (*JobListDescriptor) SetCreationTime added in v1.19.21 

func (s *JobListDescriptor) SetCreationTime(v time.Time) *JobListDescriptor

SetCreationTime sets the CreationTime field's value.

func (*JobListDescriptor) SetDescription added in v1.19.21 

func (s *JobListDescriptor) SetDescription(v string) *JobListDescriptor

SetDescription sets the Description field's value.

func (*JobListDescriptor) SetJobId added in v1.19.21 

func (s *JobListDescriptor) SetJobId(v string) *JobListDescriptor

SetJobId sets the JobId field's value.

func (*JobListDescriptor) SetOperation added in v1.19.21 

func (s *JobListDescriptor) SetOperation(v string) *JobListDescriptor

SetOperation sets the Operation field's value.

func (*JobListDescriptor) SetPriority added in v1.19.21 

func (s *JobListDescriptor) SetPriority(v int64) *JobListDescriptor

SetPriority sets the Priority field's value.

func (*JobListDescriptor) SetProgressSummary added in v1.19.21 

func (s *JobListDescriptor) SetProgressSummary(v *JobProgressSummary) *JobListDescriptor

SetProgressSummary sets the ProgressSummary field's value.

func (*JobListDescriptor) SetStatus added in v1.19.21 

func (s *JobListDescriptor) SetStatus(v string) *JobListDescriptor

SetStatus sets the Status field's value.

func (*JobListDescriptor) SetTerminationDate added in v1.19.21 

func (s *JobListDescriptor) SetTerminationDate(v time.Time) *JobListDescriptor

SetTerminationDate sets the TerminationDate field's value.

func (JobListDescriptor) String added in v1.19.21 

func (s JobListDescriptor) String() string

String returns the string representation

type JobManifest added in v1.19.21 

type JobManifest struct {

	// Contains the information required to locate the specified job's manifest.
	//
	// Location is a required field
	Location *JobManifestLocation `type:"structure" required:"true"`

	// Describes the format of the specified job's manifest. If the manifest is
	// in CSV format, also describes the columns contained within the manifest.
	//
	// Spec is a required field
	Spec *JobManifestSpec `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains the configuration information for a job's manifest.

func (JobManifest) GoString added in v1.19.21 

func (s JobManifest) GoString() string

GoString returns the string representation

func (*JobManifest) SetLocation added in v1.19.21 

func (s *JobManifest) SetLocation(v *JobManifestLocation) *JobManifest

SetLocation sets the Location field's value.

func (*JobManifest) SetSpec added in v1.19.21 

func (s *JobManifest) SetSpec(v *JobManifestSpec) *JobManifest

SetSpec sets the Spec field's value.

func (JobManifest) String added in v1.19.21 

func (s JobManifest) String() string

String returns the string representation

func (*JobManifest) Validate added in v1.19.21 

func (s *JobManifest) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type JobManifestLocation added in v1.19.21 

type JobManifestLocation struct {

	// The ETag for the specified manifest object.
	//
	// ETag is a required field
	ETag *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) for a manifest object.
	//
	// ObjectArn is a required field
	ObjectArn *string `min:"1" type:"string" required:"true"`

	// The optional version ID to identify a specific version of the manifest object.
	ObjectVersionId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains the information required to locate a manifest object.

func (JobManifestLocation) GoString added in v1.19.21 

func (s JobManifestLocation) GoString() string

GoString returns the string representation

func (*JobManifestLocation) SetETag added in v1.19.21 

func (s *JobManifestLocation) SetETag(v string) *JobManifestLocation

SetETag sets the ETag field's value.

func (*JobManifestLocation) SetObjectArn added in v1.19.21 

func (s *JobManifestLocation) SetObjectArn(v string) *JobManifestLocation

SetObjectArn sets the ObjectArn field's value.

func (*JobManifestLocation) SetObjectVersionId added in v1.19.21 

func (s *JobManifestLocation) SetObjectVersionId(v string) *JobManifestLocation

SetObjectVersionId sets the ObjectVersionId field's value.

func (JobManifestLocation) String added in v1.19.21 

func (s JobManifestLocation) String() string

String returns the string representation

func (*JobManifestLocation) Validate added in v1.19.21 

func (s *JobManifestLocation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type JobManifestSpec added in v1.19.21 

type JobManifestSpec struct {

	// If the specified manifest object is in the S3BatchOperations_CSV_20180820
	// format, this element describes which columns contain the required data.
	Fields []*string `type:"list"`

	// Indicates which of the available formats the specified manifest uses.
	//
	// Format is a required field
	Format *string `type:"string" required:"true" enum:"JobManifestFormat"`
	// 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.

func (JobManifestSpec) GoString added in v1.19.21 

func (s JobManifestSpec) GoString() string

GoString returns the string representation

func (*JobManifestSpec) SetFields added in v1.19.21 

func (s *JobManifestSpec) SetFields(v []*string) *JobManifestSpec

SetFields sets the Fields field's value.

func (*JobManifestSpec) SetFormat added in v1.19.21 

func (s *JobManifestSpec) SetFormat(v string) *JobManifestSpec

SetFormat sets the Format field's value.

func (JobManifestSpec) String added in v1.19.21 

func (s JobManifestSpec) String() string

String returns the string representation

func (*JobManifestSpec) Validate added in v1.19.21 

func (s *JobManifestSpec) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type JobOperation added in v1.19.21 

type JobOperation struct {

	// Directs the specified job to invoke an AWS Lambda function on each object
	// in the manifest.
	LambdaInvoke *LambdaInvokeOperation `type:"structure"`

	// Directs the specified job to run an Initiate Glacier Restore call on each
	// object in the manifest.
	S3InitiateRestoreObject *S3InitiateRestoreObjectOperation `type:"structure"`

	// Directs the specified job to run a PUT Object acl call on each object in
	// the manifest.
	S3PutObjectAcl *S3SetObjectAclOperation `type:"structure"`

	// Directs the specified job to run a PUT Copy object call on each object in
	// the manifest.
	S3PutObjectCopy *S3CopyObjectOperation `type:"structure"`

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

	// Contains the configuration parameters for the Object Lock retention action
	// for an S3 Batch Operations job. Batch Operations passes each value through
	// to the underlying PutObjectRetention API. For more information, see Using
	// S3 Object Lock retention with S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html)
	// in the Amazon Simple Storage Service Developer Guide.
	S3PutObjectRetention *S3SetObjectRetentionOperation `type:"structure"`

	// Directs the specified job to run a PUT Object tagging call on each object
	// in the manifest.
	S3PutObjectTagging *S3SetObjectTaggingOperation `type:"structure"`
	// contains filtered or unexported fields
}

The operation that you want this job to perform on each 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 Simple Storage Service Developer Guide.

func (JobOperation) GoString added in v1.19.21 

func (s JobOperation) GoString() string

GoString returns the string representation

func (*JobOperation) SetLambdaInvoke added in v1.19.21 

func (s *JobOperation) SetLambdaInvoke(v *LambdaInvokeOperation) *JobOperation

SetLambdaInvoke sets the LambdaInvoke field's value.

func (*JobOperation) SetS3InitiateRestoreObject added in v1.19.21 

func (s *JobOperation) SetS3InitiateRestoreObject(v *S3InitiateRestoreObjectOperation) *JobOperation

SetS3InitiateRestoreObject sets the S3InitiateRestoreObject field's value.

func (*JobOperation) SetS3PutObjectAcl added in v1.19.21 

func (s *JobOperation) SetS3PutObjectAcl(v *S3SetObjectAclOperation) *JobOperation

SetS3PutObjectAcl sets the S3PutObjectAcl field's value.

func (*JobOperation) SetS3PutObjectCopy added in v1.19.21 

func (s *JobOperation) SetS3PutObjectCopy(v *S3CopyObjectOperation) *JobOperation

SetS3PutObjectCopy sets the S3PutObjectCopy field's value.

func (*JobOperation) SetS3PutObjectLegalHold added in v1.30.20 

func (s *JobOperation) SetS3PutObjectLegalHold(v *S3SetObjectLegalHoldOperation) *JobOperation

SetS3PutObjectLegalHold sets the S3PutObjectLegalHold field's value.

func (*JobOperation) SetS3PutObjectRetention added in v1.30.20 

func (s *JobOperation) SetS3PutObjectRetention(v *S3SetObjectRetentionOperation) *JobOperation

SetS3PutObjectRetention sets the S3PutObjectRetention field's value.

func (*JobOperation) SetS3PutObjectTagging added in v1.19.21 

func (s *JobOperation) SetS3PutObjectTagging(v *S3SetObjectTaggingOperation) *JobOperation

SetS3PutObjectTagging sets the S3PutObjectTagging field's value.

func (JobOperation) String added in v1.19.21 

func (s JobOperation) String() string

String returns the string representation

func (*JobOperation) Validate added in v1.19.21 

func (s *JobOperation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type JobProgressSummary added in v1.19.21 

type JobProgressSummary struct {
	NumberOfTasksFailed *int64 `type:"long"`

	NumberOfTasksSucceeded *int64 `type:"long"`

	TotalNumberOfTasks *int64 `type:"long"`
	// 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.

func (JobProgressSummary) GoString added in v1.19.21 

func (s JobProgressSummary) GoString() string

GoString returns the string representation

func (*JobProgressSummary) SetNumberOfTasksFailed added in v1.19.21 

func (s *JobProgressSummary) SetNumberOfTasksFailed(v int64) *JobProgressSummary

SetNumberOfTasksFailed sets the NumberOfTasksFailed field's value.

func (*JobProgressSummary) SetNumberOfTasksSucceeded added in v1.19.21 

func (s *JobProgressSummary) SetNumberOfTasksSucceeded(v int64) *JobProgressSummary

SetNumberOfTasksSucceeded sets the NumberOfTasksSucceeded field's value.

func (*JobProgressSummary) SetTotalNumberOfTasks added in v1.19.21 

func (s *JobProgressSummary) SetTotalNumberOfTasks(v int64) *JobProgressSummary

SetTotalNumberOfTasks sets the TotalNumberOfTasks field's value.

func (JobProgressSummary) String added in v1.19.21 

func (s JobProgressSummary) String() string

String returns the string representation

type JobReport added in v1.19.21 

type JobReport struct {

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

	// Indicates whether the specified job will generate a job-completion report.
	//
	// Enabled is a required field
	Enabled *bool `type:"boolean" required:"true"`

	// The format of the specified job-completion report.
	Format *string `type:"string" enum:"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 <prefix>/job-<job-id>/report.json.
	Prefix *string `min:"1" type:"string"`

	// Indicates whether the job-completion report will include details of all tasks
	// or only failed tasks.
	ReportScope *string `type:"string" enum:"JobReportScope"`
	// contains filtered or unexported fields
}

Contains the configuration parameters for a job-completion report.

func (JobReport) GoString added in v1.19.21 

func (s JobReport) GoString() string

GoString returns the string representation

func (*JobReport) SetBucket added in v1.19.21 

func (s *JobReport) SetBucket(v string) *JobReport

SetBucket sets the Bucket field's value.

func (*JobReport) SetEnabled added in v1.19.21 

func (s *JobReport) SetEnabled(v bool) *JobReport

SetEnabled sets the Enabled field's value.

func (*JobReport) SetFormat added in v1.19.21 

func (s *JobReport) SetFormat(v string) *JobReport

SetFormat sets the Format field's value.

func (*JobReport) SetPrefix added in v1.19.21 

func (s *JobReport) SetPrefix(v string) *JobReport

SetPrefix sets the Prefix field's value.

func (*JobReport) SetReportScope added in v1.19.21 

func (s *JobReport) SetReportScope(v string) *JobReport

SetReportScope sets the ReportScope field's value.

func (JobReport) String added in v1.19.21 

func (s JobReport) String() string

String returns the string representation

func (*JobReport) Validate added in v1.19.21 

func (s *JobReport) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LambdaInvokeOperation added in v1.19.21 

type LambdaInvokeOperation struct {

	// The Amazon Resource Name (ARN) for the AWS Lambda function that the specified
	// job will invoke for each object in the manifest.
	FunctionArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains the configuration parameters for a Lambda Invoke operation.

func (LambdaInvokeOperation) GoString added in v1.19.21 

func (s LambdaInvokeOperation) GoString() string

GoString returns the string representation

func (*LambdaInvokeOperation) SetFunctionArn added in v1.19.21 

func (s *LambdaInvokeOperation) SetFunctionArn(v string) *LambdaInvokeOperation

SetFunctionArn sets the FunctionArn field's value.

func (LambdaInvokeOperation) String added in v1.19.21 

func (s LambdaInvokeOperation) String() string

String returns the string representation

func (*LambdaInvokeOperation) Validate added in v1.19.21 

func (s *LambdaInvokeOperation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LifecycleConfiguration added in v1.35.0 

type LifecycleConfiguration struct {

	// A lifecycle rule for individual objects in an Outposts bucket.
	Rules []*LifecycleRule `locationNameList:"Rule" type:"list"`
	// contains filtered or unexported fields
}

The container for the Outposts bucket lifecycle configuration.

func (LifecycleConfiguration) GoString added in v1.35.0 

func (s LifecycleConfiguration) GoString() string

GoString returns the string representation

func (*LifecycleConfiguration) SetRules added in v1.35.0 

func (s *LifecycleConfiguration) SetRules(v []*LifecycleRule) *LifecycleConfiguration

SetRules sets the Rules field's value.

func (LifecycleConfiguration) String added in v1.35.0 

func (s LifecycleConfiguration) String() string

String returns the string representation

func (*LifecycleConfiguration) Validate added in v1.35.0 

func (s *LifecycleConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LifecycleExpiration added in v1.35.0 

type LifecycleExpiration struct {

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

	// Indicates the lifetime, in days, of the objects that are subject to the rule.
	// The value must be a non-zero positive integer.
	Days *int64 `type:"integer"`

	// 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 `type:"boolean"`
	// contains filtered or unexported fields
}

The container of the Outposts bucket lifecycle expiration.

func (LifecycleExpiration) GoString added in v1.35.0 

func (s LifecycleExpiration) GoString() string

GoString returns the string representation

func (*LifecycleExpiration) SetDate added in v1.35.0 

func (s *LifecycleExpiration) SetDate(v time.Time) *LifecycleExpiration

SetDate sets the Date field's value.

func (*LifecycleExpiration) SetDays added in v1.35.0 

func (s *LifecycleExpiration) SetDays(v int64) *LifecycleExpiration

SetDays sets the Days field's value.

func (*LifecycleExpiration) SetExpiredObjectDeleteMarker added in v1.35.0 

func (s *LifecycleExpiration) SetExpiredObjectDeleteMarker(v bool) *LifecycleExpiration

SetExpiredObjectDeleteMarker sets the ExpiredObjectDeleteMarker field's value.

func (LifecycleExpiration) String added in v1.35.0 

func (s LifecycleExpiration) String() string

String returns the string representation

type LifecycleRule added in v1.35.0 

type LifecycleRule struct {

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

	// 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 `type:"structure"`

	// The container for the filter of lifecycle rule.
	Filter *LifecycleRuleFilter `type:"structure"`

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

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

	// 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 `locationNameList:"NoncurrentVersionTransition" type:"list"`

	// If 'Enabled', the rule is currently being applied. If 'Disabled', the rule
	// is not currently being applied.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"ExpirationStatus"`

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

The container for the Outposts bucket lifecycle rule.

func (LifecycleRule) GoString added in v1.35.0 

func (s LifecycleRule) GoString() string

GoString returns the string representation

func (*LifecycleRule) SetAbortIncompleteMultipartUpload added in v1.35.0 

func (s *LifecycleRule) SetAbortIncompleteMultipartUpload(v *AbortIncompleteMultipartUpload) *LifecycleRule

SetAbortIncompleteMultipartUpload sets the AbortIncompleteMultipartUpload field's value.

func (*LifecycleRule) SetExpiration added in v1.35.0 

func (s *LifecycleRule) SetExpiration(v *LifecycleExpiration) *LifecycleRule

SetExpiration sets the Expiration field's value.

func (*LifecycleRule) SetFilter added in v1.35.0 

func (s *LifecycleRule) SetFilter(v *LifecycleRuleFilter) *LifecycleRule

SetFilter sets the Filter field's value.

func (*LifecycleRule) SetID added in v1.35.0 

func (s *LifecycleRule) SetID(v string) *LifecycleRule

SetID sets the ID field's value.

func (*LifecycleRule) SetNoncurrentVersionExpiration added in v1.35.0 

func (s *LifecycleRule) SetNoncurrentVersionExpiration(v *NoncurrentVersionExpiration) *LifecycleRule

SetNoncurrentVersionExpiration sets the NoncurrentVersionExpiration field's value.

func (*LifecycleRule) SetNoncurrentVersionTransitions added in v1.35.0 

func (s *LifecycleRule) SetNoncurrentVersionTransitions(v []*NoncurrentVersionTransition) *LifecycleRule

SetNoncurrentVersionTransitions sets the NoncurrentVersionTransitions field's value.

func (*LifecycleRule) SetStatus added in v1.35.0 

func (s *LifecycleRule) SetStatus(v string) *LifecycleRule

SetStatus sets the Status field's value.

func (*LifecycleRule) SetTransitions added in v1.35.0 

func (s *LifecycleRule) SetTransitions(v []*Transition) *LifecycleRule

SetTransitions sets the Transitions field's value.

func (LifecycleRule) String added in v1.35.0 

func (s LifecycleRule) String() string

String returns the string representation

func (*LifecycleRule) Validate added in v1.35.0 

func (s *LifecycleRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LifecycleRuleAndOperator added in v1.35.0 

type LifecycleRuleAndOperator struct {

	// Prefix identifying one or more objects to which the rule applies.
	Prefix *string `type:"string"`

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

The container for the Outposts bucket lifecycle rule and operator.

func (LifecycleRuleAndOperator) GoString added in v1.35.0 

func (s LifecycleRuleAndOperator) GoString() string

GoString returns the string representation

func (*LifecycleRuleAndOperator) SetPrefix added in v1.35.0 

func (s *LifecycleRuleAndOperator) SetPrefix(v string) *LifecycleRuleAndOperator

SetPrefix sets the Prefix field's value.

func (*LifecycleRuleAndOperator) SetTags added in v1.35.0 

func (s *LifecycleRuleAndOperator) SetTags(v []*S3Tag) *LifecycleRuleAndOperator

SetTags sets the Tags field's value.

func (LifecycleRuleAndOperator) String added in v1.35.0 

func (s LifecycleRuleAndOperator) String() string

String returns the string representation

func (*LifecycleRuleAndOperator) Validate added in v1.35.0 

func (s *LifecycleRuleAndOperator) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LifecycleRuleFilter added in v1.35.0 

type LifecycleRuleFilter struct {

	// The container for the AND condition for the lifecycle rule.
	And *LifecycleRuleAndOperator `type:"structure"`

	// Prefix identifying one or more objects to which the rule applies.
	Prefix *string `type:"string"`

	Tag *S3Tag `type:"structure"`
	// contains filtered or unexported fields
}

The container for the filter of the lifecycle rule.

func (LifecycleRuleFilter) GoString added in v1.35.0 

func (s LifecycleRuleFilter) GoString() string

GoString returns the string representation

func (*LifecycleRuleFilter) SetAnd added in v1.35.0 

func (s *LifecycleRuleFilter) SetAnd(v *LifecycleRuleAndOperator) *LifecycleRuleFilter

SetAnd sets the And field's value.

func (*LifecycleRuleFilter) SetPrefix added in v1.35.0 

func (s *LifecycleRuleFilter) SetPrefix(v string) *LifecycleRuleFilter

SetPrefix sets the Prefix field's value.

func (*LifecycleRuleFilter) SetTag added in v1.35.0 

func (s *LifecycleRuleFilter) SetTag(v *S3Tag) *LifecycleRuleFilter

SetTag sets the Tag field's value.

func (LifecycleRuleFilter) String added in v1.35.0 

func (s LifecycleRuleFilter) String() string

String returns the string representation

func (*LifecycleRuleFilter) Validate added in v1.35.0 

func (s *LifecycleRuleFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAccessPointsInput added in v1.25.46 

type ListAccessPointsInput struct {

	// The AWS account ID for owner of the bucket whose access points you want to
	// list.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The name of the bucket whose associated access points you want to list.
	//
	// For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format
	// arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>.
	// For example, to access the bucket reports through outpost my-outpost owned
	// by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports.
	// The value must be URL encoded.
	Bucket *string `location:"querystring" locationName:"bucket" min:"3" type:"string"`

	// The maximum number of access points that you want to include in the list.
	// If the specified bucket has more than this number of access points, then
	// the response will include a continuation token in the NextToken field that
	// you can use to retrieve the next page of access points.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

	// A continuation token. If a previous call to ListAccessPoints returned a continuation
	// token in the NextToken field, then providing that value here causes Amazon
	// S3 to retrieve the next page of results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAccessPointsInput) GoString added in v1.25.46 

func (s ListAccessPointsInput) GoString() string

GoString returns the string representation

func (*ListAccessPointsInput) SetAccountId added in v1.25.46 

func (s *ListAccessPointsInput) SetAccountId(v string) *ListAccessPointsInput

SetAccountId sets the AccountId field's value.

func (*ListAccessPointsInput) SetBucket added in v1.25.46 

func (s *ListAccessPointsInput) SetBucket(v string) *ListAccessPointsInput

SetBucket sets the Bucket field's value.

func (*ListAccessPointsInput) SetMaxResults added in v1.25.46 

func (s *ListAccessPointsInput) SetMaxResults(v int64) *ListAccessPointsInput

SetMaxResults sets the MaxResults field's value.

func (*ListAccessPointsInput) SetNextToken added in v1.25.46 

func (s *ListAccessPointsInput) SetNextToken(v string) *ListAccessPointsInput

SetNextToken sets the NextToken field's value.

func (ListAccessPointsInput) String added in v1.25.46 

func (s ListAccessPointsInput) String() string

String returns the string representation

func (*ListAccessPointsInput) Validate added in v1.25.46 

func (s *ListAccessPointsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAccessPointsOutput added in v1.25.46 

type ListAccessPointsOutput struct {

	// Contains identification and configuration information for one or more access
	// points associated with the specified bucket.
	AccessPointList []*AccessPoint `locationNameList:"AccessPoint" type:"list"`

	// If the specified bucket has more access points than can be returned in one
	// call to this API, this field contains a continuation token that you can provide
	// in subsequent calls to this API to retrieve additional access points.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAccessPointsOutput) GoString added in v1.25.46 

func (s ListAccessPointsOutput) GoString() string

GoString returns the string representation

func (*ListAccessPointsOutput) SetAccessPointList added in v1.25.46 

func (s *ListAccessPointsOutput) SetAccessPointList(v []*AccessPoint) *ListAccessPointsOutput

SetAccessPointList sets the AccessPointList field's value.

func (*ListAccessPointsOutput) SetNextToken added in v1.25.46 

func (s *ListAccessPointsOutput) SetNextToken(v string) *ListAccessPointsOutput

SetNextToken sets the NextToken field's value.

func (ListAccessPointsOutput) String added in v1.25.46 

func (s ListAccessPointsOutput) String() string

String returns the string representation

type ListJobsInput added in v1.19.21 

type ListJobsInput struct {

	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The List Jobs request returns jobs that match the statuses listed in this
	// element.
	JobStatuses []*string `location:"querystring" locationName:"jobStatuses" type:"list"`

	// The maximum number of jobs that Amazon S3 will include in the List Jobs response.
	// If there are more jobs than this number, the response will include a pagination
	// token in the NextToken field to enable you to retrieve the next page of results.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

	// A pagination token to request the next page of results. Use the token that
	// Amazon S3 returned in the NextToken element of the ListJobsResult from the
	// previous List Jobs request.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListJobsInput) GoString added in v1.19.21 

func (s ListJobsInput) GoString() string

GoString returns the string representation

func (*ListJobsInput) SetAccountId added in v1.19.21 

func (s *ListJobsInput) SetAccountId(v string) *ListJobsInput

SetAccountId sets the AccountId field's value.

func (*ListJobsInput) SetJobStatuses added in v1.19.21 

func (s *ListJobsInput) SetJobStatuses(v []*string) *ListJobsInput

SetJobStatuses sets the JobStatuses field's value.

func (*ListJobsInput) SetMaxResults added in v1.19.21 

func (s *ListJobsInput) SetMaxResults(v int64) *ListJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListJobsInput) SetNextToken added in v1.19.21 

func (s *ListJobsInput) SetNextToken(v string) *ListJobsInput

SetNextToken sets the NextToken field's value.

func (ListJobsInput) String added in v1.19.21 

func (s ListJobsInput) String() string

String returns the string representation

func (*ListJobsInput) Validate added in v1.19.21 

func (s *ListJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListJobsOutput added in v1.19.21 

type ListJobsOutput struct {

	// The list of current jobs and jobs that have ended within the last 30 days.
	Jobs []*JobListDescriptor `type:"list"`

	// If the List Jobs request produced more than the maximum number of results,
	// you can pass this value into a subsequent List Jobs request in order to retrieve
	// the next page of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListJobsOutput) GoString added in v1.19.21 

func (s ListJobsOutput) GoString() string

GoString returns the string representation

func (*ListJobsOutput) SetJobs added in v1.19.21 

func (s *ListJobsOutput) SetJobs(v []*JobListDescriptor) *ListJobsOutput

SetJobs sets the Jobs field's value.

func (*ListJobsOutput) SetNextToken added in v1.19.21 

func (s *ListJobsOutput) SetNextToken(v string) *ListJobsOutput

SetNextToken sets the NextToken field's value.

func (ListJobsOutput) String added in v1.19.21 

func (s ListJobsOutput) String() string

String returns the string representation

type ListRegionalBucketsInput added in v1.35.0 

type ListRegionalBucketsInput struct {

	// The AWS account ID of the Outposts bucket.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// The ID of the AWS Outposts.
	//
	// This is required by Amazon S3 on Outposts buckets.
	OutpostId *string `location:"header" locationName:"x-amz-outpost-id" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListRegionalBucketsInput) GoString added in v1.35.0 

func (s ListRegionalBucketsInput) GoString() string

GoString returns the string representation

func (*ListRegionalBucketsInput) SetAccountId added in v1.35.0 

func (s *ListRegionalBucketsInput) SetAccountId(v string) *ListRegionalBucketsInput

SetAccountId sets the AccountId field's value.

func (*ListRegionalBucketsInput) SetMaxResults added in v1.35.0 

func (s *ListRegionalBucketsInput) SetMaxResults(v int64) *ListRegionalBucketsInput

SetMaxResults sets the MaxResults field's value.

func (*ListRegionalBucketsInput) SetNextToken added in v1.35.0 

func (s *ListRegionalBucketsInput) SetNextToken(v string) *ListRegionalBucketsInput

SetNextToken sets the NextToken field's value.

func (*ListRegionalBucketsInput) SetOutpostId added in v1.35.0 

func (s *ListRegionalBucketsInput) SetOutpostId(v string) *ListRegionalBucketsInput

SetOutpostId sets the OutpostId field's value.

func (ListRegionalBucketsInput) String added in v1.35.0 

func (s ListRegionalBucketsInput) String() string

String returns the string representation

func (*ListRegionalBucketsInput) Validate added in v1.35.0 

func (s *ListRegionalBucketsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListRegionalBucketsOutput added in v1.35.0 

type ListRegionalBucketsOutput struct {

	// NextToken is sent when isTruncated is true, which means there are more buckets
	// that can be listed. The next list requests to Amazon S3 can be continued
	// with this NextToken. NextToken is obfuscated and is not a real key.
	NextToken *string `min:"1" type:"string"`

	RegionalBucketList []*RegionalBucket `locationNameList:"RegionalBucket" type:"list"`
	// contains filtered or unexported fields
}

func (ListRegionalBucketsOutput) GoString added in v1.35.0 

func (s ListRegionalBucketsOutput) GoString() string

GoString returns the string representation

func (*ListRegionalBucketsOutput) SetNextToken added in v1.35.0 

func (s *ListRegionalBucketsOutput) SetNextToken(v string) *ListRegionalBucketsOutput

SetNextToken sets the NextToken field's value.

func (*ListRegionalBucketsOutput) SetRegionalBucketList added in v1.35.0 

func (s *ListRegionalBucketsOutput) SetRegionalBucketList(v []*RegionalBucket) *ListRegionalBucketsOutput

SetRegionalBucketList sets the RegionalBucketList field's value.

func (ListRegionalBucketsOutput) String added in v1.35.0 

func (s ListRegionalBucketsOutput) String() string

String returns the string representation

type NoncurrentVersionExpiration added in v1.35.0 

type NoncurrentVersionExpiration struct {

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

The container of the noncurrent version expiration.

func (NoncurrentVersionExpiration) GoString added in v1.35.0 

func (s NoncurrentVersionExpiration) GoString() string

GoString returns the string representation

func (*NoncurrentVersionExpiration) SetNoncurrentDays added in v1.35.0 

func (s *NoncurrentVersionExpiration) SetNoncurrentDays(v int64) *NoncurrentVersionExpiration

SetNoncurrentDays sets the NoncurrentDays field's value.

func (NoncurrentVersionExpiration) String added in v1.35.0 

func (s NoncurrentVersionExpiration) String() string

String returns the string representation

type NoncurrentVersionTransition added in v1.35.0 

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 Simple Storage Service Developer Guide.
	NoncurrentDays *int64 `type:"integer"`

	// The class of storage used to store the object.
	StorageClass *string `type:"string" enum:"TransitionStorageClass"`
	// contains filtered or unexported fields
}

The container for the noncurrent version transition.

func (NoncurrentVersionTransition) GoString added in v1.35.0 

func (s NoncurrentVersionTransition) GoString() string

GoString returns the string representation

func (*NoncurrentVersionTransition) SetNoncurrentDays added in v1.35.0 

func (s *NoncurrentVersionTransition) SetNoncurrentDays(v int64) *NoncurrentVersionTransition

SetNoncurrentDays sets the NoncurrentDays field's value.

func (*NoncurrentVersionTransition) SetStorageClass added in v1.35.0 

func (s *NoncurrentVersionTransition) SetStorageClass(v string) *NoncurrentVersionTransition

SetStorageClass sets the StorageClass field's value.

func (NoncurrentVersionTransition) String added in v1.35.0 

func (s NoncurrentVersionTransition) String() string

String returns the string representation

type PolicyStatus added in v1.25.46 

type PolicyStatus struct {
	IsPublic *bool `locationName:"IsPublic" type:"boolean"`
	// 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 Simple Storage Service Developer Guide.

func (PolicyStatus) GoString added in v1.25.46 

func (s PolicyStatus) GoString() string

GoString returns the string representation

func (*PolicyStatus) SetIsPublic added in v1.25.46 

func (s *PolicyStatus) SetIsPublic(v bool) *PolicyStatus

SetIsPublic sets the IsPublic field's value.

func (PolicyStatus) String added in v1.25.46 

func (s PolicyStatus) String() string

String returns the string representation

type PublicAccessBlockConfiguration 

type PublicAccessBlockConfiguration struct {

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

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

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

	// 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 AWS services and authorized users within this
	// account.
	//
	// Enabling this setting doesn't affect previously stored bucket policies, except
	// that public and cross-account access within any public bucket policy, including
	// non-public delegation to specific accounts, is blocked.
	//
	// This is not supported for Amazon S3 on Outposts.
	RestrictPublicBuckets *bool `locationName:"RestrictPublicBuckets" type:"boolean"`
	// contains filtered or unexported fields
}

The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. 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 Simple Storage Service Developer Guide.

This is not supported for Amazon S3 on Outposts.

func (PublicAccessBlockConfiguration) GoString 

func (s PublicAccessBlockConfiguration) GoString() string

GoString returns the string representation

func (*PublicAccessBlockConfiguration) SetBlockPublicAcls 

func (s *PublicAccessBlockConfiguration) SetBlockPublicAcls(v bool) *PublicAccessBlockConfiguration

SetBlockPublicAcls sets the BlockPublicAcls field's value.

func (*PublicAccessBlockConfiguration) SetBlockPublicPolicy 

func (s *PublicAccessBlockConfiguration) SetBlockPublicPolicy(v bool) *PublicAccessBlockConfiguration

SetBlockPublicPolicy sets the BlockPublicPolicy field's value.

func (*PublicAccessBlockConfiguration) SetIgnorePublicAcls 

func (s *PublicAccessBlockConfiguration) SetIgnorePublicAcls(v bool) *PublicAccessBlockConfiguration

SetIgnorePublicAcls sets the IgnorePublicAcls field's value.

func (*PublicAccessBlockConfiguration) SetRestrictPublicBuckets 

func (s *PublicAccessBlockConfiguration) SetRestrictPublicBuckets(v bool) *PublicAccessBlockConfiguration

SetRestrictPublicBuckets sets the RestrictPublicBuckets field's value.

func (PublicAccessBlockConfiguration) String 

func (s PublicAccessBlockConfiguration) String() string

String returns the string representation

type PutAccessPointPolicyInput added in v1.25.46 

type PutAccessPointPolicyInput struct {

	// The AWS account ID for owner of the bucket associated with the specified
	// access point.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The name of the access point that you want to associate with the specified
	// policy.
	//
	// For Amazon S3 on Outposts specify the ARN of the access point accessed in
	// the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>.
	// For example, to access the access point reports-ap through outpost my-outpost
	// owned by account 123456789012 in Region us-west-2, use the URL encoding of
	// arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap.
	// The value must be URL encoded.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"name" min:"3" type:"string" required:"true"`

	// The policy that you want to apply to the specified access point. For more
	// information about access point policies, see Managing Data Access with Amazon
	// S3 Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Policy is a required field
	Policy *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutAccessPointPolicyInput) GoString added in v1.25.46 

func (s PutAccessPointPolicyInput) GoString() string

GoString returns the string representation

func (*PutAccessPointPolicyInput) SetAccountId added in v1.25.46 

func (s *PutAccessPointPolicyInput) SetAccountId(v string) *PutAccessPointPolicyInput

SetAccountId sets the AccountId field's value.

func (*PutAccessPointPolicyInput) SetName added in v1.25.46 

func (s *PutAccessPointPolicyInput) SetName(v string) *PutAccessPointPolicyInput

SetName sets the Name field's value.

func (*PutAccessPointPolicyInput) SetPolicy added in v1.25.46 

func (s *PutAccessPointPolicyInput) SetPolicy(v string) *PutAccessPointPolicyInput

SetPolicy sets the Policy field's value.

func (PutAccessPointPolicyInput) String added in v1.25.46 

func (s PutAccessPointPolicyInput) String() string

String returns the string representation

func (*PutAccessPointPolicyInput) Validate added in v1.25.46 

func (s *PutAccessPointPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutAccessPointPolicyOutput added in v1.25.46 

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

func (PutAccessPointPolicyOutput) GoString added in v1.25.46 

func (s PutAccessPointPolicyOutput) GoString() string

GoString returns the string representation

func (PutAccessPointPolicyOutput) String added in v1.25.46 

func (s PutAccessPointPolicyOutput) String() string

String returns the string representation

type PutBucketLifecycleConfigurationInput added in v1.35.0 

type PutBucketLifecycleConfigurationInput struct {

	// The AWS account ID of the Outposts bucket.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The name of the bucket for which to set the configuration.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"name" min:"3" type:"string" required:"true"`

	// Container for lifecycle rules. You can add as many as 1,000 rules.
	LifecycleConfiguration *LifecycleConfiguration `locationName:"LifecycleConfiguration" type:"structure" xmlURI:"http://awss3control.amazonaws.com/doc/2018-08-20/"`
	// contains filtered or unexported fields
}

func (PutBucketLifecycleConfigurationInput) GoString added in v1.35.0 

func (s PutBucketLifecycleConfigurationInput) GoString() string

GoString returns the string representation

func (*PutBucketLifecycleConfigurationInput) SetAccountId added in v1.35.0 

func (s *PutBucketLifecycleConfigurationInput) SetAccountId(v string) *PutBucketLifecycleConfigurationInput

SetAccountId sets the AccountId field's value.

func (*PutBucketLifecycleConfigurationInput) SetBucket added in v1.35.0 

func (s *PutBucketLifecycleConfigurationInput) SetBucket(v string) *PutBucketLifecycleConfigurationInput

SetBucket sets the Bucket field's value.

func (*PutBucketLifecycleConfigurationInput) SetLifecycleConfiguration added in v1.35.0 

func (s *PutBucketLifecycleConfigurationInput) SetLifecycleConfiguration(v *LifecycleConfiguration) *PutBucketLifecycleConfigurationInput

SetLifecycleConfiguration sets the LifecycleConfiguration field's value.

func (PutBucketLifecycleConfigurationInput) String added in v1.35.0 

func (s PutBucketLifecycleConfigurationInput) String() string

String returns the string representation

func (*PutBucketLifecycleConfigurationInput) Validate added in v1.35.0 

func (s *PutBucketLifecycleConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutBucketLifecycleConfigurationOutput added in v1.35.0 

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

func (PutBucketLifecycleConfigurationOutput) GoString added in v1.35.0 

func (s PutBucketLifecycleConfigurationOutput) GoString() string

GoString returns the string representation

func (PutBucketLifecycleConfigurationOutput) String added in v1.35.0 

func (s PutBucketLifecycleConfigurationOutput) String() string

String returns the string representation

type PutBucketPolicyInput added in v1.35.0 

type PutBucketPolicyInput struct {

	// The AWS account ID of the Outposts bucket.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The ARN of the bucket.
	//
	// For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format
	// arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>.
	// For example, to access the bucket reports through outpost my-outpost owned
	// by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports.
	// The value must be URL encoded.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"name" min:"3" type:"string" required:"true"`

	// Set this parameter to true to confirm that you want to remove your permissions
	// to change this bucket policy in the future.
	//
	// This is not supported by Amazon S3 on Outposts buckets.
	ConfirmRemoveSelfBucketAccess *bool `location:"header" locationName:"x-amz-confirm-remove-self-bucket-access" type:"boolean"`

	// The bucket policy as a JSON document.
	//
	// Policy is a required field
	Policy *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutBucketPolicyInput) GoString added in v1.35.0 

func (s PutBucketPolicyInput) GoString() string

GoString returns the string representation

func (*PutBucketPolicyInput) SetAccountId added in v1.35.0 

func (s *PutBucketPolicyInput) SetAccountId(v string) *PutBucketPolicyInput

SetAccountId sets the AccountId field's value.

func (*PutBucketPolicyInput) SetBucket added in v1.35.0 

func (s *PutBucketPolicyInput) SetBucket(v string) *PutBucketPolicyInput

SetBucket sets the Bucket field's value.

func (*PutBucketPolicyInput) SetConfirmRemoveSelfBucketAccess added in v1.35.0 

func (s *PutBucketPolicyInput) SetConfirmRemoveSelfBucketAccess(v bool) *PutBucketPolicyInput

SetConfirmRemoveSelfBucketAccess sets the ConfirmRemoveSelfBucketAccess field's value.

func (*PutBucketPolicyInput) SetPolicy added in v1.35.0 

func (s *PutBucketPolicyInput) SetPolicy(v string) *PutBucketPolicyInput

SetPolicy sets the Policy field's value.

func (PutBucketPolicyInput) String added in v1.35.0 

func (s PutBucketPolicyInput) String() string

String returns the string representation

func (*PutBucketPolicyInput) Validate added in v1.35.0 

func (s *PutBucketPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutBucketPolicyOutput added in v1.35.0 

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

func (PutBucketPolicyOutput) GoString added in v1.35.0 

func (s PutBucketPolicyOutput) GoString() string

GoString returns the string representation

func (PutBucketPolicyOutput) String added in v1.35.0 

func (s PutBucketPolicyOutput) String() string

String returns the string representation

type PutBucketTaggingInput added in v1.35.0 

type PutBucketTaggingInput struct {

	// The AWS account ID of the Outposts bucket.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the bucket.
	//
	// For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format
	// arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>.
	// For example, to access the bucket reports through outpost my-outpost owned
	// by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports.
	// The value must be URL encoded.
	//
	// Bucket is a required field
	Bucket *string `location:"uri" locationName:"name" min:"3" type:"string" required:"true"`

	// Tagging is a required field
	Tagging *Tagging `locationName:"Tagging" type:"structure" required:"true" xmlURI:"http://awss3control.amazonaws.com/doc/2018-08-20/"`
	// contains filtered or unexported fields
}

func (PutBucketTaggingInput) GoString added in v1.35.0 

func (s PutBucketTaggingInput) GoString() string

GoString returns the string representation

func (*PutBucketTaggingInput) SetAccountId added in v1.35.0 

func (s *PutBucketTaggingInput) SetAccountId(v string) *PutBucketTaggingInput

SetAccountId sets the AccountId field's value.

func (*PutBucketTaggingInput) SetBucket added in v1.35.0 

func (s *PutBucketTaggingInput) SetBucket(v string) *PutBucketTaggingInput

SetBucket sets the Bucket field's value.

func (*PutBucketTaggingInput) SetTagging added in v1.35.0 

func (s *PutBucketTaggingInput) SetTagging(v *Tagging) *PutBucketTaggingInput

SetTagging sets the Tagging field's value.

func (PutBucketTaggingInput) String added in v1.35.0 

func (s PutBucketTaggingInput) String() string

String returns the string representation

func (*PutBucketTaggingInput) Validate added in v1.35.0 

func (s *PutBucketTaggingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutBucketTaggingOutput added in v1.35.0 

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

func (PutBucketTaggingOutput) GoString added in v1.35.0 

func (s PutBucketTaggingOutput) GoString() string

GoString returns the string representation

func (PutBucketTaggingOutput) String added in v1.35.0 

func (s PutBucketTaggingOutput) String() string

String returns the string representation

type PutJobTaggingInput added in v1.29.25 

type PutJobTaggingInput struct {

	// The AWS account ID associated with the S3 Batch Operations job.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The ID for the S3 Batch Operations job whose tags you want to replace.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"id" min:"5" type:"string" required:"true"`

	// The set of tags to associate with the S3 Batch Operations job.
	//
	// Tags is a required field
	Tags []*S3Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (PutJobTaggingInput) GoString added in v1.29.25 

func (s PutJobTaggingInput) GoString() string

GoString returns the string representation

func (*PutJobTaggingInput) SetAccountId added in v1.29.25 

func (s *PutJobTaggingInput) SetAccountId(v string) *PutJobTaggingInput

SetAccountId sets the AccountId field's value.

func (*PutJobTaggingInput) SetJobId added in v1.29.25 

func (s *PutJobTaggingInput) SetJobId(v string) *PutJobTaggingInput

SetJobId sets the JobId field's value.

func (*PutJobTaggingInput) SetTags added in v1.29.25 

func (s *PutJobTaggingInput) SetTags(v []*S3Tag) *PutJobTaggingInput

SetTags sets the Tags field's value.

func (PutJobTaggingInput) String added in v1.29.25 

func (s PutJobTaggingInput) String() string

String returns the string representation

func (*PutJobTaggingInput) Validate added in v1.29.25 

func (s *PutJobTaggingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutJobTaggingOutput added in v1.29.25 

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

func (PutJobTaggingOutput) GoString added in v1.29.25 

func (s PutJobTaggingOutput) GoString() string

GoString returns the string representation

func (PutJobTaggingOutput) String added in v1.29.25 

func (s PutJobTaggingOutput) String() string

String returns the string representation

type PutPublicAccessBlockInput 

type PutPublicAccessBlockInput struct {

	// The account ID for the AWS account whose PublicAccessBlock configuration
	// you want to set.
	//
	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The PublicAccessBlock configuration that you want to apply to the specified
	// AWS account.
	//
	// PublicAccessBlockConfiguration is a required field
	PublicAccessBlockConfiguration *PublicAccessBlockConfiguration `` /* 137-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (PutPublicAccessBlockInput) GoString 

func (s PutPublicAccessBlockInput) GoString() string

GoString returns the string representation

func (*PutPublicAccessBlockInput) SetAccountId 

func (s *PutPublicAccessBlockInput) SetAccountId(v string) *PutPublicAccessBlockInput

SetAccountId sets the AccountId field's value.

func (*PutPublicAccessBlockInput) SetPublicAccessBlockConfiguration 

func (s *PutPublicAccessBlockInput) SetPublicAccessBlockConfiguration(v *PublicAccessBlockConfiguration) *PutPublicAccessBlockInput

SetPublicAccessBlockConfiguration sets the PublicAccessBlockConfiguration field's value.

func (PutPublicAccessBlockInput) String 

func (s PutPublicAccessBlockInput) String() string

String returns the string representation

func (*PutPublicAccessBlockInput) Validate 

func (s *PutPublicAccessBlockInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutPublicAccessBlockOutput 

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

func (PutPublicAccessBlockOutput) GoString 

func (s PutPublicAccessBlockOutput) GoString() string

GoString returns the string representation

func (PutPublicAccessBlockOutput) String 

func (s PutPublicAccessBlockOutput) String() string

String returns the string representation

type RegionalBucket added in v1.35.0 

type RegionalBucket struct {

	// Bucket is a required field
	Bucket *string `min:"3" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) for the regional bucket.
	BucketArn *string `min:"4" type:"string"`

	// The creation date of the regional bucket
	//
	// CreationDate is a required field
	CreationDate *time.Time `type:"timestamp" required:"true"`

	// The AWS Outposts ID of the regional bucket.
	OutpostId *string `min:"1" type:"string"`

	// PublicAccessBlockEnabled is a required field
	PublicAccessBlockEnabled *bool `type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

The container for the regional bucket.

func (RegionalBucket) GoString added in v1.35.0 

func (s RegionalBucket) GoString() string

GoString returns the string representation

func (*RegionalBucket) SetBucket added in v1.35.0 

func (s *RegionalBucket) SetBucket(v string) *RegionalBucket

SetBucket sets the Bucket field's value.

func (*RegionalBucket) SetBucketArn added in v1.35.0 

func (s *RegionalBucket) SetBucketArn(v string) *RegionalBucket

SetBucketArn sets the BucketArn field's value.

func (*RegionalBucket) SetCreationDate added in v1.35.0 

func (s *RegionalBucket) SetCreationDate(v time.Time) *RegionalBucket

SetCreationDate sets the CreationDate field's value.

func (*RegionalBucket) SetOutpostId added in v1.35.0 

func (s *RegionalBucket) SetOutpostId(v string) *RegionalBucket

SetOutpostId sets the OutpostId field's value.

func (*RegionalBucket) SetPublicAccessBlockEnabled added in v1.35.0 

func (s *RegionalBucket) SetPublicAccessBlockEnabled(v bool) *RegionalBucket

SetPublicAccessBlockEnabled sets the PublicAccessBlockEnabled field's value.

func (RegionalBucket) String added in v1.35.0 

func (s RegionalBucket) String() string

String returns the string representation

type S3AccessControlList added in v1.19.21 

type S3AccessControlList struct {
	Grants []*S3Grant `type:"list"`

	// Owner is a required field
	Owner *S3ObjectOwner `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (S3AccessControlList) GoString added in v1.19.21 

func (s S3AccessControlList) GoString() string

GoString returns the string representation

func (*S3AccessControlList) SetGrants added in v1.19.21 

func (s *S3AccessControlList) SetGrants(v []*S3Grant) *S3AccessControlList

SetGrants sets the Grants field's value.

func (*S3AccessControlList) SetOwner added in v1.19.21 

func (s *S3AccessControlList) SetOwner(v *S3ObjectOwner) *S3AccessControlList

SetOwner sets the Owner field's value.

func (S3AccessControlList) String added in v1.19.21 

func (s S3AccessControlList) String() string

String returns the string representation

func (*S3AccessControlList) Validate added in v1.19.21 

func (s *S3AccessControlList) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3AccessControlPolicy added in v1.19.21 

type S3AccessControlPolicy struct {
	AccessControlList *S3AccessControlList `type:"structure"`

	CannedAccessControlList *string `type:"string" enum:"S3CannedAccessControlList"`
	// contains filtered or unexported fields
}

func (S3AccessControlPolicy) GoString added in v1.19.21 

func (s S3AccessControlPolicy) GoString() string

GoString returns the string representation

func (*S3AccessControlPolicy) SetAccessControlList added in v1.19.21 

func (s *S3AccessControlPolicy) SetAccessControlList(v *S3AccessControlList) *S3AccessControlPolicy

SetAccessControlList sets the AccessControlList field's value.

func (*S3AccessControlPolicy) SetCannedAccessControlList added in v1.19.21 

func (s *S3AccessControlPolicy) SetCannedAccessControlList(v string) *S3AccessControlPolicy

SetCannedAccessControlList sets the CannedAccessControlList field's value.

func (S3AccessControlPolicy) String added in v1.19.21 

func (s S3AccessControlPolicy) String() string

String returns the string representation

func (*S3AccessControlPolicy) Validate added in v1.19.21 

func (s *S3AccessControlPolicy) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3Control 

type S3Control struct {
	*client.Client
}

S3Control provides the API operation methods for making requests to AWS S3 Control. See this package's package overview docs for details on the service.

S3Control methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *S3Control

New creates a new instance of the S3Control client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a S3Control client from just a session.
svc := s3control.New(mySession)

// Create a S3Control client with additional configuration
svc := s3control.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*S3Control) CreateAccessPoint added in v1.25.46 

func (c *S3Control) CreateAccessPoint(input *CreateAccessPointInput) (*CreateAccessPointOutput, error)

CreateAccessPoint API operation for AWS S3 Control.

Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points.html) in the Amazon Simple Storage Service Developer Guide.

Using this action with Amazon S3 on Outposts

This action:

  • Requires a virtual private cloud (VPC) configuration as S3 on Outposts only supports VPC style access points.

  • Does not support ACL on S3 on Outposts buckets.

  • Does not support Public Access on S3 on Outposts buckets.

  • Does not support object lock for S3 on Outposts buckets.

For more information, see Using Amazon S3 on Outposts (AmazonS3/latest/dev/S3onOutposts.html) in the Amazon Simple Storage Service Developer Guide .

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example (https://docs.aws.amazon.com/AmazonS3/latest/API/API__control_CreateAccessPoint.html#API_control_CreateAccessPoint_Examples) section below.

The following actions are related to CreateAccessPoint:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation CreateAccessPoint for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/CreateAccessPoint

func (*S3Control) CreateAccessPointRequest added in v1.25.46 

func (c *S3Control) CreateAccessPointRequest(input *CreateAccessPointInput) (req *request.Request, output *CreateAccessPointOutput)

CreateAccessPointRequest generates a "aws/request.Request" representing the client's request for the CreateAccessPoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAccessPoint for more information on using the CreateAccessPoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateAccessPointRequest method.
req, resp := client.CreateAccessPointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/CreateAccessPoint

func (*S3Control) CreateAccessPointWithContext added in v1.25.46 

func (c *S3Control) CreateAccessPointWithContext(ctx aws.Context, input *CreateAccessPointInput, opts ...request.Option) (*CreateAccessPointOutput, error)

CreateAccessPointWithContext is the same as CreateAccessPoint with the addition of the ability to pass a context and additional request options.

See CreateAccessPoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) CreateBucket added in v1.35.0 

func (c *S3Control) CreateBucket(input *CreateBucketInput) (*CreateBucketOutput, error)

CreateBucket API operation for AWS S3 Control.

This API operation creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) in the Amazon Simple Storage Service API.

Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html) in Amazon Simple Storage Service Developer Guide.

Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules).

S3 on Outposts buckets do not support

  • ACLs. Instead, configure access point policies to manage access to buckets.

  • Public access.

  • Object Lock

  • Bucket Location constraint

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and outpost-id in your API request, see the Example (https://docs.aws.amazon.com/AmazonS3/latest/API/API__control_CreateBucket.html#API_control_CreateBucket_Examples) section below.

The following actions are related to CreateBucket for Amazon S3 on Outposts:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation CreateBucket for usage and error information.

Returned Error Codes:

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

  • ErrCodeBucketAlreadyOwnedByYou "BucketAlreadyOwnedByYou" The Outposts bucket you tried to create already exists, and you own it.

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/CreateBucket

func (*S3Control) CreateBucketRequest added in v1.35.0 

func (c *S3Control) CreateBucketRequest(input *CreateBucketInput) (req *request.Request, output *CreateBucketOutput)

CreateBucketRequest generates a "aws/request.Request" representing the client's request for the CreateBucket operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateBucket for more information on using the CreateBucket API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateBucketRequest method.
req, resp := client.CreateBucketRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/CreateBucket

func (*S3Control) CreateBucketWithContext added in v1.35.0 

func (c *S3Control) CreateBucketWithContext(ctx aws.Context, input *CreateBucketInput, opts ...request.Option) (*CreateBucketOutput, error)

CreateBucketWithContext is the same as CreateBucket with the addition of the ability to pass a context and additional request options.

See CreateBucket for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) CreateJob added in v1.19.21 

func (c *S3Control) CreateJob(input *CreateJobInput) (*CreateJobOutput, error)

CreateJob API operation for AWS S3 Control.

S3 Batch Operations performs large-scale Batch Operations on Amazon S3 objects. Batch Operations can run a single operation or action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html) in the Amazon Simple Storage Service Developer Guide.

This operation creates a S3 Batch Operations job.

Related actions include:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation CreateJob for usage and error information.

Returned Error Codes:

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeIdempotencyException "IdempotencyException"

  • ErrCodeInternalServiceException "InternalServiceException"

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/CreateJob

func (*S3Control) CreateJobRequest added in v1.19.21 

func (c *S3Control) CreateJobRequest(input *CreateJobInput) (req *request.Request, output *CreateJobOutput)

CreateJobRequest generates a "aws/request.Request" representing the client's request for the CreateJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateJob for more information on using the CreateJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateJobRequest method.
req, resp := client.CreateJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/CreateJob

func (*S3Control) CreateJobWithContext added in v1.19.21 

func (c *S3Control) CreateJobWithContext(ctx aws.Context, input *CreateJobInput, opts ...request.Option) (*CreateJobOutput, error)

CreateJobWithContext is the same as CreateJob with the addition of the ability to pass a context and additional request options.

See CreateJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) DeleteAccessPoint added in v1.25.46 

func (c *S3Control) DeleteAccessPoint(input *DeleteAccessPointInput) (*DeleteAccessPointOutput, error)

DeleteAccessPoint API operation for AWS S3 Control.

Deletes the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the ARN, see the Example (https://docs.aws.amazon.com/AmazonS3/latest/API/API__control_DeleteAccessPoint.html#API_control_DeleteAccessPoint_Examples) section below.

The following actions are related to DeleteAccessPoint:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation DeleteAccessPoint for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteAccessPoint

func (*S3Control) DeleteAccessPointPolicy added in v1.25.46 

func (c *S3Control) DeleteAccessPointPolicy(input *DeleteAccessPointPolicyInput) (*DeleteAccessPointPolicyOutput, error)

DeleteAccessPointPolicy API operation for AWS S3 Control.

Deletes the access point policy for the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example (https://docs.aws.amazon.com/AmazonS3/latest/API/API__control_DeleteAccessPointPolicy.html#API_control_DeleteAccessPointPolicy_Examples) section below.

The following actions are related to DeleteAccessPointPolicy:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation DeleteAccessPointPolicy for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteAccessPointPolicy

func (*S3Control) DeleteAccessPointPolicyRequest added in v1.25.46 

func (c *S3Control) DeleteAccessPointPolicyRequest(input *DeleteAccessPointPolicyInput) (req *request.Request, output *DeleteAccessPointPolicyOutput)

DeleteAccessPointPolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteAccessPointPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAccessPointPolicy for more information on using the DeleteAccessPointPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteAccessPointPolicyRequest method.
req, resp := client.DeleteAccessPointPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteAccessPointPolicy

func (*S3Control) DeleteAccessPointPolicyWithContext added in v1.25.46 

func (c *S3Control) DeleteAccessPointPolicyWithContext(ctx aws.Context, input *DeleteAccessPointPolicyInput, opts ...request.Option) (*DeleteAccessPointPolicyOutput, error)

DeleteAccessPointPolicyWithContext is the same as DeleteAccessPointPolicy with the addition of the ability to pass a context and additional request options.

See DeleteAccessPointPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) DeleteAccessPointRequest added in v1.25.46 

func (c *S3Control) DeleteAccessPointRequest(input *DeleteAccessPointInput) (req *request.Request, output *DeleteAccessPointOutput)

DeleteAccessPointRequest generates a "aws/request.Request" representing the client's request for the DeleteAccessPoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAccessPoint for more information on using the DeleteAccessPoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteAccessPointRequest method.
req, resp := client.DeleteAccessPointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteAccessPoint

func (*S3Control) DeleteAccessPointWithContext added in v1.25.46 

func (c *S3Control) DeleteAccessPointWithContext(ctx aws.Context, input *DeleteAccessPointInput, opts ...request.Option) (*DeleteAccessPointOutput, error)

DeleteAccessPointWithContext is the same as DeleteAccessPoint with the addition of the ability to pass a context and additional request options.

See DeleteAccessPoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) DeleteBucket added in v1.35.0 

func (c *S3Control) DeleteBucket(input *DeleteBucketInput) (*DeleteBucketOutput, error)

DeleteBucket API operation for AWS S3 Control.

This API operation deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) in the Amazon Simple Storage Service API.

Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html) in Amazon Simple Storage Service Developer Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example (https://docs.aws.amazon.com/AmazonS3/latest/API/API__control_DeleteBucket.html#API_control_DeleteBucket_Examples) section below.

Related Resources

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation DeleteBucket for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteBucket

func (*S3Control) DeleteBucketLifecycleConfiguration added in v1.35.0 

func (c *S3Control) DeleteBucketLifecycleConfiguration(input *DeleteBucketLifecycleConfigurationInput) (*DeleteBucketLifecycleConfigurationOutput, error)

DeleteBucketLifecycleConfiguration API operation for AWS S3 Control.

This API action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html) in the Amazon Simple Storage Service API.

Deletes the lifecycle configuration from the specified Outposts bucket. Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html) in Amazon Simple Storage Service Developer Guide.

To use this operation, you must have permission to perform the s3outposts:DeleteLifecycleConfiguration action. By default, the bucket owner has this permission and the Outposts bucket owner can grant this permission to others.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example (https://docs.aws.amazon.com/AmazonS3/latest/API/API__control_DeleteBucketLifecycleConfiguration.html#API_control_DeleteBucketLifecycleConfiguration_Examples) section below.

For more information about object expiration, see Elements to Describe Lifecycle Actions (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions).

Related actions include:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation DeleteBucketLifecycleConfiguration for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteBucketLifecycleConfiguration

func (*S3Control) DeleteBucketLifecycleConfigurationRequest added in v1.35.0 

func (c *S3Control) DeleteBucketLifecycleConfigurationRequest(input *DeleteBucketLifecycleConfigurationInput) (req *request.Request, output *DeleteBucketLifecycleConfigurationOutput)

DeleteBucketLifecycleConfigurationRequest generates a "aws/request.Request" representing the client's request for the DeleteBucketLifecycleConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteBucketLifecycleConfiguration for more information on using the DeleteBucketLifecycleConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteBucketLifecycleConfigurationRequest method.
req, resp := client.DeleteBucketLifecycleConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteBucketLifecycleConfiguration

func (*S3Control) DeleteBucketLifecycleConfigurationWithContext added in v1.35.0 

func (c *S3Control) DeleteBucketLifecycleConfigurationWithContext(ctx aws.Context, input *DeleteBucketLifecycleConfigurationInput, opts ...request.Option) (*DeleteBucketLifecycleConfigurationOutput, error)

DeleteBucketLifecycleConfigurationWithContext is the same as DeleteBucketLifecycleConfiguration with the addition of the ability to pass a context and additional request options.

See DeleteBucketLifecycleConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) DeleteBucketPolicy added in v1.35.0 

func (c *S3Control) DeleteBucketPolicy(input *DeleteBucketPolicyInput) (*DeleteBucketPolicyOutput, error)

DeleteBucketPolicy API operation for AWS S3 Control.

This API operation deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see DeleteBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketPolicy.html) in the Amazon Simple Storage Service API.

This implementation of the DELETE operation uses the policy subresource to delete the policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the s3outposts:DeleteBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account to use this operation. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html) in Amazon Simple Storage Service Developer Guide.

If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html).

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example (https://docs.aws.amazon.com/AmazonS3/latest/API/API__control_DeleteBucketPolicy.html#API_control_DeleteBucketPolicy_Examples) section below.

The following actions are related to DeleteBucketPolicy:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation DeleteBucketPolicy for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteBucketPolicy

func (*S3Control) DeleteBucketPolicyRequest added in v1.35.0 

func (c *S3Control) DeleteBucketPolicyRequest(input *DeleteBucketPolicyInput) (req *request.Request, output *DeleteBucketPolicyOutput)

DeleteBucketPolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteBucketPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteBucketPolicy for more information on using the DeleteBucketPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteBucketPolicyRequest method.
req, resp := client.DeleteBucketPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteBucketPolicy

func (*S3Control) DeleteBucketPolicyWithContext added in v1.35.0 

func (c *S3Control) DeleteBucketPolicyWithContext(ctx aws.Context, input *DeleteBucketPolicyInput, opts ...request.Option) (*DeleteBucketPolicyOutput, error)

DeleteBucketPolicyWithContext is the same as DeleteBucketPolicy with the addition of the ability to pass a context and additional request options.

See DeleteBucketPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) DeleteBucketRequest added in v1.35.0 

func (c *S3Control) DeleteBucketRequest(input *DeleteBucketInput) (req *request.Request, output *DeleteBucketOutput)

DeleteBucketRequest generates a "aws/request.Request" representing the client's request for the DeleteBucket operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteBucket for more information on using the DeleteBucket API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteBucketRequest method.
req, resp := client.DeleteBucketRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteBucket

func (*S3Control) DeleteBucketTagging added in v1.35.0 

func (c *S3Control) DeleteBucketTagging(input *DeleteBucketTaggingInput) (*DeleteBucketTaggingOutput, error)

DeleteBucketTagging API operation for AWS S3 Control.

This API operation deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see DeleteBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html) in the Amazon Simple Storage Service API.

Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html) in Amazon Simple Storage Service Developer Guide.

To use this operation, you must have permission to perform the PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example (https://docs.aws.amazon.com/AmazonS3/latest/API/API__control_DeleteBucketTagging.html#API_control_DeleteBucketTagging_Examples) section below.

The following actions are related to DeleteBucketTagging:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation DeleteBucketTagging for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteBucketTagging

func (*S3Control) DeleteBucketTaggingRequest added in v1.35.0 

func (c *S3Control) DeleteBucketTaggingRequest(input *DeleteBucketTaggingInput) (req *request.Request, output *DeleteBucketTaggingOutput)

DeleteBucketTaggingRequest generates a "aws/request.Request" representing the client's request for the DeleteBucketTagging operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteBucketTagging for more information on using the DeleteBucketTagging API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteBucketTaggingRequest method.
req, resp := client.DeleteBucketTaggingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteBucketTagging

func (*S3Control) DeleteBucketTaggingWithContext added in v1.35.0 

func (c *S3Control) DeleteBucketTaggingWithContext(ctx aws.Context, input *DeleteBucketTaggingInput, opts ...request.Option) (*DeleteBucketTaggingOutput, error)

DeleteBucketTaggingWithContext is the same as DeleteBucketTagging with the addition of the ability to pass a context and additional request options.

See DeleteBucketTagging for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) DeleteBucketWithContext added in v1.35.0 

func (c *S3Control) DeleteBucketWithContext(ctx aws.Context, input *DeleteBucketInput, opts ...request.Option) (*DeleteBucketOutput, error)

DeleteBucketWithContext is the same as DeleteBucket with the addition of the ability to pass a context and additional request options.

See DeleteBucket for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) DeleteJobTagging added in v1.29.25 

func (c *S3Control) DeleteJobTagging(input *DeleteJobTaggingInput) (*DeleteJobTaggingOutput, error)

DeleteJobTagging API operation for AWS S3 Control.

Removes the entire tag set from the specified S3 Batch Operations job. To use this operation, you must have permission to perform the s3:DeleteJobTagging action. For more information, see Controlling access and labeling jobs using tags (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags) in the Amazon Simple Storage Service Developer Guide.

Related actions include:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation DeleteJobTagging for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

  • ErrCodeNotFoundException "NotFoundException"

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteJobTagging

func (*S3Control) DeleteJobTaggingRequest added in v1.29.25 

func (c *S3Control) DeleteJobTaggingRequest(input *DeleteJobTaggingInput) (req *request.Request, output *DeleteJobTaggingOutput)

DeleteJobTaggingRequest generates a "aws/request.Request" representing the client's request for the DeleteJobTagging operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteJobTagging for more information on using the DeleteJobTagging API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteJobTaggingRequest method.
req, resp := client.DeleteJobTaggingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteJobTagging

func (*S3Control) DeleteJobTaggingWithContext added in v1.29.25 

func (c *S3Control) DeleteJobTaggingWithContext(ctx aws.Context, input *DeleteJobTaggingInput, opts ...request.Option) (*DeleteJobTaggingOutput, error)

DeleteJobTaggingWithContext is the same as DeleteJobTagging with the addition of the ability to pass a context and additional request options.

See DeleteJobTagging for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) DeletePublicAccessBlock 

func (c *S3Control) DeletePublicAccessBlock(input *DeletePublicAccessBlockInput) (*DeletePublicAccessBlockOutput, error)

DeletePublicAccessBlock API operation for AWS S3 Control.

Removes the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3 block public access (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html).

Related actions include:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation DeletePublicAccessBlock for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeletePublicAccessBlock

func (*S3Control) DeletePublicAccessBlockRequest 

func (c *S3Control) DeletePublicAccessBlockRequest(input *DeletePublicAccessBlockInput) (req *request.Request, output *DeletePublicAccessBlockOutput)

DeletePublicAccessBlockRequest generates a "aws/request.Request" representing the client's request for the DeletePublicAccessBlock operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeletePublicAccessBlock for more information on using the DeletePublicAccessBlock API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeletePublicAccessBlockRequest method.
req, resp := client.DeletePublicAccessBlockRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeletePublicAccessBlock

func (*S3Control) DeletePublicAccessBlockWithContext 

func (c *S3Control) DeletePublicAccessBlockWithContext(ctx aws.Context, input *DeletePublicAccessBlockInput, opts ...request.Option) (*DeletePublicAccessBlockOutput, error)

DeletePublicAccessBlockWithContext is the same as DeletePublicAccessBlock with the addition of the ability to pass a context and additional request options.

See DeletePublicAccessBlock for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) DescribeJob added in v1.19.21 

func (c *S3Control) DescribeJob(input *DescribeJobInput) (*DescribeJobOutput, error)

DescribeJob API operation for AWS S3 Control.

Retrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html) in the Amazon Simple Storage Service Developer Guide.

Related actions include:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation DescribeJob for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeInternalServiceException "InternalServiceException"

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DescribeJob

func (*S3Control) DescribeJobRequest added in v1.19.21 

func (c *S3Control) DescribeJobRequest(input *DescribeJobInput) (req *request.Request, output *DescribeJobOutput)

DescribeJobRequest generates a "aws/request.Request" representing the client's request for the DescribeJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeJob for more information on using the DescribeJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeJobRequest method.
req, resp := client.DescribeJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DescribeJob

func (*S3Control) DescribeJobWithContext added in v1.19.21 

func (c *S3Control) DescribeJobWithContext(ctx aws.Context, input *DescribeJobInput, opts ...request.Option) (*DescribeJobOutput, error)

DescribeJobWithContext is the same as DescribeJob with the addition of the ability to pass a context and additional request options.

See DescribeJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) GetAccessPoint added in v1.25.46 

func (c *S3Control) GetAccessPoint(input *GetAccessPointInput) (*GetAccessPointOutput, error)

GetAccessPoint API operation for AWS S3 Control.

Returns configuration information about the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example (https://docs.aws.amazon.com/AmazonS3/latest/API/API__control_GetAccessPoint.html#API_control_GetAccessPoint_Examples) section below.

The following actions are related to GetAccessPoint:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation GetAccessPoint for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetAccessPoint

func (*S3Control) GetAccessPointPolicy added in v1.25.46 

func (c *S3Control) GetAccessPointPolicy(input *GetAccessPointPolicyInput) (*GetAccessPointPolicyOutput, error)

GetAccessPointPolicy API operation for AWS S3 Control.

Returns the access point policy associated with the specified access point.

The following actions are related to GetAccessPointPolicy:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation GetAccessPointPolicy for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetAccessPointPolicy

func (*S3Control) GetAccessPointPolicyRequest added in v1.25.46 

func (c *S3Control) GetAccessPointPolicyRequest(input *GetAccessPointPolicyInput) (req *request.Request, output *GetAccessPointPolicyOutput)

GetAccessPointPolicyRequest generates a "aws/request.Request" representing the client's request for the GetAccessPointPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAccessPointPolicy for more information on using the GetAccessPointPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetAccessPointPolicyRequest method.
req, resp := client.GetAccessPointPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetAccessPointPolicy

func (*S3Control) GetAccessPointPolicyStatus added in v1.25.46 

func (c *S3Control) GetAccessPointPolicyStatus(input *GetAccessPointPolicyStatusInput) (*GetAccessPointPolicyStatusOutput, error)

GetAccessPointPolicyStatus API operation for AWS S3 Control.

Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see Managing Data Access with Amazon S3 Access Points (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points.html) in the Amazon Simple Storage Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation GetAccessPointPolicyStatus for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetAccessPointPolicyStatus

func (*S3Control) GetAccessPointPolicyStatusRequest added in v1.25.46 

func (c *S3Control) GetAccessPointPolicyStatusRequest(input *GetAccessPointPolicyStatusInput) (req *request.Request, output *GetAccessPointPolicyStatusOutput)

GetAccessPointPolicyStatusRequest generates a "aws/request.Request" representing the client's request for the GetAccessPointPolicyStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAccessPointPolicyStatus for more information on using the GetAccessPointPolicyStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetAccessPointPolicyStatusRequest method.
req, resp := client.GetAccessPointPolicyStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetAccessPointPolicyStatus

func (*S3Control) GetAccessPointPolicyStatusWithContext added in v1.25.46 

func (c *S3Control) GetAccessPointPolicyStatusWithContext(ctx aws.Context, input *GetAccessPointPolicyStatusInput, opts ...request.Option) (*GetAccessPointPolicyStatusOutput, error)

GetAccessPointPolicyStatusWithContext is the same as GetAccessPointPolicyStatus with the addition of the ability to pass a context and additional request options.

See GetAccessPointPolicyStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) GetAccessPointPolicyWithContext added in v1.25.46 

func (c *S3Control) GetAccessPointPolicyWithContext(ctx aws.Context, input *GetAccessPointPolicyInput, opts ...request.Option) (*GetAccessPointPolicyOutput, error)

GetAccessPointPolicyWithContext is the same as GetAccessPointPolicy with the addition of the ability to pass a context and additional request options.

See GetAccessPointPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) GetAccessPointRequest added in v1.25.46 

func (c *S3Control) GetAccessPointRequest(input *GetAccessPointInput) (req *request.Request, output *GetAccessPointOutput)

GetAccessPointRequest generates a "aws/request.Request" representing the client's request for the GetAccessPoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAccessPoint for more information on using the GetAccessPoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetAccessPointRequest method.
req, resp := client.GetAccessPointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetAccessPoint

func (*S3Control) GetAccessPointWithContext added in v1.25.46 

func (c *S3Control) GetAccessPointWithContext(ctx aws.Context, input *GetAccessPointInput, opts ...request.Option) (*GetAccessPointOutput, error)

GetAccessPointWithContext is the same as GetAccessPoint with the addition of the ability to pass a context and additional request options.

See GetAccessPoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) GetBucket added in v1.35.0 

func (c *S3Control) GetBucket(input *GetBucketInput) (*GetBucketOutput, error)

GetBucket API operation for AWS S3 Control.

Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html) in the Amazon Simple Storage Service Developer Guide.

The following actions are related to GetBucket for Amazon S3 on Outposts:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation GetBucket for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetBucket

func (*S3Control) GetBucketLifecycleConfiguration added in v1.35.0 

func (c *S3Control) GetBucketLifecycleConfiguration(input *GetBucketLifecycleConfigurationInput) (*GetBucketLifecycleConfigurationOutput, error)

GetBucketLifecycleConfiguration API operation for AWS S3 Control.

This API operation gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html) in the Amazon Simple Storage Service API.

Returns the lifecycle configuration information set on the Outposts bucket. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html) and for information about lifecycle configuration, see Object Lifecycle Management (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in Amazon Simple Storage Service Developer Guide.

To use this operation, you must have permission to perform the s3outposts:GetLifecycleConfiguration action. The Outposts bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example (https://docs.aws.amazon.com/AmazonS3/latest/API/API__control_GetBucketLifecycleConfiguration.html#API_control_GetBucketLifecycleConfiguration_Examples) section below.

GetBucketLifecycleConfiguration has the following special error:

  • Error code: NoSuchLifecycleConfiguration Description: The lifecycle configuration does not exist. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client

The following actions are related to GetBucketLifecycleConfiguration:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation GetBucketLifecycleConfiguration for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetBucketLifecycleConfiguration

func (*S3Control) GetBucketLifecycleConfigurationRequest added in v1.35.0 

func (c *S3Control) GetBucketLifecycleConfigurationRequest(input *GetBucketLifecycleConfigurationInput) (req *request.Request, output *GetBucketLifecycleConfigurationOutput)

GetBucketLifecycleConfigurationRequest generates a "aws/request.Request" representing the client's request for the GetBucketLifecycleConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetBucketLifecycleConfiguration for more information on using the GetBucketLifecycleConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetBucketLifecycleConfigurationRequest method.
req, resp := client.GetBucketLifecycleConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetBucketLifecycleConfiguration

func (*S3Control) GetBucketLifecycleConfigurationWithContext added in v1.35.0 

func (c *S3Control) GetBucketLifecycleConfigurationWithContext(ctx aws.Context, input *GetBucketLifecycleConfigurationInput, opts ...request.Option) (*GetBucketLifecycleConfigurationOutput, error)

GetBucketLifecycleConfigurationWithContext is the same as GetBucketLifecycleConfiguration with the addition of the ability to pass a context and additional request options.

See GetBucketLifecycleConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) GetBucketPolicy added in v1.35.0 

func (c *S3Control) GetBucketPolicy(input *GetBucketPolicyInput) (*GetBucketPolicyOutput, error)

GetBucketPolicy API operation for AWS S3 Control.

This API action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3 bucket, see GetBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicy.html) in the Amazon Simple Storage Service API.

Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html) in the Amazon Simple Storage Service Developer Guide.

If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

If you don't have s3outposts:GetBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html).

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example (https://docs.aws.amazon.com/AmazonS3/latest/API/API__control_GetBucketPolicy.html#API_control_GetBucketPolicy_Examples) section below.

The following actions are related to GetBucketPolicy:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation GetBucketPolicy for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetBucketPolicy

func (*S3Control) GetBucketPolicyRequest added in v1.35.0 

func (c *S3Control) GetBucketPolicyRequest(input *GetBucketPolicyInput) (req *request.Request, output *GetBucketPolicyOutput)

GetBucketPolicyRequest generates a "aws/request.Request" representing the client's request for the GetBucketPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetBucketPolicy for more information on using the GetBucketPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetBucketPolicyRequest method.
req, resp := client.GetBucketPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetBucketPolicy

func (*S3Control) GetBucketPolicyWithContext added in v1.35.0 

func (c *S3Control) GetBucketPolicyWithContext(ctx aws.Context, input *GetBucketPolicyInput, opts ...request.Option) (*GetBucketPolicyOutput, error)

GetBucketPolicyWithContext is the same as GetBucketPolicy with the addition of the ability to pass a context and additional request options.

See GetBucketPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) GetBucketRequest added in v1.35.0 

func (c *S3Control) GetBucketRequest(input *GetBucketInput) (req *request.Request, output *GetBucketOutput)

GetBucketRequest generates a "aws/request.Request" representing the client's request for the GetBucket operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetBucket for more information on using the GetBucket API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetBucketRequest method.
req, resp := client.GetBucketRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetBucket

func (*S3Control) GetBucketTagging added in v1.35.0 

func (c *S3Control) GetBucketTagging(input *GetBucketTaggingInput) (*GetBucketTaggingOutput, error)

GetBucketTagging API operation for AWS S3 Control.

This API operation gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see GetBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html) in the Amazon Simple Storage Service API.

Returns the tag set associated with the Outposts bucket. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html) in the Amazon Simple Storage Service Developer Guide.

To use this operation, you must have permission to perform the GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

GetBucketTagging has the following special error:

  • Error code: NoSuchTagSetError Description: There is no tag set associated with the bucket.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example (https://docs.aws.amazon.com/AmazonS3/latest/API/API__control_GetBucketTagging.html#API_control_GetBucketTagging_Examples) section below.

The following actions are related to GetBucketTagging:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation GetBucketTagging for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetBucketTagging

func (*S3Control) GetBucketTaggingRequest added in v1.35.0 

func (c *S3Control) GetBucketTaggingRequest(input *GetBucketTaggingInput) (req *request.Request, output *GetBucketTaggingOutput)

GetBucketTaggingRequest generates a "aws/request.Request" representing the client's request for the GetBucketTagging operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetBucketTagging for more information on using the GetBucketTagging API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetBucketTaggingRequest method.
req, resp := client.GetBucketTaggingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetBucketTagging

func (*S3Control) GetBucketTaggingWithContext added in v1.35.0 

func (c *S3Control) GetBucketTaggingWithContext(ctx aws.Context, input *GetBucketTaggingInput, opts ...request.Option) (*GetBucketTaggingOutput, error)

GetBucketTaggingWithContext is the same as GetBucketTagging with the addition of the ability to pass a context and additional request options.

See GetBucketTagging for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) GetBucketWithContext added in v1.35.0 

func (c *S3Control) GetBucketWithContext(ctx aws.Context, input *GetBucketInput, opts ...request.Option) (*GetBucketOutput, error)

GetBucketWithContext is the same as GetBucket with the addition of the ability to pass a context and additional request options.

See GetBucket for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) GetJobTagging added in v1.29.25 

func (c *S3Control) GetJobTagging(input *GetJobTaggingInput) (*GetJobTaggingOutput, error)

GetJobTagging API operation for AWS S3 Control.

Returns the tags on an S3 Batch Operations job. To use this operation, you must have permission to perform the s3:GetJobTagging action. For more information, see Controlling access and labeling jobs using tags (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags) in the Amazon Simple Storage Service Developer Guide.

Related actions include:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation GetJobTagging for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

  • ErrCodeNotFoundException "NotFoundException"

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetJobTagging

func (*S3Control) GetJobTaggingRequest added in v1.29.25 

func (c *S3Control) GetJobTaggingRequest(input *GetJobTaggingInput) (req *request.Request, output *GetJobTaggingOutput)

GetJobTaggingRequest generates a "aws/request.Request" representing the client's request for the GetJobTagging operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetJobTagging for more information on using the GetJobTagging API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetJobTaggingRequest method.
req, resp := client.GetJobTaggingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetJobTagging

func (*S3Control) GetJobTaggingWithContext added in v1.29.25 

func (c *S3Control) GetJobTaggingWithContext(ctx aws.Context, input *GetJobTaggingInput, opts ...request.Option) (*GetJobTaggingOutput, error)

GetJobTaggingWithContext is the same as GetJobTagging with the addition of the ability to pass a context and additional request options.

See GetJobTagging for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) GetPublicAccessBlock 

func (c *S3Control) GetPublicAccessBlock(input *GetPublicAccessBlockInput) (*GetPublicAccessBlockOutput, error)

GetPublicAccessBlock API operation for AWS S3 Control.

Retrieves the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3 block public access (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html).

Related actions include:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation GetPublicAccessBlock for usage and error information.

Returned Error Codes:

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

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetPublicAccessBlock

func (*S3Control) GetPublicAccessBlockRequest 

func (c *S3Control) GetPublicAccessBlockRequest(input *GetPublicAccessBlockInput) (req *request.Request, output *GetPublicAccessBlockOutput)

GetPublicAccessBlockRequest generates a "aws/request.Request" representing the client's request for the GetPublicAccessBlock operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetPublicAccessBlock for more information on using the GetPublicAccessBlock API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetPublicAccessBlockRequest method.
req, resp := client.GetPublicAccessBlockRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetPublicAccessBlock

func (*S3Control) GetPublicAccessBlockWithContext 

func (c *S3Control) GetPublicAccessBlockWithContext(ctx aws.Context, input *GetPublicAccessBlockInput, opts ...request.Option) (*GetPublicAccessBlockOutput, error)

GetPublicAccessBlockWithContext is the same as GetPublicAccessBlock with the addition of the ability to pass a context and additional request options.

See GetPublicAccessBlock for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) ListAccessPoints added in v1.25.46 

func (c *S3Control) ListAccessPoints(input *ListAccessPointsInput) (*ListAccessPointsOutput, error)

ListAccessPoints API operation for AWS S3 Control.

Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example (https://docs.aws.amazon.com/AmazonS3/latest/API/API__control_GetAccessPoint.html#API_control_GetAccessPoint_Examples) section below.

The following actions are related to ListAccessPoints:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation ListAccessPoints for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/ListAccessPoints

func (*S3Control) ListAccessPointsPages added in v1.25.46 

func (c *S3Control) ListAccessPointsPages(input *ListAccessPointsInput, fn func(*ListAccessPointsOutput, bool) bool) error

ListAccessPointsPages iterates over the pages of a ListAccessPoints operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAccessPoints method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListAccessPoints operation.
pageNum := 0
err := client.ListAccessPointsPages(params,
    func(page *s3control.ListAccessPointsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*S3Control) ListAccessPointsPagesWithContext added in v1.25.46 

func (c *S3Control) ListAccessPointsPagesWithContext(ctx aws.Context, input *ListAccessPointsInput, fn func(*ListAccessPointsOutput, bool) bool, opts ...request.Option) error

ListAccessPointsPagesWithContext same as ListAccessPointsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) ListAccessPointsRequest added in v1.25.46 

func (c *S3Control) ListAccessPointsRequest(input *ListAccessPointsInput) (req *request.Request, output *ListAccessPointsOutput)

ListAccessPointsRequest generates a "aws/request.Request" representing the client's request for the ListAccessPoints operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAccessPoints for more information on using the ListAccessPoints API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListAccessPointsRequest method.
req, resp := client.ListAccessPointsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/ListAccessPoints

func (*S3Control) ListAccessPointsWithContext added in v1.25.46 

func (c *S3Control) ListAccessPointsWithContext(ctx aws.Context, input *ListAccessPointsInput, opts ...request.Option) (*ListAccessPointsOutput, error)

ListAccessPointsWithContext is the same as ListAccessPoints with the addition of the ability to pass a context and additional request options.

See ListAccessPoints for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) ListJobs added in v1.19.21 

func (c *S3Control) ListJobs(input *ListJobsInput) (*ListJobsOutput, error)

ListJobs API operation for AWS S3 Control.

Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request. For more information, see S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html) in the Amazon Simple Storage Service Developer Guide.

Related actions include:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation ListJobs for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException"

  • ErrCodeInternalServiceException "InternalServiceException"

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException"

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/ListJobs

func (*S3Control) ListJobsPages added in v1.19.21 

func (c *S3Control) ListJobsPages(input *ListJobsInput, fn func(*ListJobsOutput, bool) bool) error

ListJobsPages iterates over the pages of a ListJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListJobs operation.
pageNum := 0
err := client.ListJobsPages(params,
    func(page *s3control.ListJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*S3Control) ListJobsPagesWithContext added in v1.19.21 

func (c *S3Control) ListJobsPagesWithContext(ctx aws.Context, input *ListJobsInput, fn func(*ListJobsOutput, bool) bool, opts ...request.Option) error

ListJobsPagesWithContext same as ListJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) ListJobsRequest added in v1.19.21 

func (c *S3Control) ListJobsRequest(input *ListJobsInput) (req *request.Request, output *ListJobsOutput)

ListJobsRequest generates a "aws/request.Request" representing the client's request for the ListJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListJobs for more information on using the ListJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListJobsRequest method.
req, resp := client.ListJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/ListJobs

func (*S3Control) ListJobsWithContext added in v1.19.21 

func (c *S3Control) ListJobsWithContext(ctx aws.Context, input *ListJobsInput, opts ...request.Option) (*ListJobsOutput, error)

ListJobsWithContext is the same as ListJobs with the addition of the ability to pass a context and additional request options.

See ListJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) ListRegionalBuckets added in v1.35.0 

func (c *S3Control) ListRegionalBuckets(input *ListRegionalBucketsInput) (*ListRegionalBucketsOutput, error)

ListRegionalBuckets API operation for AWS S3 Control.

Returns a list of all Outposts buckets in an Outposts that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html) in the Amazon Simple Storage Service Developer Guide.

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and outpost-id in your API request, see the Example (https://docs.aws.amazon.com/AmazonS3/latest/API/API__control_ListRegionalBuckets.html#API_control_ListRegionalBuckets_Examples) section below.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation ListRegionalBuckets for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/ListRegionalBuckets

func (*S3Control) ListRegionalBucketsPages added in v1.35.0 

func (c *S3Control) ListRegionalBucketsPages(input *ListRegionalBucketsInput, fn func(*ListRegionalBucketsOutput, bool) bool) error

ListRegionalBucketsPages iterates over the pages of a ListRegionalBuckets operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListRegionalBuckets method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListRegionalBuckets operation.
pageNum := 0
err := client.ListRegionalBucketsPages(params,
    func(page *s3control.ListRegionalBucketsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*S3Control) ListRegionalBucketsPagesWithContext added in v1.35.0 

func (c *S3Control) ListRegionalBucketsPagesWithContext(ctx aws.Context, input *ListRegionalBucketsInput, fn func(*ListRegionalBucketsOutput, bool) bool, opts ...request.Option) error

ListRegionalBucketsPagesWithContext same as ListRegionalBucketsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) ListRegionalBucketsRequest added in v1.35.0 

func (c *S3Control) ListRegionalBucketsRequest(input *ListRegionalBucketsInput) (req *request.Request, output *ListRegionalBucketsOutput)

ListRegionalBucketsRequest generates a "aws/request.Request" representing the client's request for the ListRegionalBuckets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListRegionalBuckets for more information on using the ListRegionalBuckets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListRegionalBucketsRequest method.
req, resp := client.ListRegionalBucketsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/ListRegionalBuckets

func (*S3Control) ListRegionalBucketsWithContext added in v1.35.0 

func (c *S3Control) ListRegionalBucketsWithContext(ctx aws.Context, input *ListRegionalBucketsInput, opts ...request.Option) (*ListRegionalBucketsOutput, error)

ListRegionalBucketsWithContext is the same as ListRegionalBuckets with the addition of the ability to pass a context and additional request options.

See ListRegionalBuckets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) PutAccessPointPolicy added in v1.25.46 

func (c *S3Control) PutAccessPointPolicy(input *PutAccessPointPolicyInput) (*PutAccessPointPolicyOutput, error)

PutAccessPointPolicy API operation for AWS S3 Control.

Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example (https://docs.aws.amazon.com/AmazonS3/latest/API/API__control_PutAccessPointPolicy.html#API_control_PutAccessPointPolicy_Examples) section below.

The following actions are related to PutAccessPointPolicy:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation PutAccessPointPolicy for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutAccessPointPolicy

func (*S3Control) PutAccessPointPolicyRequest added in v1.25.46 

func (c *S3Control) PutAccessPointPolicyRequest(input *PutAccessPointPolicyInput) (req *request.Request, output *PutAccessPointPolicyOutput)

PutAccessPointPolicyRequest generates a "aws/request.Request" representing the client's request for the PutAccessPointPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutAccessPointPolicy for more information on using the PutAccessPointPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutAccessPointPolicyRequest method.
req, resp := client.PutAccessPointPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutAccessPointPolicy

func (*S3Control) PutAccessPointPolicyWithContext added in v1.25.46 

func (c *S3Control) PutAccessPointPolicyWithContext(ctx aws.Context, input *PutAccessPointPolicyInput, opts ...request.Option) (*PutAccessPointPolicyOutput, error)

PutAccessPointPolicyWithContext is the same as PutAccessPointPolicy with the addition of the ability to pass a context and additional request options.

See PutAccessPointPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) PutBucketLifecycleConfiguration added in v1.35.0 

func (c *S3Control) PutBucketLifecycleConfiguration(input *PutBucketLifecycleConfigurationInput) (*PutBucketLifecycleConfigurationOutput, error)

PutBucketLifecycleConfiguration API operation for AWS S3 Control.

This API action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html) in the Amazon Simple Storage Service API.

Creates a new lifecycle configuration for the Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets can only support a lifecycle that deletes objects after a certain period of time. For more information, see Managing Lifecycle Permissions for Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html).

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example (https://docs.aws.amazon.com/AmazonS3/latest/API/API__control_PutBucketLifecycleConfiguration.html#API_control_PutBucketLifecycleConfiguration_Examples) section below.

The following actions are related to PutBucketLifecycleConfiguration:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation PutBucketLifecycleConfiguration for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutBucketLifecycleConfiguration

func (*S3Control) PutBucketLifecycleConfigurationRequest added in v1.35.0 

func (c *S3Control) PutBucketLifecycleConfigurationRequest(input *PutBucketLifecycleConfigurationInput) (req *request.Request, output *PutBucketLifecycleConfigurationOutput)

PutBucketLifecycleConfigurationRequest generates a "aws/request.Request" representing the client's request for the PutBucketLifecycleConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutBucketLifecycleConfiguration for more information on using the PutBucketLifecycleConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutBucketLifecycleConfigurationRequest method.
req, resp := client.PutBucketLifecycleConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutBucketLifecycleConfiguration

func (*S3Control) PutBucketLifecycleConfigurationWithContext added in v1.35.0 

func (c *S3Control) PutBucketLifecycleConfigurationWithContext(ctx aws.Context, input *PutBucketLifecycleConfigurationInput, opts ...request.Option) (*PutBucketLifecycleConfigurationOutput, error)

PutBucketLifecycleConfigurationWithContext is the same as PutBucketLifecycleConfiguration with the addition of the ability to pass a context and additional request options.

See PutBucketLifecycleConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) PutBucketPolicy added in v1.35.0 

func (c *S3Control) PutBucketPolicy(input *PutBucketPolicyInput) (*PutBucketPolicyOutput, error)

PutBucketPolicy API operation for AWS S3 Control.

This API action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see PutBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketPolicy.html) in the Amazon Simple Storage Service API.

Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html) in the Amazon Simple Storage Service Developer Guide.

If you are using an identity other than the root user of the AWS account that owns the Outposts bucket, the calling identity must have the PutBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account in order to use this operation.

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html).

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example (https://docs.aws.amazon.com/AmazonS3/latest/API/API__control_PutBucketPolicy.html#API_control_PutBucketPolicy_Examples) section below.

The following actions are related to PutBucketPolicy:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation PutBucketPolicy for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutBucketPolicy

func (*S3Control) PutBucketPolicyRequest added in v1.35.0 

func (c *S3Control) PutBucketPolicyRequest(input *PutBucketPolicyInput) (req *request.Request, output *PutBucketPolicyOutput)

PutBucketPolicyRequest generates a "aws/request.Request" representing the client's request for the PutBucketPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutBucketPolicy for more information on using the PutBucketPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutBucketPolicyRequest method.
req, resp := client.PutBucketPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutBucketPolicy

func (*S3Control) PutBucketPolicyWithContext added in v1.35.0 

func (c *S3Control) PutBucketPolicyWithContext(ctx aws.Context, input *PutBucketPolicyInput, opts ...request.Option) (*PutBucketPolicyOutput, error)

PutBucketPolicyWithContext is the same as PutBucketPolicy with the addition of the ability to pass a context and additional request options.

See PutBucketPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) PutBucketTagging added in v1.35.0 

func (c *S3Control) PutBucketTagging(input *PutBucketTaggingInput) (*PutBucketTaggingOutput, error)

PutBucketTagging API operation for AWS S3 Control.

This API action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html) in the Amazon Simple Storage Service API.

Sets the tags for an Outposts bucket. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html) in the Amazon Simple Storage Service Developer Guide.

Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost Allocation and Tagging (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html).

Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using Cost Allocation in Amazon S3 Bucket Tags (https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html).

To use this operation, you must have permissions to perform the s3outposts:PutBucketTagging action. The Outposts bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html).

PutBucketTagging has the following special errors:

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the Example (https://docs.aws.amazon.com/AmazonS3/latest/API/API__control_PutBucketTagging.html#API_control_PutBucketTagging_Examples) section below.

The following actions are related to PutBucketTagging:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation PutBucketTagging for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutBucketTagging

func (*S3Control) PutBucketTaggingRequest added in v1.35.0 

func (c *S3Control) PutBucketTaggingRequest(input *PutBucketTaggingInput) (req *request.Request, output *PutBucketTaggingOutput)

PutBucketTaggingRequest generates a "aws/request.Request" representing the client's request for the PutBucketTagging operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutBucketTagging for more information on using the PutBucketTagging API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutBucketTaggingRequest method.
req, resp := client.PutBucketTaggingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutBucketTagging

func (*S3Control) PutBucketTaggingWithContext added in v1.35.0 

func (c *S3Control) PutBucketTaggingWithContext(ctx aws.Context, input *PutBucketTaggingInput, opts ...request.Option) (*PutBucketTaggingOutput, error)

PutBucketTaggingWithContext is the same as PutBucketTagging with the addition of the ability to pass a context and additional request options.

See PutBucketTagging for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) PutJobTagging added in v1.29.25 

func (c *S3Control) PutJobTagging(input *PutJobTaggingInput) (*PutJobTaggingOutput, error)

PutJobTagging API operation for AWS S3 Control.

Sets the supplied tag-set on an S3 Batch Operations job.

A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html), modify that tag set, and use this API action to replace the tag set with the one you modified. For more information, see Controlling access and labeling jobs using tags (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags) in the Amazon Simple Storage Service Developer Guide.

  • If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the Batch Operations job. If you use this method, you are charged for a Tier 1 Request (PUT). For more information, see Amazon S3 pricing (http://aws.amazon.com/s3/pricing/).

  • For deleting existing tags for your Batch Operations job, a DeleteJobTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html) request is preferred because it achieves the same result without incurring charges.

  • A few things to consider about using tags: Amazon S3 limits the maximum number of tags to 50 tags per job. You can associate up to 50 tags with a job as long as they have unique tag keys. A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length. The key and values are case sensitive. For tagging-related restrictions related to characters and encodings, see User-Defined Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) in the AWS Billing and Cost Management User Guide.

To use this operation, you must have permission to perform the s3:PutJobTagging action.

Related actions include:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation PutJobTagging for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

  • ErrCodeNotFoundException "NotFoundException"

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

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutJobTagging

func (*S3Control) PutJobTaggingRequest added in v1.29.25 

func (c *S3Control) PutJobTaggingRequest(input *PutJobTaggingInput) (req *request.Request, output *PutJobTaggingOutput)

PutJobTaggingRequest generates a "aws/request.Request" representing the client's request for the PutJobTagging operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutJobTagging for more information on using the PutJobTagging API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutJobTaggingRequest method.
req, resp := client.PutJobTaggingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutJobTagging

func (*S3Control) PutJobTaggingWithContext added in v1.29.25 

func (c *S3Control) PutJobTaggingWithContext(ctx aws.Context, input *PutJobTaggingInput, opts ...request.Option) (*PutJobTaggingOutput, error)

PutJobTaggingWithContext is the same as PutJobTagging with the addition of the ability to pass a context and additional request options.

See PutJobTagging for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) PutPublicAccessBlock 

func (c *S3Control) PutPublicAccessBlock(input *PutPublicAccessBlockInput) (*PutPublicAccessBlockOutput, error)

PutPublicAccessBlock API operation for AWS S3 Control.

Creates or modifies the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3 block public access (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html).

Related actions include:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation PutPublicAccessBlock for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutPublicAccessBlock

func (*S3Control) PutPublicAccessBlockRequest 

func (c *S3Control) PutPublicAccessBlockRequest(input *PutPublicAccessBlockInput) (req *request.Request, output *PutPublicAccessBlockOutput)

PutPublicAccessBlockRequest generates a "aws/request.Request" representing the client's request for the PutPublicAccessBlock operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutPublicAccessBlock for more information on using the PutPublicAccessBlock API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutPublicAccessBlockRequest method.
req, resp := client.PutPublicAccessBlockRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutPublicAccessBlock

func (*S3Control) PutPublicAccessBlockWithContext 

func (c *S3Control) PutPublicAccessBlockWithContext(ctx aws.Context, input *PutPublicAccessBlockInput, opts ...request.Option) (*PutPublicAccessBlockOutput, error)

PutPublicAccessBlockWithContext is the same as PutPublicAccessBlock with the addition of the ability to pass a context and additional request options.

See PutPublicAccessBlock for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) UpdateJobPriority added in v1.19.21 

func (c *S3Control) UpdateJobPriority(input *UpdateJobPriorityInput) (*UpdateJobPriorityOutput, error)

UpdateJobPriority API operation for AWS S3 Control.

Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html) in the Amazon Simple Storage Service Developer Guide.

Related actions include:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation UpdateJobPriority for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeInternalServiceException "InternalServiceException"

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/UpdateJobPriority

func (*S3Control) UpdateJobPriorityRequest added in v1.19.21 

func (c *S3Control) UpdateJobPriorityRequest(input *UpdateJobPriorityInput) (req *request.Request, output *UpdateJobPriorityOutput)

UpdateJobPriorityRequest generates a "aws/request.Request" representing the client's request for the UpdateJobPriority operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateJobPriority for more information on using the UpdateJobPriority API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateJobPriorityRequest method.
req, resp := client.UpdateJobPriorityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/UpdateJobPriority

func (*S3Control) UpdateJobPriorityWithContext added in v1.19.21 

func (c *S3Control) UpdateJobPriorityWithContext(ctx aws.Context, input *UpdateJobPriorityInput, opts ...request.Option) (*UpdateJobPriorityOutput, error)

UpdateJobPriorityWithContext is the same as UpdateJobPriority with the addition of the ability to pass a context and additional request options.

See UpdateJobPriority for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Control) UpdateJobStatus added in v1.19.21 

func (c *S3Control) UpdateJobStatus(input *UpdateJobStatusInput) (*UpdateJobStatusOutput, error)

UpdateJobStatus API operation for AWS S3 Control.

Updates the status for the specified job. Use this operation to confirm that you want to run a job or to cancel an existing job. For more information, see S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html) in the Amazon Simple Storage Service Developer Guide.

Related actions include:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS S3 Control's API operation UpdateJobStatus for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeJobStatusException "JobStatusException"

  • ErrCodeInternalServiceException "InternalServiceException"

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/UpdateJobStatus

func (*S3Control) UpdateJobStatusRequest added in v1.19.21 

func (c *S3Control) UpdateJobStatusRequest(input *UpdateJobStatusInput) (req *request.Request, output *UpdateJobStatusOutput)

UpdateJobStatusRequest generates a "aws/request.Request" representing the client's request for the UpdateJobStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateJobStatus for more information on using the UpdateJobStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateJobStatusRequest method.
req, resp := client.UpdateJobStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/UpdateJobStatus

func (*S3Control) UpdateJobStatusWithContext added in v1.19.21 

func (c *S3Control) UpdateJobStatusWithContext(ctx aws.Context, input *UpdateJobStatusInput, opts ...request.Option) (*UpdateJobStatusOutput, error)

UpdateJobStatusWithContext is the same as UpdateJobStatus with the addition of the ability to pass a context and additional request options.

See UpdateJobStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type S3CopyObjectOperation added in v1.19.21 

type S3CopyObjectOperation struct {
	AccessControlGrants []*S3Grant `type:"list"`

	CannedAccessControlList *string `type:"string" enum:"S3CannedAccessControlList"`

	MetadataDirective *string `type:"string" enum:"S3MetadataDirective"`

	ModifiedSinceConstraint *time.Time `type:"timestamp"`

	NewObjectMetadata *S3ObjectMetadata `type:"structure"`

	NewObjectTagging []*S3Tag `type:"list"`

	// The legal hold status to be applied to all objects in the Batch Operations
	// job.
	ObjectLockLegalHoldStatus *string `type:"string" enum:"S3ObjectLockLegalHoldStatus"`

	// The retention mode to be applied to all objects in the Batch Operations job.
	ObjectLockMode *string `type:"string" enum:"S3ObjectLockMode"`

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

	RedirectLocation *string `min:"1" type:"string"`

	RequesterPays *bool `type:"boolean"`

	SSEAwsKmsKeyId *string `min:"1" type:"string"`

	StorageClass *string `type:"string" enum:"S3StorageClass"`

	TargetKeyPrefix *string `min:"1" type:"string"`

	TargetResource *string `min:"1" type:"string"`

	UnModifiedSinceConstraint *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

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

func (S3CopyObjectOperation) GoString added in v1.19.21 

func (s S3CopyObjectOperation) GoString() string

GoString returns the string representation

func (*S3CopyObjectOperation) SetAccessControlGrants added in v1.19.21 

func (s *S3CopyObjectOperation) SetAccessControlGrants(v []*S3Grant) *S3CopyObjectOperation

SetAccessControlGrants sets the AccessControlGrants field's value.

func (*S3CopyObjectOperation) SetCannedAccessControlList added in v1.19.21 

func (s *S3CopyObjectOperation) SetCannedAccessControlList(v string) *S3CopyObjectOperation

SetCannedAccessControlList sets the CannedAccessControlList field's value.

func (*S3CopyObjectOperation) SetMetadataDirective added in v1.19.21 

func (s *S3CopyObjectOperation) SetMetadataDirective(v string) *S3CopyObjectOperation

SetMetadataDirective sets the MetadataDirective field's value.

func (*S3CopyObjectOperation) SetModifiedSinceConstraint added in v1.19.21 

func (s *S3CopyObjectOperation) SetModifiedSinceConstraint(v time.Time) *S3CopyObjectOperation

SetModifiedSinceConstraint sets the ModifiedSinceConstraint field's value.

func (*S3CopyObjectOperation) SetNewObjectMetadata added in v1.19.21 

func (s *S3CopyObjectOperation) SetNewObjectMetadata(v *S3ObjectMetadata) *S3CopyObjectOperation

SetNewObjectMetadata sets the NewObjectMetadata field's value.

func (*S3CopyObjectOperation) SetNewObjectTagging added in v1.19.21 

func (s *S3CopyObjectOperation) SetNewObjectTagging(v []*S3Tag) *S3CopyObjectOperation

SetNewObjectTagging sets the NewObjectTagging field's value.

func (*S3CopyObjectOperation) SetObjectLockLegalHoldStatus added in v1.19.21 

func (s *S3CopyObjectOperation) SetObjectLockLegalHoldStatus(v string) *S3CopyObjectOperation

SetObjectLockLegalHoldStatus sets the ObjectLockLegalHoldStatus field's value.

func (*S3CopyObjectOperation) SetObjectLockMode added in v1.19.21 

func (s *S3CopyObjectOperation) SetObjectLockMode(v string) *S3CopyObjectOperation

SetObjectLockMode sets the ObjectLockMode field's value.

func (*S3CopyObjectOperation) SetObjectLockRetainUntilDate added in v1.19.21 

func (s *S3CopyObjectOperation) SetObjectLockRetainUntilDate(v time.Time) *S3CopyObjectOperation

SetObjectLockRetainUntilDate sets the ObjectLockRetainUntilDate field's value.

func (*S3CopyObjectOperation) SetRedirectLocation added in v1.19.21 

func (s *S3CopyObjectOperation) SetRedirectLocation(v string) *S3CopyObjectOperation

SetRedirectLocation sets the RedirectLocation field's value.

func (*S3CopyObjectOperation) SetRequesterPays added in v1.19.21 

func (s *S3CopyObjectOperation) SetRequesterPays(v bool) *S3CopyObjectOperation

SetRequesterPays sets the RequesterPays field's value.

func (*S3CopyObjectOperation) SetSSEAwsKmsKeyId added in v1.19.21 

func (s *S3CopyObjectOperation) SetSSEAwsKmsKeyId(v string) *S3CopyObjectOperation

SetSSEAwsKmsKeyId sets the SSEAwsKmsKeyId field's value.

func (*S3CopyObjectOperation) SetStorageClass added in v1.19.21 

func (s *S3CopyObjectOperation) SetStorageClass(v string) *S3CopyObjectOperation

SetStorageClass sets the StorageClass field's value.

func (*S3CopyObjectOperation) SetTargetKeyPrefix added in v1.19.21 

func (s *S3CopyObjectOperation) SetTargetKeyPrefix(v string) *S3CopyObjectOperation

SetTargetKeyPrefix sets the TargetKeyPrefix field's value.

func (*S3CopyObjectOperation) SetTargetResource added in v1.19.21 

func (s *S3CopyObjectOperation) SetTargetResource(v string) *S3CopyObjectOperation

SetTargetResource sets the TargetResource field's value.

func (*S3CopyObjectOperation) SetUnModifiedSinceConstraint added in v1.19.21 

func (s *S3CopyObjectOperation) SetUnModifiedSinceConstraint(v time.Time) *S3CopyObjectOperation

SetUnModifiedSinceConstraint sets the UnModifiedSinceConstraint field's value.

func (S3CopyObjectOperation) String added in v1.19.21 

func (s S3CopyObjectOperation) String() string

String returns the string representation

func (*S3CopyObjectOperation) Validate added in v1.19.21 

func (s *S3CopyObjectOperation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3Grant added in v1.19.21 

type S3Grant struct {
	Grantee *S3Grantee `type:"structure"`

	Permission *string `type:"string" enum:"S3Permission"`
	// contains filtered or unexported fields
}

func (S3Grant) GoString added in v1.19.21 

func (s S3Grant) GoString() string

GoString returns the string representation

func (*S3Grant) SetGrantee added in v1.19.21 

func (s *S3Grant) SetGrantee(v *S3Grantee) *S3Grant

SetGrantee sets the Grantee field's value.

func (*S3Grant) SetPermission added in v1.19.21 

func (s *S3Grant) SetPermission(v string) *S3Grant

SetPermission sets the Permission field's value.

func (S3Grant) String added in v1.19.21 

func (s S3Grant) String() string

String returns the string representation

func (*S3Grant) Validate added in v1.19.21 

func (s *S3Grant) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3Grantee added in v1.19.21 

type S3Grantee struct {
	DisplayName *string `min:"1" type:"string"`

	Identifier *string `min:"1" type:"string"`

	TypeIdentifier *string `type:"string" enum:"S3GranteeTypeIdentifier"`
	// contains filtered or unexported fields
}

func (S3Grantee) GoString added in v1.19.21 

func (s S3Grantee) GoString() string

GoString returns the string representation

func (*S3Grantee) SetDisplayName added in v1.19.21 

func (s *S3Grantee) SetDisplayName(v string) *S3Grantee

SetDisplayName sets the DisplayName field's value.

func (*S3Grantee) SetIdentifier added in v1.19.21 

func (s *S3Grantee) SetIdentifier(v string) *S3Grantee

SetIdentifier sets the Identifier field's value.

func (*S3Grantee) SetTypeIdentifier added in v1.19.21 

func (s *S3Grantee) SetTypeIdentifier(v string) *S3Grantee

SetTypeIdentifier sets the TypeIdentifier field's value.

func (S3Grantee) String added in v1.19.21 

func (s S3Grantee) String() string

String returns the string representation

func (*S3Grantee) Validate added in v1.19.21 

func (s *S3Grantee) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3InitiateRestoreObjectOperation added in v1.19.21 

type S3InitiateRestoreObjectOperation struct {
	ExpirationInDays *int64 `type:"integer"`

	GlacierJobTier *string `type:"string" enum:"S3GlacierJobTier"`
	// contains filtered or unexported fields
}

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

func (S3InitiateRestoreObjectOperation) GoString added in v1.19.21 

func (s S3InitiateRestoreObjectOperation) GoString() string

GoString returns the string representation

func (*S3InitiateRestoreObjectOperation) SetExpirationInDays added in v1.19.21 

func (s *S3InitiateRestoreObjectOperation) SetExpirationInDays(v int64) *S3InitiateRestoreObjectOperation

SetExpirationInDays sets the ExpirationInDays field's value.

func (*S3InitiateRestoreObjectOperation) SetGlacierJobTier added in v1.19.21 

func (s *S3InitiateRestoreObjectOperation) SetGlacierJobTier(v string) *S3InitiateRestoreObjectOperation

SetGlacierJobTier sets the GlacierJobTier field's value.

func (S3InitiateRestoreObjectOperation) String added in v1.19.21 

func (s S3InitiateRestoreObjectOperation) String() string

String returns the string representation

type S3ObjectLockLegalHold added in v1.30.20 

type S3ObjectLockLegalHold struct {

	// The Object Lock legal hold status to be applied to all objects in the Batch
	// Operations job.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"S3ObjectLockLegalHoldStatus"`
	// contains filtered or unexported fields
}

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

func (S3ObjectLockLegalHold) GoString added in v1.30.20 

func (s S3ObjectLockLegalHold) GoString() string

GoString returns the string representation

func (*S3ObjectLockLegalHold) SetStatus added in v1.30.20 

func (s *S3ObjectLockLegalHold) SetStatus(v string) *S3ObjectLockLegalHold

SetStatus sets the Status field's value.

func (S3ObjectLockLegalHold) String added in v1.30.20 

func (s S3ObjectLockLegalHold) String() string

String returns the string representation

func (*S3ObjectLockLegalHold) Validate added in v1.30.20 

func (s *S3ObjectLockLegalHold) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3ObjectMetadata added in v1.19.21 

type S3ObjectMetadata struct {
	CacheControl *string `min:"1" type:"string"`

	ContentDisposition *string `min:"1" type:"string"`

	ContentEncoding *string `min:"1" type:"string"`

	ContentLanguage *string `min:"1" type:"string"`

	ContentLength *int64 `type:"long"`

	ContentMD5 *string `min:"1" type:"string"`

	ContentType *string `min:"1" type:"string"`

	HttpExpiresDate *time.Time `type:"timestamp"`

	RequesterCharged *bool `type:"boolean"`

	SSEAlgorithm *string `type:"string" enum:"S3SSEAlgorithm"`

	UserMetadata map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (S3ObjectMetadata) GoString added in v1.19.21 

func (s S3ObjectMetadata) GoString() string

GoString returns the string representation

func (*S3ObjectMetadata) SetCacheControl added in v1.19.21 

func (s *S3ObjectMetadata) SetCacheControl(v string) *S3ObjectMetadata

SetCacheControl sets the CacheControl field's value.

func (*S3ObjectMetadata) SetContentDisposition added in v1.19.21 

func (s *S3ObjectMetadata) SetContentDisposition(v string) *S3ObjectMetadata

SetContentDisposition sets the ContentDisposition field's value.

func (*S3ObjectMetadata) SetContentEncoding added in v1.19.21 

func (s *S3ObjectMetadata) SetContentEncoding(v string) *S3ObjectMetadata

SetContentEncoding sets the ContentEncoding field's value.

func (*S3ObjectMetadata) SetContentLanguage added in v1.19.21 

func (s *S3ObjectMetadata) SetContentLanguage(v string) *S3ObjectMetadata

SetContentLanguage sets the ContentLanguage field's value.

func (*S3ObjectMetadata) SetContentLength added in v1.19.21 

func (s *S3ObjectMetadata) SetContentLength(v int64) *S3ObjectMetadata

SetContentLength sets the ContentLength field's value.

func (*S3ObjectMetadata) SetContentMD5 added in v1.19.21 

func (s *S3ObjectMetadata) SetContentMD5(v string) *S3ObjectMetadata

SetContentMD5 sets the ContentMD5 field's value.

func (*S3ObjectMetadata) SetContentType added in v1.19.21 

func (s *S3ObjectMetadata) SetContentType(v string) *S3ObjectMetadata

SetContentType sets the ContentType field's value.

func (*S3ObjectMetadata) SetHttpExpiresDate added in v1.19.21 

func (s *S3ObjectMetadata) SetHttpExpiresDate(v time.Time) *S3ObjectMetadata

SetHttpExpiresDate sets the HttpExpiresDate field's value.

func (*S3ObjectMetadata) SetRequesterCharged added in v1.19.21 

func (s *S3ObjectMetadata) SetRequesterCharged(v bool) *S3ObjectMetadata

SetRequesterCharged sets the RequesterCharged field's value.

func (*S3ObjectMetadata) SetSSEAlgorithm added in v1.19.21 

func (s *S3ObjectMetadata) SetSSEAlgorithm(v string) *S3ObjectMetadata

SetSSEAlgorithm sets the SSEAlgorithm field's value.

func (*S3ObjectMetadata) SetUserMetadata added in v1.19.21 

func (s *S3ObjectMetadata) SetUserMetadata(v map[string]*string) *S3ObjectMetadata

SetUserMetadata sets the UserMetadata field's value.

func (S3ObjectMetadata) String added in v1.19.21 

func (s S3ObjectMetadata) String() string

String returns the string representation

func (*S3ObjectMetadata) Validate added in v1.19.21 

func (s *S3ObjectMetadata) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3ObjectOwner added in v1.19.21 

type S3ObjectOwner struct {
	DisplayName *string `min:"1" type:"string"`

	ID *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (S3ObjectOwner) GoString added in v1.19.21 

func (s S3ObjectOwner) GoString() string

GoString returns the string representation

func (*S3ObjectOwner) SetDisplayName added in v1.19.21 

func (s *S3ObjectOwner) SetDisplayName(v string) *S3ObjectOwner

SetDisplayName sets the DisplayName field's value.

func (*S3ObjectOwner) SetID added in v1.19.21 

func (s *S3ObjectOwner) SetID(v string) *S3ObjectOwner

SetID sets the ID field's value.

func (S3ObjectOwner) String added in v1.19.21 

func (s S3ObjectOwner) String() string

String returns the string representation

func (*S3ObjectOwner) Validate added in v1.19.21 

func (s *S3ObjectOwner) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3Retention added in v1.30.20 

type S3Retention struct {

	// The Object Lock retention mode to be applied to all objects in the Batch
	// Operations job.
	Mode *string `type:"string" enum:"S3ObjectLockRetentionMode"`

	// The date when the applied Object Lock retention will expire on all objects
	// set by the Batch Operations job.
	RetainUntilDate *time.Time `type:"timestamp"`
	// 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 Simple Storage Service Developer Guide.

func (S3Retention) GoString added in v1.30.20 

func (s S3Retention) GoString() string

GoString returns the string representation

func (*S3Retention) SetMode added in v1.30.20 

func (s *S3Retention) SetMode(v string) *S3Retention

SetMode sets the Mode field's value.

func (*S3Retention) SetRetainUntilDate added in v1.30.20 

func (s *S3Retention) SetRetainUntilDate(v time.Time) *S3Retention

SetRetainUntilDate sets the RetainUntilDate field's value.

func (S3Retention) String added in v1.30.20 

func (s S3Retention) String() string

String returns the string representation

type S3SetObjectAclOperation added in v1.19.21 

type S3SetObjectAclOperation struct {
	AccessControlPolicy *S3AccessControlPolicy `type:"structure"`
	// contains filtered or unexported fields
}

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

func (S3SetObjectAclOperation) GoString added in v1.19.21 

func (s S3SetObjectAclOperation) GoString() string

GoString returns the string representation

func (*S3SetObjectAclOperation) SetAccessControlPolicy added in v1.19.21 

func (s *S3SetObjectAclOperation) SetAccessControlPolicy(v *S3AccessControlPolicy) *S3SetObjectAclOperation

SetAccessControlPolicy sets the AccessControlPolicy field's value.

func (S3SetObjectAclOperation) String added in v1.19.21 

func (s S3SetObjectAclOperation) String() string

String returns the string representation

func (*S3SetObjectAclOperation) Validate added in v1.19.21 

func (s *S3SetObjectAclOperation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3SetObjectLegalHoldOperation added in v1.30.20 

type S3SetObjectLegalHoldOperation struct {

	// Contains the Object Lock legal hold status to be applied to all objects in
	// the Batch Operations job.
	//
	// LegalHold is a required field
	LegalHold *S3ObjectLockLegalHold `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

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

func (S3SetObjectLegalHoldOperation) GoString added in v1.30.20 

func (s S3SetObjectLegalHoldOperation) GoString() string

GoString returns the string representation

func (*S3SetObjectLegalHoldOperation) SetLegalHold added in v1.30.20 

func (s *S3SetObjectLegalHoldOperation) SetLegalHold(v *S3ObjectLockLegalHold) *S3SetObjectLegalHoldOperation

SetLegalHold sets the LegalHold field's value.

func (S3SetObjectLegalHoldOperation) String added in v1.30.20 

func (s S3SetObjectLegalHoldOperation) String() string

String returns the string representation

func (*S3SetObjectLegalHoldOperation) Validate added in v1.30.20 

func (s *S3SetObjectLegalHoldOperation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3SetObjectRetentionOperation added in v1.30.20 

type S3SetObjectRetentionOperation struct {

	// 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 `type:"boolean"`

	// 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 Simple Storage Service Developer Guide.
	//
	// Retention is a required field
	Retention *S3Retention `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

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

func (S3SetObjectRetentionOperation) GoString added in v1.30.20 

func (s S3SetObjectRetentionOperation) GoString() string

GoString returns the string representation

func (*S3SetObjectRetentionOperation) SetBypassGovernanceRetention added in v1.30.20 

func (s *S3SetObjectRetentionOperation) SetBypassGovernanceRetention(v bool) *S3SetObjectRetentionOperation

SetBypassGovernanceRetention sets the BypassGovernanceRetention field's value.

func (*S3SetObjectRetentionOperation) SetRetention added in v1.30.20 

func (s *S3SetObjectRetentionOperation) SetRetention(v *S3Retention) *S3SetObjectRetentionOperation

SetRetention sets the Retention field's value.

func (S3SetObjectRetentionOperation) String added in v1.30.20 

func (s S3SetObjectRetentionOperation) String() string

String returns the string representation

func (*S3SetObjectRetentionOperation) Validate added in v1.30.20 

func (s *S3SetObjectRetentionOperation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3SetObjectTaggingOperation added in v1.19.21 

type S3SetObjectTaggingOperation struct {
	TagSet []*S3Tag `type:"list"`
	// contains filtered or unexported fields
}

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

func (S3SetObjectTaggingOperation) GoString added in v1.19.21 

func (s S3SetObjectTaggingOperation) GoString() string

GoString returns the string representation

func (*S3SetObjectTaggingOperation) SetTagSet added in v1.19.21 

func (s *S3SetObjectTaggingOperation) SetTagSet(v []*S3Tag) *S3SetObjectTaggingOperation

SetTagSet sets the TagSet field's value.

func (S3SetObjectTaggingOperation) String added in v1.19.21 

func (s S3SetObjectTaggingOperation) String() string

String returns the string representation

func (*S3SetObjectTaggingOperation) Validate added in v1.19.21 

func (s *S3SetObjectTaggingOperation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3Tag added in v1.19.21 

type S3Tag struct {

	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (S3Tag) GoString added in v1.19.21 

func (s S3Tag) GoString() string

GoString returns the string representation

func (*S3Tag) SetKey added in v1.19.21 

func (s *S3Tag) SetKey(v string) *S3Tag

SetKey sets the Key field's value.

func (*S3Tag) SetValue added in v1.19.21 

func (s *S3Tag) SetValue(v string) *S3Tag

SetValue sets the Value field's value.

func (S3Tag) String added in v1.19.21 

func (s S3Tag) String() string

String returns the string representation

func (*S3Tag) Validate added in v1.19.21 

func (s *S3Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Tagging added in v1.35.0 

type Tagging struct {

	// A collection for a set of tags.
	//
	// TagSet is a required field
	TagSet []*S3Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (Tagging) GoString added in v1.35.0 

func (s Tagging) GoString() string

GoString returns the string representation

func (*Tagging) SetTagSet added in v1.35.0 

func (s *Tagging) SetTagSet(v []*S3Tag) *Tagging

SetTagSet sets the TagSet field's value.

func (Tagging) String added in v1.35.0 

func (s Tagging) String() string

String returns the string representation

func (*Tagging) Validate added in v1.35.0 

func (s *Tagging) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Transition added in v1.35.0 

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 `type:"timestamp"`

	// Indicates the number of days after creation when objects are transitioned
	// to the specified storage class. The value must be a positive integer.
	Days *int64 `type:"integer"`

	// The storage class to which you want the object to transition.
	StorageClass *string `type:"string" enum:"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 Simple Storage Service Developer Guide.

func (Transition) GoString added in v1.35.0 

func (s Transition) GoString() string

GoString returns the string representation

func (*Transition) SetDate added in v1.35.0 

func (s *Transition) SetDate(v time.Time) *Transition

SetDate sets the Date field's value.

func (*Transition) SetDays added in v1.35.0 

func (s *Transition) SetDays(v int64) *Transition

SetDays sets the Days field's value.

func (*Transition) SetStorageClass added in v1.35.0 

func (s *Transition) SetStorageClass(v string) *Transition

SetStorageClass sets the StorageClass field's value.

func (Transition) String added in v1.35.0 

func (s Transition) String() string

String returns the string representation

type UpdateJobPriorityInput added in v1.19.21 

type UpdateJobPriorityInput struct {

	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The ID for the job whose priority you want to update.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"id" min:"5" type:"string" required:"true"`

	// The priority you want to assign to this job.
	//
	// Priority is a required field
	Priority *int64 `location:"querystring" locationName:"priority" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateJobPriorityInput) GoString added in v1.19.21 

func (s UpdateJobPriorityInput) GoString() string

GoString returns the string representation

func (*UpdateJobPriorityInput) SetAccountId added in v1.19.21 

func (s *UpdateJobPriorityInput) SetAccountId(v string) *UpdateJobPriorityInput

SetAccountId sets the AccountId field's value.

func (*UpdateJobPriorityInput) SetJobId added in v1.19.21 

func (s *UpdateJobPriorityInput) SetJobId(v string) *UpdateJobPriorityInput

SetJobId sets the JobId field's value.

func (*UpdateJobPriorityInput) SetPriority added in v1.19.21 

func (s *UpdateJobPriorityInput) SetPriority(v int64) *UpdateJobPriorityInput

SetPriority sets the Priority field's value.

func (UpdateJobPriorityInput) String added in v1.19.21 

func (s UpdateJobPriorityInput) String() string

String returns the string representation

func (*UpdateJobPriorityInput) Validate added in v1.19.21 

func (s *UpdateJobPriorityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateJobPriorityOutput added in v1.19.21 

type UpdateJobPriorityOutput struct {

	// The ID for the job whose priority Amazon S3 updated.
	//
	// JobId is a required field
	JobId *string `min:"5" type:"string" required:"true"`

	// The new priority assigned to the specified job.
	//
	// Priority is a required field
	Priority *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateJobPriorityOutput) GoString added in v1.19.21 

func (s UpdateJobPriorityOutput) GoString() string

GoString returns the string representation

func (*UpdateJobPriorityOutput) SetJobId added in v1.19.21 

func (s *UpdateJobPriorityOutput) SetJobId(v string) *UpdateJobPriorityOutput

SetJobId sets the JobId field's value.

func (*UpdateJobPriorityOutput) SetPriority added in v1.19.21 

func (s *UpdateJobPriorityOutput) SetPriority(v int64) *UpdateJobPriorityOutput

SetPriority sets the Priority field's value.

func (UpdateJobPriorityOutput) String added in v1.19.21 

func (s UpdateJobPriorityOutput) String() string

String returns the string representation

type UpdateJobStatusInput added in v1.19.21 

type UpdateJobStatusInput struct {

	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`

	// The ID of the job whose status you want to update.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"id" min:"5" type:"string" required:"true"`

	// The status that you want to move the specified job to.
	//
	// RequestedJobStatus is a required field
	RequestedJobStatus *string `location:"querystring" locationName:"requestedJobStatus" type:"string" required:"true" enum:"RequestedJobStatus"`

	// A description of the reason why you want to change the specified job's status.
	// This field can be any string up to the maximum length.
	StatusUpdateReason *string `location:"querystring" locationName:"statusUpdateReason" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateJobStatusInput) GoString added in v1.19.21 

func (s UpdateJobStatusInput) GoString() string

GoString returns the string representation

func (*UpdateJobStatusInput) SetAccountId added in v1.19.21 

func (s *UpdateJobStatusInput) SetAccountId(v string) *UpdateJobStatusInput

SetAccountId sets the AccountId field's value.

func (*UpdateJobStatusInput) SetJobId added in v1.19.21 

func (s *UpdateJobStatusInput) SetJobId(v string) *UpdateJobStatusInput

SetJobId sets the JobId field's value.

func (*UpdateJobStatusInput) SetRequestedJobStatus added in v1.19.21 

func (s *UpdateJobStatusInput) SetRequestedJobStatus(v string) *UpdateJobStatusInput

SetRequestedJobStatus sets the RequestedJobStatus field's value.

func (*UpdateJobStatusInput) SetStatusUpdateReason added in v1.19.21 

func (s *UpdateJobStatusInput) SetStatusUpdateReason(v string) *UpdateJobStatusInput

SetStatusUpdateReason sets the StatusUpdateReason field's value.

func (UpdateJobStatusInput) String added in v1.19.21 

func (s UpdateJobStatusInput) String() string

String returns the string representation

func (*UpdateJobStatusInput) Validate added in v1.19.21 

func (s *UpdateJobStatusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateJobStatusOutput added in v1.19.21 

type UpdateJobStatusOutput struct {

	// The ID for the job whose status was updated.
	JobId *string `min:"5" type:"string"`

	// The current status for the specified job.
	Status *string `type:"string" enum:"JobStatus"`

	// The reason that the specified job's status was updated.
	StatusUpdateReason *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateJobStatusOutput) GoString added in v1.19.21 

func (s UpdateJobStatusOutput) GoString() string

GoString returns the string representation

func (*UpdateJobStatusOutput) SetJobId added in v1.19.21 

func (s *UpdateJobStatusOutput) SetJobId(v string) *UpdateJobStatusOutput

SetJobId sets the JobId field's value.

func (*UpdateJobStatusOutput) SetStatus added in v1.19.21 

func (s *UpdateJobStatusOutput) SetStatus(v string) *UpdateJobStatusOutput

SetStatus sets the Status field's value.

func (*UpdateJobStatusOutput) SetStatusUpdateReason added in v1.19.21 

func (s *UpdateJobStatusOutput) SetStatusUpdateReason(v string) *UpdateJobStatusOutput

SetStatusUpdateReason sets the StatusUpdateReason field's value.

func (UpdateJobStatusOutput) String added in v1.19.21 

func (s UpdateJobStatusOutput) String() string

String returns the string representation

type VpcConfiguration added in v1.25.46 

type VpcConfiguration struct {

	// If this field is specified, this access point will only allow connections
	// from the specified VPC ID.
	//
	// VpcId is a required field
	VpcId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (VpcConfiguration) GoString added in v1.25.46 

func (s VpcConfiguration) GoString() string

GoString returns the string representation

func (*VpcConfiguration) SetVpcId added in v1.25.46 

func (s *VpcConfiguration) SetVpcId(v string) *VpcConfiguration

SetVpcId sets the VpcId field's value.

func (VpcConfiguration) String added in v1.25.46 

func (s VpcConfiguration) String() string

String returns the string representation

func (*VpcConfiguration) Validate added in v1.25.46 

func (s *VpcConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

Source Files

View all Source files

Directories

Path Synopsis
Package s3controliface provides an interface to enable mocking the AWS S3 Control service client for testing your code.
 Package s3controliface provides an interface to enable mocking the AWS S3 Control service client for testing your code.

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.