Documentation ¶
Overview ¶
Package s3control provides the API client, operations, and parameter types for AWS S3 Control.
Amazon Web Services S3 Control provides access to Amazon S3 control plane actions.
Index ¶
- Constants
- func GetHostIDMetadata(metadata middleware.Metadata) (string, bool)
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type Client
- func (c *Client) CreateAccessPoint(ctx context.Context, params *CreateAccessPointInput, optFns ...func(*Options)) (*CreateAccessPointOutput, error)
- func (c *Client) CreateAccessPointForObjectLambda(ctx context.Context, params *CreateAccessPointForObjectLambdaInput, ...) (*CreateAccessPointForObjectLambdaOutput, error)
- func (c *Client) CreateBucket(ctx context.Context, params *CreateBucketInput, optFns ...func(*Options)) (*CreateBucketOutput, error)
- func (c *Client) CreateJob(ctx context.Context, params *CreateJobInput, optFns ...func(*Options)) (*CreateJobOutput, error)
- func (c *Client) CreateMultiRegionAccessPoint(ctx context.Context, params *CreateMultiRegionAccessPointInput, ...) (*CreateMultiRegionAccessPointOutput, error)
- func (c *Client) DeleteAccessPoint(ctx context.Context, params *DeleteAccessPointInput, optFns ...func(*Options)) (*DeleteAccessPointOutput, error)
- func (c *Client) DeleteAccessPointForObjectLambda(ctx context.Context, params *DeleteAccessPointForObjectLambdaInput, ...) (*DeleteAccessPointForObjectLambdaOutput, error)
- func (c *Client) DeleteAccessPointPolicy(ctx context.Context, params *DeleteAccessPointPolicyInput, ...) (*DeleteAccessPointPolicyOutput, error)
- func (c *Client) DeleteAccessPointPolicyForObjectLambda(ctx context.Context, params *DeleteAccessPointPolicyForObjectLambdaInput, ...) (*DeleteAccessPointPolicyForObjectLambdaOutput, error)
- func (c *Client) DeleteBucket(ctx context.Context, params *DeleteBucketInput, optFns ...func(*Options)) (*DeleteBucketOutput, error)
- func (c *Client) DeleteBucketLifecycleConfiguration(ctx context.Context, params *DeleteBucketLifecycleConfigurationInput, ...) (*DeleteBucketLifecycleConfigurationOutput, error)
- func (c *Client) DeleteBucketPolicy(ctx context.Context, params *DeleteBucketPolicyInput, optFns ...func(*Options)) (*DeleteBucketPolicyOutput, error)
- func (c *Client) DeleteBucketTagging(ctx context.Context, params *DeleteBucketTaggingInput, ...) (*DeleteBucketTaggingOutput, error)
- func (c *Client) DeleteJobTagging(ctx context.Context, params *DeleteJobTaggingInput, optFns ...func(*Options)) (*DeleteJobTaggingOutput, error)
- func (c *Client) DeleteMultiRegionAccessPoint(ctx context.Context, params *DeleteMultiRegionAccessPointInput, ...) (*DeleteMultiRegionAccessPointOutput, error)
- func (c *Client) DeletePublicAccessBlock(ctx context.Context, params *DeletePublicAccessBlockInput, ...) (*DeletePublicAccessBlockOutput, error)
- func (c *Client) DeleteStorageLensConfiguration(ctx context.Context, params *DeleteStorageLensConfigurationInput, ...) (*DeleteStorageLensConfigurationOutput, error)
- func (c *Client) DeleteStorageLensConfigurationTagging(ctx context.Context, params *DeleteStorageLensConfigurationTaggingInput, ...) (*DeleteStorageLensConfigurationTaggingOutput, error)
- func (c *Client) DescribeJob(ctx context.Context, params *DescribeJobInput, optFns ...func(*Options)) (*DescribeJobOutput, error)
- func (c *Client) DescribeMultiRegionAccessPointOperation(ctx context.Context, params *DescribeMultiRegionAccessPointOperationInput, ...) (*DescribeMultiRegionAccessPointOperationOutput, error)
- func (c *Client) GetAccessPoint(ctx context.Context, params *GetAccessPointInput, optFns ...func(*Options)) (*GetAccessPointOutput, error)
- func (c *Client) GetAccessPointConfigurationForObjectLambda(ctx context.Context, params *GetAccessPointConfigurationForObjectLambdaInput, ...) (*GetAccessPointConfigurationForObjectLambdaOutput, error)
- func (c *Client) GetAccessPointForObjectLambda(ctx context.Context, params *GetAccessPointForObjectLambdaInput, ...) (*GetAccessPointForObjectLambdaOutput, error)
- func (c *Client) GetAccessPointPolicy(ctx context.Context, params *GetAccessPointPolicyInput, ...) (*GetAccessPointPolicyOutput, error)
- func (c *Client) GetAccessPointPolicyForObjectLambda(ctx context.Context, params *GetAccessPointPolicyForObjectLambdaInput, ...) (*GetAccessPointPolicyForObjectLambdaOutput, error)
- func (c *Client) GetAccessPointPolicyStatus(ctx context.Context, params *GetAccessPointPolicyStatusInput, ...) (*GetAccessPointPolicyStatusOutput, error)
- func (c *Client) GetAccessPointPolicyStatusForObjectLambda(ctx context.Context, params *GetAccessPointPolicyStatusForObjectLambdaInput, ...) (*GetAccessPointPolicyStatusForObjectLambdaOutput, error)
- func (c *Client) GetBucket(ctx context.Context, params *GetBucketInput, optFns ...func(*Options)) (*GetBucketOutput, error)
- func (c *Client) GetBucketLifecycleConfiguration(ctx context.Context, params *GetBucketLifecycleConfigurationInput, ...) (*GetBucketLifecycleConfigurationOutput, error)
- func (c *Client) GetBucketPolicy(ctx context.Context, params *GetBucketPolicyInput, optFns ...func(*Options)) (*GetBucketPolicyOutput, error)
- func (c *Client) GetBucketTagging(ctx context.Context, params *GetBucketTaggingInput, optFns ...func(*Options)) (*GetBucketTaggingOutput, error)
- func (c *Client) GetJobTagging(ctx context.Context, params *GetJobTaggingInput, optFns ...func(*Options)) (*GetJobTaggingOutput, error)
- func (c *Client) GetMultiRegionAccessPoint(ctx context.Context, params *GetMultiRegionAccessPointInput, ...) (*GetMultiRegionAccessPointOutput, error)
- func (c *Client) GetMultiRegionAccessPointPolicy(ctx context.Context, params *GetMultiRegionAccessPointPolicyInput, ...) (*GetMultiRegionAccessPointPolicyOutput, error)
- func (c *Client) GetMultiRegionAccessPointPolicyStatus(ctx context.Context, params *GetMultiRegionAccessPointPolicyStatusInput, ...) (*GetMultiRegionAccessPointPolicyStatusOutput, error)
- func (c *Client) GetPublicAccessBlock(ctx context.Context, params *GetPublicAccessBlockInput, ...) (*GetPublicAccessBlockOutput, error)
- func (c *Client) GetStorageLensConfiguration(ctx context.Context, params *GetStorageLensConfigurationInput, ...) (*GetStorageLensConfigurationOutput, error)
- func (c *Client) GetStorageLensConfigurationTagging(ctx context.Context, params *GetStorageLensConfigurationTaggingInput, ...) (*GetStorageLensConfigurationTaggingOutput, error)
- func (c *Client) ListAccessPoints(ctx context.Context, params *ListAccessPointsInput, optFns ...func(*Options)) (*ListAccessPointsOutput, error)
- func (c *Client) ListAccessPointsForObjectLambda(ctx context.Context, params *ListAccessPointsForObjectLambdaInput, ...) (*ListAccessPointsForObjectLambdaOutput, error)
- func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ...func(*Options)) (*ListJobsOutput, error)
- func (c *Client) ListMultiRegionAccessPoints(ctx context.Context, params *ListMultiRegionAccessPointsInput, ...) (*ListMultiRegionAccessPointsOutput, error)
- func (c *Client) ListRegionalBuckets(ctx context.Context, params *ListRegionalBucketsInput, ...) (*ListRegionalBucketsOutput, error)
- func (c *Client) ListStorageLensConfigurations(ctx context.Context, params *ListStorageLensConfigurationsInput, ...) (*ListStorageLensConfigurationsOutput, error)
- func (c *Client) PutAccessPointConfigurationForObjectLambda(ctx context.Context, params *PutAccessPointConfigurationForObjectLambdaInput, ...) (*PutAccessPointConfigurationForObjectLambdaOutput, error)
- func (c *Client) PutAccessPointPolicy(ctx context.Context, params *PutAccessPointPolicyInput, ...) (*PutAccessPointPolicyOutput, error)
- func (c *Client) PutAccessPointPolicyForObjectLambda(ctx context.Context, params *PutAccessPointPolicyForObjectLambdaInput, ...) (*PutAccessPointPolicyForObjectLambdaOutput, error)
- func (c *Client) PutBucketLifecycleConfiguration(ctx context.Context, params *PutBucketLifecycleConfigurationInput, ...) (*PutBucketLifecycleConfigurationOutput, error)
- func (c *Client) PutBucketPolicy(ctx context.Context, params *PutBucketPolicyInput, optFns ...func(*Options)) (*PutBucketPolicyOutput, error)
- func (c *Client) PutBucketTagging(ctx context.Context, params *PutBucketTaggingInput, optFns ...func(*Options)) (*PutBucketTaggingOutput, error)
- func (c *Client) PutJobTagging(ctx context.Context, params *PutJobTaggingInput, optFns ...func(*Options)) (*PutJobTaggingOutput, error)
- func (c *Client) PutMultiRegionAccessPointPolicy(ctx context.Context, params *PutMultiRegionAccessPointPolicyInput, ...) (*PutMultiRegionAccessPointPolicyOutput, error)
- func (c *Client) PutPublicAccessBlock(ctx context.Context, params *PutPublicAccessBlockInput, ...) (*PutPublicAccessBlockOutput, error)
- func (c *Client) PutStorageLensConfiguration(ctx context.Context, params *PutStorageLensConfigurationInput, ...) (*PutStorageLensConfigurationOutput, error)
- func (c *Client) PutStorageLensConfigurationTagging(ctx context.Context, params *PutStorageLensConfigurationTaggingInput, ...) (*PutStorageLensConfigurationTaggingOutput, error)
- func (c *Client) UpdateJobPriority(ctx context.Context, params *UpdateJobPriorityInput, optFns ...func(*Options)) (*UpdateJobPriorityOutput, error)
- func (c *Client) UpdateJobStatus(ctx context.Context, params *UpdateJobStatusInput, optFns ...func(*Options)) (*UpdateJobStatusOutput, error)
- type CreateAccessPointForObjectLambdaInput
- type CreateAccessPointForObjectLambdaOutput
- type CreateAccessPointInput
- type CreateAccessPointOutput
- type CreateBucketInput
- type CreateBucketOutput
- type CreateJobInput
- type CreateJobOutput
- type CreateMultiRegionAccessPointInput
- type CreateMultiRegionAccessPointOutput
- type DeleteAccessPointForObjectLambdaInput
- type DeleteAccessPointForObjectLambdaOutput
- type DeleteAccessPointInput
- type DeleteAccessPointOutput
- type DeleteAccessPointPolicyForObjectLambdaInput
- type DeleteAccessPointPolicyForObjectLambdaOutput
- type DeleteAccessPointPolicyInput
- type DeleteAccessPointPolicyOutput
- type DeleteBucketInput
- type DeleteBucketLifecycleConfigurationInput
- type DeleteBucketLifecycleConfigurationOutput
- type DeleteBucketOutput
- type DeleteBucketPolicyInput
- type DeleteBucketPolicyOutput
- type DeleteBucketTaggingInput
- type DeleteBucketTaggingOutput
- type DeleteJobTaggingInput
- type DeleteJobTaggingOutput
- type DeleteMultiRegionAccessPointInput
- type DeleteMultiRegionAccessPointOutput
- type DeletePublicAccessBlockInput
- type DeletePublicAccessBlockOutput
- type DeleteStorageLensConfigurationInput
- type DeleteStorageLensConfigurationOutput
- type DeleteStorageLensConfigurationTaggingInput
- type DeleteStorageLensConfigurationTaggingOutput
- type DescribeJobInput
- type DescribeJobOutput
- type DescribeMultiRegionAccessPointOperationInput
- type DescribeMultiRegionAccessPointOperationOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type GetAccessPointConfigurationForObjectLambdaInput
- type GetAccessPointConfigurationForObjectLambdaOutput
- type GetAccessPointForObjectLambdaInput
- type GetAccessPointForObjectLambdaOutput
- type GetAccessPointInput
- type GetAccessPointOutput
- type GetAccessPointPolicyForObjectLambdaInput
- type GetAccessPointPolicyForObjectLambdaOutput
- type GetAccessPointPolicyInput
- type GetAccessPointPolicyOutput
- type GetAccessPointPolicyStatusForObjectLambdaInput
- type GetAccessPointPolicyStatusForObjectLambdaOutput
- type GetAccessPointPolicyStatusInput
- type GetAccessPointPolicyStatusOutput
- type GetBucketInput
- type GetBucketLifecycleConfigurationInput
- type GetBucketLifecycleConfigurationOutput
- type GetBucketOutput
- type GetBucketPolicyInput
- type GetBucketPolicyOutput
- type GetBucketTaggingInput
- type GetBucketTaggingOutput
- type GetJobTaggingInput
- type GetJobTaggingOutput
- type GetMultiRegionAccessPointInput
- type GetMultiRegionAccessPointOutput
- type GetMultiRegionAccessPointPolicyInput
- type GetMultiRegionAccessPointPolicyOutput
- type GetMultiRegionAccessPointPolicyStatusInput
- type GetMultiRegionAccessPointPolicyStatusOutput
- type GetPublicAccessBlockInput
- type GetPublicAccessBlockOutput
- type GetStorageLensConfigurationInput
- type GetStorageLensConfigurationOutput
- type GetStorageLensConfigurationTaggingInput
- type GetStorageLensConfigurationTaggingOutput
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type ListAccessPointsAPIClient
- type ListAccessPointsForObjectLambdaAPIClient
- type ListAccessPointsForObjectLambdaInput
- type ListAccessPointsForObjectLambdaOutput
- type ListAccessPointsForObjectLambdaPaginator
- type ListAccessPointsForObjectLambdaPaginatorOptions
- type ListAccessPointsInput
- type ListAccessPointsOutput
- type ListAccessPointsPaginator
- type ListAccessPointsPaginatorOptions
- type ListJobsAPIClient
- type ListJobsInput
- type ListJobsOutput
- type ListJobsPaginator
- type ListJobsPaginatorOptions
- type ListMultiRegionAccessPointsAPIClient
- type ListMultiRegionAccessPointsInput
- type ListMultiRegionAccessPointsOutput
- type ListMultiRegionAccessPointsPaginator
- type ListMultiRegionAccessPointsPaginatorOptions
- type ListRegionalBucketsAPIClient
- type ListRegionalBucketsInput
- type ListRegionalBucketsOutput
- type ListRegionalBucketsPaginator
- type ListRegionalBucketsPaginatorOptions
- type ListStorageLensConfigurationsAPIClient
- type ListStorageLensConfigurationsInput
- type ListStorageLensConfigurationsOutput
- type ListStorageLensConfigurationsPaginator
- type ListStorageLensConfigurationsPaginatorOptions
- type Options
- type PutAccessPointConfigurationForObjectLambdaInput
- type PutAccessPointConfigurationForObjectLambdaOutput
- type PutAccessPointPolicyForObjectLambdaInput
- type PutAccessPointPolicyForObjectLambdaOutput
- type PutAccessPointPolicyInput
- type PutAccessPointPolicyOutput
- type PutBucketLifecycleConfigurationInput
- type PutBucketLifecycleConfigurationOutput
- type PutBucketPolicyInput
- type PutBucketPolicyOutput
- type PutBucketTaggingInput
- type PutBucketTaggingOutput
- type PutJobTaggingInput
- type PutJobTaggingOutput
- type PutMultiRegionAccessPointPolicyInput
- type PutMultiRegionAccessPointPolicyOutput
- type PutPublicAccessBlockInput
- type PutPublicAccessBlockOutput
- type PutStorageLensConfigurationInput
- type PutStorageLensConfigurationOutput
- type PutStorageLensConfigurationTaggingInput
- type PutStorageLensConfigurationTaggingOutput
- type ResolveEndpoint
- type ResponseError
- type UpdateJobPriorityInput
- type UpdateJobPriorityOutput
- type UpdateJobStatusInput
- type UpdateJobStatusOutput
Constants ¶
const ServiceAPIVersion = "2018-08-20"
const ServiceID = "S3 Control"
Variables ¶
This section is empty.
Functions ¶
func GetHostIDMetadata ¶ added in v0.31.0
func GetHostIDMetadata(metadata middleware.Metadata) (string, bool)
GetHostIDMetadata retrieves the host id from middleware metadata returns host id as string along with a boolean indicating presence of hostId on middleware metadata.
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶ added in v1.0.0
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver ¶
func WithEndpointResolver(v EndpointResolver) func(*Options)
WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS S3 Control.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) CreateAccessPoint ¶
func (c *Client) CreateAccessPoint(ctx context.Context, params *CreateAccessPointInput, optFns ...func(*Options)) (*CreateAccessPointOutput, error)
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/userguide/access-points.html) in the Amazon S3 User Guide. S3 on Outposts only supports VPC-style access points. For more information, see Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the Amazon S3 User Guide. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-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 x-amz-outpost-id derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html#API_control_CreateAccessPoint_Examples) section. The following actions are related to CreateAccessPoint:
* GetAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html)
* DeleteAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html)
* ListAccessPoints (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html)
func (*Client) CreateAccessPointForObjectLambda ¶ added in v1.3.0
func (c *Client) CreateAccessPointForObjectLambda(ctx context.Context, params *CreateAccessPointForObjectLambdaInput, optFns ...func(*Options)) (*CreateAccessPointForObjectLambdaOutput, error)
Creates an Object Lambda Access Point. For more information, see Transforming objects with Object Lambda Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html) in the Amazon S3 User Guide. The following actions are related to CreateAccessPointForObjectLambda:
* DeleteAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html)
* GetAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html)
* ListAccessPointsForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html)
func (*Client) CreateBucket ¶
func (c *Client) CreateBucket(ctx context.Context, params *CreateBucketInput, optFns ...func(*Options)) (*CreateBucketOutput, error)
This action 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 S3 API Reference. 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/userguide/S3onOutposts.html) in Amazon S3 User 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/userguide/BucketRestrictions.html#bucketnamingrules). S3 on Outposts buckets support:
* Tags
* LifecycleConfigurations for deleting expired objects
For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see Amazon S3 on Outposts Restrictions and Limitations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OnOutpostsRestrictionsLimitations.html). For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and x-amz-outpost-id in your API request, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html#API_control_CreateBucket_Examples) section. The following actions are related to CreateBucket for Amazon S3 on Outposts:
* PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
* GetBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html)
* DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html)
* CreateAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html)
* PutAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html)
func (*Client) CreateJob ¶
func (c *Client) CreateJob(ctx context.Context, params *CreateJobInput, optFns ...func(*Options)) (*CreateJobOutput, error)
You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects. Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html) in the Amazon S3 User Guide. This action creates a S3 Batch Operations job. Related actions include:
* DescribeJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html)
* ListJobs (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html)
* UpdateJobPriority (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html)
* UpdateJobStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html)
* JobOperation (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_JobOperation.html)
func (*Client) CreateMultiRegionAccessPoint ¶ added in v1.11.0
func (c *Client) CreateMultiRegionAccessPoint(ctx context.Context, params *CreateMultiRegionAccessPointInput, optFns ...func(*Options)) (*CreateMultiRegionAccessPointOutput, error)
Creates a Multi-Region Access Point and associates it with the specified buckets. For more information about creating Multi-Region Access Points, see Creating Multi-Region Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html) in the Amazon S3 User Guide. This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) in the Amazon S3 User Guide. This request is asynchronous, meaning that you might receive a response before the command has completed. When this request provides a response, it provides a token that you can use to monitor the status of the request with DescribeMultiRegionAccessPointOperation. The following actions are related to CreateMultiRegionAccessPoint:
* DeleteMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html)
* DescribeMultiRegionAccessPointOperation (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html)
* GetMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html)
* ListMultiRegionAccessPoints (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html)
func (*Client) DeleteAccessPoint ¶
func (c *Client) DeleteAccessPoint(ctx context.Context, params *DeleteAccessPointInput, optFns ...func(*Options)) (*DeleteAccessPointOutput, error)
Deletes the specified access point. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-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 x-amz-outpost-id derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html#API_control_DeleteAccessPoint_Examples) section. The following actions are related to DeleteAccessPoint:
* CreateAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html)
* GetAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html)
* ListAccessPoints (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html)
func (*Client) DeleteAccessPointForObjectLambda ¶ added in v1.3.0
func (c *Client) DeleteAccessPointForObjectLambda(ctx context.Context, params *DeleteAccessPointForObjectLambdaInput, optFns ...func(*Options)) (*DeleteAccessPointForObjectLambdaOutput, error)
Deletes the specified Object Lambda Access Point. The following actions are related to DeleteAccessPointForObjectLambda:
* CreateAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html)
* GetAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html)
* ListAccessPointsForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html)
func (*Client) DeleteAccessPointPolicy ¶
func (c *Client) DeleteAccessPointPolicy(ctx context.Context, params *DeleteAccessPointPolicyInput, optFns ...func(*Options)) (*DeleteAccessPointPolicyOutput, error)
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 x-amz-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 x-amz-outpost-id derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html#API_control_DeleteAccessPointPolicy_Examples) section. The following actions are related to DeleteAccessPointPolicy:
* PutAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html)
* GetAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicy.html)
func (*Client) DeleteAccessPointPolicyForObjectLambda ¶ added in v1.3.0
func (c *Client) DeleteAccessPointPolicyForObjectLambda(ctx context.Context, params *DeleteAccessPointPolicyForObjectLambdaInput, optFns ...func(*Options)) (*DeleteAccessPointPolicyForObjectLambdaOutput, error)
Removes the resource policy for an Object Lambda Access Point. The following actions are related to DeleteAccessPointPolicyForObjectLambda:
* GetAccessPointPolicyForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicyForObjectLambda.html)
* PutAccessPointPolicyForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicyForObjectLambda.html)
func (*Client) DeleteBucket ¶
func (c *Client) DeleteBucket(ctx context.Context, params *DeleteBucketInput, optFns ...func(*Options)) (*DeleteBucketOutput, error)
This action 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 S3 API Reference. 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/userguide/S3onOutposts.html) in Amazon S3 User Guide. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-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 x-amz-outpost-id derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html#API_control_DeleteBucket_Examples) section. Related Resources
* CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html)
* GetBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html)
* DeleteObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)
func (*Client) DeleteBucketLifecycleConfiguration ¶
func (c *Client) DeleteBucketLifecycleConfiguration(ctx context.Context, params *DeleteBucketLifecycleConfigurationInput, optFns ...func(*Options)) (*DeleteBucketLifecycleConfigurationOutput, error)
This 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 S3 API Reference. 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/userguide/S3onOutposts.html) in Amazon S3 User Guide. To use this action, you must have permission to perform the s3-outposts: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 x-amz-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 x-amz-outpost-id derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html#API_control_DeleteBucketLifecycleConfiguration_Examples) section. 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:
* PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html)
* GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html)
func (*Client) DeleteBucketPolicy ¶
func (c *Client) DeleteBucketPolicy(ctx context.Context, params *DeleteBucketPolicyInput, optFns ...func(*Options)) (*DeleteBucketPolicyOutput, error)
This action 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 S3 API Reference. This implementation of the DELETE action 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 Amazon Web Services account that owns the bucket, the calling identity must have the s3-outposts:DeleteBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account to use this action. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in Amazon S3 User 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 Amazon Web Services account that owns a bucket can always use this action, 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 x-amz-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 x-amz-outpost-id derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html#API_control_DeleteBucketPolicy_Examples) section. The following actions are related to DeleteBucketPolicy:
* GetBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html)
* PutBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html)
func (*Client) DeleteBucketTagging ¶
func (c *Client) DeleteBucketTagging(ctx context.Context, params *DeleteBucketTaggingInput, optFns ...func(*Options)) (*DeleteBucketTaggingOutput, error)
This action 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 S3 API Reference. Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in Amazon S3 User Guide. To use this action, 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 x-amz-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 x-amz-outpost-id derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html#API_control_DeleteBucketTagging_Examples) section. The following actions are related to DeleteBucketTagging:
* GetBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html)
* PutBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html)
func (*Client) DeleteJobTagging ¶
func (c *Client) DeleteJobTagging(ctx context.Context, params *DeleteJobTaggingInput, optFns ...func(*Options)) (*DeleteJobTaggingOutput, error)
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 S3 User Guide. Related actions include:
* CreateJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html)
* GetJobTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html)
* PutJobTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutJobTagging.html)
func (*Client) DeleteMultiRegionAccessPoint ¶ added in v1.11.0
func (c *Client) DeleteMultiRegionAccessPoint(ctx context.Context, params *DeleteMultiRegionAccessPointInput, optFns ...func(*Options)) (*DeleteMultiRegionAccessPointOutput, error)
Deletes a Multi-Region Access Point. This action does not delete the buckets associated with the Multi-Region Access Point, only the Multi-Region Access Point itself. This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) in the Amazon S3 User Guide. This request is asynchronous, meaning that you might receive a response before the command has completed. When this request provides a response, it provides a token that you can use to monitor the status of the request with DescribeMultiRegionAccessPointOperation. The following actions are related to DeleteMultiRegionAccessPoint:
* CreateMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html)
* DescribeMultiRegionAccessPointOperation (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html)
* GetMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html)
* ListMultiRegionAccessPoints (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html)
func (*Client) DeletePublicAccessBlock ¶
func (c *Client) DeletePublicAccessBlock(ctx context.Context, params *DeletePublicAccessBlockInput, optFns ...func(*Options)) (*DeletePublicAccessBlockOutput, error)
Removes the PublicAccessBlock configuration for an Amazon Web Services 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:
* GetPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetPublicAccessBlock.html)
* PutPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutPublicAccessBlock.html)
func (*Client) DeleteStorageLensConfiguration ¶ added in v0.30.0
func (c *Client) DeleteStorageLensConfiguration(ctx context.Context, params *DeleteStorageLensConfigurationInput, optFns ...func(*Options)) (*DeleteStorageLensConfigurationOutput, error)
Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) in the Amazon S3 User Guide. To use this action, you must have permission to perform the s3:DeleteStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) in the Amazon S3 User Guide.
func (*Client) DeleteStorageLensConfigurationTagging ¶ added in v0.30.0
func (c *Client) DeleteStorageLensConfigurationTagging(ctx context.Context, params *DeleteStorageLensConfigurationTaggingInput, optFns ...func(*Options)) (*DeleteStorageLensConfigurationTaggingOutput, error)
Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) in the Amazon S3 User Guide. To use this action, you must have permission to perform the s3:DeleteStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) in the Amazon S3 User Guide.
func (*Client) DescribeJob ¶
func (c *Client) DescribeJob(ctx context.Context, params *DescribeJobInput, optFns ...func(*Options)) (*DescribeJobOutput, error)
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/userguide/batch-ops.html) in the Amazon S3 User Guide. Related actions include:
* CreateJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html)
* ListJobs (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html)
* UpdateJobPriority (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html)
* UpdateJobStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html)
func (*Client) DescribeMultiRegionAccessPointOperation ¶ added in v1.11.0
func (c *Client) DescribeMultiRegionAccessPointOperation(ctx context.Context, params *DescribeMultiRegionAccessPointOperationInput, optFns ...func(*Options)) (*DescribeMultiRegionAccessPointOperationOutput, error)
Retrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information about managing Multi-Region Access Points and how asynchronous requests work, see Managing Multi-Region Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) in the Amazon S3 User Guide. The following actions are related to GetMultiRegionAccessPoint:
* CreateMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html)
* DeleteMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html)
* GetMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html)
* ListMultiRegionAccessPoints (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html)
func (*Client) GetAccessPoint ¶
func (c *Client) GetAccessPoint(ctx context.Context, params *GetAccessPointInput, optFns ...func(*Options)) (*GetAccessPointOutput, error)
Returns configuration information about the specified access point. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-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 x-amz-outpost-id derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples) section. The following actions are related to GetAccessPoint:
* CreateAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html)
* DeleteAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html)
* ListAccessPoints (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html)
func (*Client) GetAccessPointConfigurationForObjectLambda ¶ added in v1.3.0
func (c *Client) GetAccessPointConfigurationForObjectLambda(ctx context.Context, params *GetAccessPointConfigurationForObjectLambdaInput, optFns ...func(*Options)) (*GetAccessPointConfigurationForObjectLambdaOutput, error)
Returns configuration for an Object Lambda Access Point. The following actions are related to GetAccessPointConfigurationForObjectLambda:
* PutAccessPointConfigurationForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointConfigurationForObjectLambda.html)
func (*Client) GetAccessPointForObjectLambda ¶ added in v1.3.0
func (c *Client) GetAccessPointForObjectLambda(ctx context.Context, params *GetAccessPointForObjectLambdaInput, optFns ...func(*Options)) (*GetAccessPointForObjectLambdaOutput, error)
Returns configuration information about the specified Object Lambda Access Point The following actions are related to GetAccessPointForObjectLambda:
* CreateAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html)
* DeleteAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html)
* ListAccessPointsForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html)
func (*Client) GetAccessPointPolicy ¶
func (c *Client) GetAccessPointPolicy(ctx context.Context, params *GetAccessPointPolicyInput, optFns ...func(*Options)) (*GetAccessPointPolicyOutput, error)
Returns the access point policy associated with the specified access point. The following actions are related to GetAccessPointPolicy:
* PutAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html)
* DeleteAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html)
func (*Client) GetAccessPointPolicyForObjectLambda ¶ added in v1.3.0
func (c *Client) GetAccessPointPolicyForObjectLambda(ctx context.Context, params *GetAccessPointPolicyForObjectLambdaInput, optFns ...func(*Options)) (*GetAccessPointPolicyForObjectLambdaOutput, error)
Returns the resource policy for an Object Lambda Access Point. The following actions are related to GetAccessPointPolicyForObjectLambda:
* DeleteAccessPointPolicyForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicyForObjectLambda.html)
* PutAccessPointPolicyForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicyForObjectLambda.html)
func (*Client) GetAccessPointPolicyStatus ¶
func (c *Client) GetAccessPointPolicyStatus(ctx context.Context, params *GetAccessPointPolicyStatusInput, optFns ...func(*Options)) (*GetAccessPointPolicyStatusOutput, error)
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/userguide/access-points.html) in the Amazon S3 User Guide.
func (*Client) GetAccessPointPolicyStatusForObjectLambda ¶ added in v1.3.0
func (c *Client) GetAccessPointPolicyStatusForObjectLambda(ctx context.Context, params *GetAccessPointPolicyStatusForObjectLambdaInput, optFns ...func(*Options)) (*GetAccessPointPolicyStatusForObjectLambdaOutput, error)
Returns the status of the resource policy associated with an Object Lambda Access Point.
func (*Client) GetBucket ¶
func (c *Client) GetBucket(ctx context.Context, params *GetBucketInput, optFns ...func(*Options)) (*GetBucketOutput, error)
Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the Amazon S3 User Guide. If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the s3-outposts:GetBucket permissions on the specified Outposts bucket and belong to the Outposts bucket owner's account in order to use this action. Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. If you don't have s3-outposts:GetBucket permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error. The following actions are related to GetBucket for Amazon S3 on Outposts: All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-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 x-amz-outpost-id derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html#API_control_GetBucket_Examples) section.
* PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
* CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html)
* DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html)
func (*Client) GetBucketLifecycleConfiguration ¶
func (c *Client) GetBucketLifecycleConfiguration(ctx context.Context, params *GetBucketLifecycleConfigurationInput, optFns ...func(*Options)) (*GetBucketLifecycleConfigurationOutput, error)
This action 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 S3 API Reference. 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/userguide/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 S3 User Guide. To use this action, you must have permission to perform the s3-outposts: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/userguide/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/userguide/s3-access-control.html). All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-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 x-amz-outpost-id derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html#API_control_GetBucketLifecycleConfiguration_Examples) section. 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:
* PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html)
* DeleteBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html)
func (*Client) GetBucketPolicy ¶
func (c *Client) GetBucketPolicy(ctx context.Context, params *GetBucketPolicyInput, optFns ...func(*Options)) (*GetBucketPolicyOutput, error)
This 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 S3 API Reference. Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the Amazon S3 User Guide. If you are using an identity other than the root user of the Amazon Web Services 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 action. Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. If you don't have s3-outposts:GetBucketPolicy permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error. As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, 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 x-amz-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 x-amz-outpost-id derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html#API_control_GetBucketPolicy_Examples) section. The following actions are related to GetBucketPolicy:
* GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
* PutBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html)
* DeleteBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html)
func (*Client) GetBucketTagging ¶
func (c *Client) GetBucketTagging(ctx context.Context, params *GetBucketTaggingInput, optFns ...func(*Options)) (*GetBucketTaggingOutput, error)
This action 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 S3 API Reference. 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/userguide/S3onOutposts.html) in the Amazon S3 User Guide. To use this action, 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 x-amz-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 x-amz-outpost-id derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html#API_control_GetBucketTagging_Examples) section. The following actions are related to GetBucketTagging:
* PutBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html)
* DeleteBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html)
func (*Client) GetJobTagging ¶
func (c *Client) GetJobTagging(ctx context.Context, params *GetJobTaggingInput, optFns ...func(*Options)) (*GetJobTaggingOutput, error)
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 S3 User Guide. Related actions include:
* CreateJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html)
* PutJobTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutJobTagging.html)
* DeleteJobTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html)
func (*Client) GetMultiRegionAccessPoint ¶ added in v1.11.0
func (c *Client) GetMultiRegionAccessPoint(ctx context.Context, params *GetMultiRegionAccessPointInput, optFns ...func(*Options)) (*GetMultiRegionAccessPointOutput, error)
Returns configuration information about the specified Multi-Region Access Point. This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) in the Amazon S3 User Guide. The following actions are related to GetMultiRegionAccessPoint:
* CreateMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html)
* DeleteMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html)
* DescribeMultiRegionAccessPointOperation (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html)
* ListMultiRegionAccessPoints (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html)
func (*Client) GetMultiRegionAccessPointPolicy ¶ added in v1.11.0
func (c *Client) GetMultiRegionAccessPointPolicy(ctx context.Context, params *GetMultiRegionAccessPointPolicyInput, optFns ...func(*Options)) (*GetMultiRegionAccessPointPolicyOutput, error)
Returns the access control policy of the specified Multi-Region Access Point. This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) in the Amazon S3 User Guide. The following actions are related to GetMultiRegionAccessPointPolicy:
* GetMultiRegionAccessPointPolicyStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicyStatus.html)
* PutMultiRegionAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPointPolicy.html)
func (*Client) GetMultiRegionAccessPointPolicyStatus ¶ added in v1.11.0
func (c *Client) GetMultiRegionAccessPointPolicyStatus(ctx context.Context, params *GetMultiRegionAccessPointPolicyStatusInput, optFns ...func(*Options)) (*GetMultiRegionAccessPointPolicyStatusOutput, error)
Indicates whether the specified Multi-Region Access Point has an access control policy that allows public access. This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) in the Amazon S3 User Guide. The following actions are related to GetMultiRegionAccessPointPolicyStatus:
* GetMultiRegionAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicy.html)
* PutMultiRegionAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPointPolicy.html)
func (*Client) GetPublicAccessBlock ¶
func (c *Client) GetPublicAccessBlock(ctx context.Context, params *GetPublicAccessBlockInput, optFns ...func(*Options)) (*GetPublicAccessBlockOutput, error)
Retrieves the PublicAccessBlock configuration for an Amazon Web Services 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:
* DeletePublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeletePublicAccessBlock.html)
* PutPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutPublicAccessBlock.html)
func (*Client) GetStorageLensConfiguration ¶ added in v0.30.0
func (c *Client) GetStorageLensConfiguration(ctx context.Context, params *GetStorageLensConfigurationInput, optFns ...func(*Options)) (*GetStorageLensConfigurationOutput, error)
Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage activity and usage with Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) in the Amazon S3 User Guide. To use this action, you must have permission to perform the s3:GetStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) in the Amazon S3 User Guide.
func (*Client) GetStorageLensConfigurationTagging ¶ added in v0.30.0
func (c *Client) GetStorageLensConfigurationTagging(ctx context.Context, params *GetStorageLensConfigurationTaggingInput, optFns ...func(*Options)) (*GetStorageLensConfigurationTaggingOutput, error)
Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) in the Amazon S3 User Guide. To use this action, you must have permission to perform the s3:GetStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) in the Amazon S3 User Guide.
func (*Client) ListAccessPoints ¶
func (c *Client) ListAccessPoints(ctx context.Context, params *ListAccessPointsInput, optFns ...func(*Options)) (*ListAccessPointsOutput, error)
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 x-amz-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 x-amz-outpost-id derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples) section. The following actions are related to ListAccessPoints:
* CreateAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html)
* DeleteAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html)
* GetAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html)
func (*Client) ListAccessPointsForObjectLambda ¶ added in v1.3.0
func (c *Client) ListAccessPointsForObjectLambda(ctx context.Context, params *ListAccessPointsForObjectLambdaInput, optFns ...func(*Options)) (*ListAccessPointsForObjectLambdaOutput, error)
Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call. If there are more access points than what can be returned in one call, the response will include a continuation token that you can use to list the additional access points. The following actions are related to ListAccessPointsForObjectLambda:
* CreateAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html)
* DeleteAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html)
* GetAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html)
func (*Client) ListJobs ¶
func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ...func(*Options)) (*ListJobsOutput, error)
Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the Amazon Web Services account making the request. For more information, see S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html) in the Amazon S3 User Guide. Related actions include:
* CreateJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html)
* DescribeJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html)
* UpdateJobPriority (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html)
* UpdateJobStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html)
func (*Client) ListMultiRegionAccessPoints ¶ added in v1.11.0
func (c *Client) ListMultiRegionAccessPoints(ctx context.Context, params *ListMultiRegionAccessPointsInput, optFns ...func(*Options)) (*ListMultiRegionAccessPointsOutput, error)
Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account. Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be associated with a single account. This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) in the Amazon S3 User Guide. The following actions are related to ListMultiRegionAccessPoint:
* CreateMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html)
* DeleteMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html)
* DescribeMultiRegionAccessPointOperation (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html)
* GetMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html)
func (*Client) ListRegionalBuckets ¶
func (c *Client) ListRegionalBuckets(ctx context.Context, params *ListRegionalBucketsInput, optFns ...func(*Options)) (*ListRegionalBucketsOutput, error)
Returns a list of all Outposts buckets in an Outpost 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/userguide/S3onOutposts.html) in the Amazon S3 User Guide. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and x-amz-outpost-id in your request, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListRegionalBuckets.html#API_control_ListRegionalBuckets_Examples) section.
func (*Client) ListStorageLensConfigurations ¶ added in v0.30.0
func (c *Client) ListStorageLensConfigurations(ctx context.Context, params *ListStorageLensConfigurationsInput, optFns ...func(*Options)) (*ListStorageLensConfigurationsOutput, error)
Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) in the Amazon S3 User Guide. To use this action, you must have permission to perform the s3:ListStorageLensConfigurations action. For more information, see Setting permissions to use Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) in the Amazon S3 User Guide.
func (*Client) PutAccessPointConfigurationForObjectLambda ¶ added in v1.3.0
func (c *Client) PutAccessPointConfigurationForObjectLambda(ctx context.Context, params *PutAccessPointConfigurationForObjectLambdaInput, optFns ...func(*Options)) (*PutAccessPointConfigurationForObjectLambdaOutput, error)
Replaces configuration for an Object Lambda Access Point. The following actions are related to PutAccessPointConfigurationForObjectLambda:
* GetAccessPointConfigurationForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointConfigurationForObjectLambda.html)
func (*Client) PutAccessPointPolicy ¶
func (c *Client) PutAccessPointPolicy(ctx context.Context, params *PutAccessPointPolicyInput, optFns ...func(*Options)) (*PutAccessPointPolicyOutput, error)
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 x-amz-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 x-amz-outpost-id derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html#API_control_PutAccessPointPolicy_Examples) section. The following actions are related to PutAccessPointPolicy:
* GetAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicy.html)
* DeleteAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html)
func (*Client) PutAccessPointPolicyForObjectLambda ¶ added in v1.3.0
func (c *Client) PutAccessPointPolicyForObjectLambda(ctx context.Context, params *PutAccessPointPolicyForObjectLambdaInput, optFns ...func(*Options)) (*PutAccessPointPolicyForObjectLambdaOutput, error)
Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see Creating Object Lambda Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-create.html#olap-create-cli) in the Amazon S3 User Guide. The following actions are related to PutAccessPointPolicyForObjectLambda:
* DeleteAccessPointPolicyForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicyForObjectLambda.html)
* GetAccessPointPolicyForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicyForObjectLambda.html)
func (*Client) PutBucketLifecycleConfiguration ¶
func (c *Client) PutBucketLifecycleConfiguration(ctx context.Context, params *PutBucketLifecycleConfigurationInput, optFns ...func(*Options)) (*PutBucketLifecycleConfigurationOutput, error)
This 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 S3 API Reference. Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-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 x-amz-outpost-id derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html#API_control_PutBucketLifecycleConfiguration_Examples) section. The following actions are related to PutBucketLifecycleConfiguration:
* GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html)
* DeleteBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html)
func (*Client) PutBucketPolicy ¶
func (c *Client) PutBucketPolicy(ctx context.Context, params *PutBucketPolicyInput, optFns ...func(*Options)) (*PutBucketPolicyOutput, error)
This 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 S3 API Reference. 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/userguide/S3onOutposts.html) in the Amazon S3 User Guide. If you are using an identity other than the root user of the Amazon Web Services 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 action. 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 Amazon Web Services account that owns a bucket can always use this action, 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 x-amz-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 x-amz-outpost-id derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html#API_control_PutBucketPolicy_Examples) section. The following actions are related to PutBucketPolicy:
* GetBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html)
* DeleteBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html)
func (*Client) PutBucketTagging ¶
func (c *Client) PutBucketTagging(ctx context.Context, params *PutBucketTaggingInput, optFns ...func(*Options)) (*PutBucketTaggingOutput, error)
This 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 S3 API Reference. Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the Amazon S3 User Guide. Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services 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/userguide/CostAllocTagging.html). To use this action, you must have permissions to perform the s3-outposts: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/userguide/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/userguide/s3-access-control.html). PutBucketTagging has the following special errors:
* Error code: InvalidTagError
* Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) and Amazon Web Services-Generated Cost Allocation Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html).
* Error code: MalformedXMLError
* Description: The XML provided does not match the schema.
* Error code: OperationAbortedError
* Description: A conflicting conditional action is currently in progress against this resource. Try again.
* Error code: InternalError
* Description: The service was unable to apply the provided tag to the bucket.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-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 x-amz-outpost-id derived using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html#API_control_PutBucketTagging_Examples) section. The following actions are related to PutBucketTagging:
* GetBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html)
* DeleteBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html)
func (*Client) PutJobTagging ¶
func (c *Client) PutJobTagging(ctx context.Context, params *PutJobTaggingInput, optFns ...func(*Options)) (*PutJobTaggingOutput, error)
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 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 S3 User 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 Billing and Cost Management User Guide.
To use this action, you must have permission to perform the s3:PutJobTagging action. Related actions include:
* CreateJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html)
* GetJobTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html)
* DeleteJobTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html)
func (*Client) PutMultiRegionAccessPointPolicy ¶ added in v1.11.0
func (c *Client) PutMultiRegionAccessPointPolicy(ctx context.Context, params *PutMultiRegionAccessPointPolicyInput, optFns ...func(*Options)) (*PutMultiRegionAccessPointPolicyOutput, error)
Associates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only one policy, so a request made to this action replaces any existing policy that is associated with the specified Multi-Region Access Point. This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) in the Amazon S3 User Guide. The following actions are related to PutMultiRegionAccessPointPolicy:
* GetMultiRegionAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicy.html)
* GetMultiRegionAccessPointPolicyStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicyStatus.html)
func (*Client) PutPublicAccessBlock ¶
func (c *Client) PutPublicAccessBlock(ctx context.Context, params *PutPublicAccessBlockInput, optFns ...func(*Options)) (*PutPublicAccessBlockOutput, error)
Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account. For this operation, users must have the s3:PutBucketPublicAccessBlock permission. 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:
* GetPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetPublicAccessBlock.html)
* DeletePublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeletePublicAccessBlock.html)
func (*Client) PutStorageLensConfiguration ¶ added in v0.30.0
func (c *Client) PutStorageLensConfiguration(ctx context.Context, params *PutStorageLensConfigurationInput, optFns ...func(*Options)) (*PutStorageLensConfigurationOutput, error)
Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) in the Amazon S3 User Guide. To use this action, you must have permission to perform the s3:PutStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) in the Amazon S3 User Guide.
func (*Client) PutStorageLensConfigurationTagging ¶ added in v0.30.0
func (c *Client) PutStorageLensConfigurationTagging(ctx context.Context, params *PutStorageLensConfigurationTaggingInput, optFns ...func(*Options)) (*PutStorageLensConfigurationTaggingOutput, error)
Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) in the Amazon S3 User Guide. To use this action, you must have permission to perform the s3:PutStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) in the Amazon S3 User Guide.
func (*Client) UpdateJobPriority ¶
func (c *Client) UpdateJobPriority(ctx context.Context, params *UpdateJobPriorityInput, optFns ...func(*Options)) (*UpdateJobPriorityOutput, error)
Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html) in the Amazon S3 User Guide. Related actions include:
* CreateJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html)
* ListJobs (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html)
* DescribeJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html)
* UpdateJobStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html)
func (*Client) UpdateJobStatus ¶
func (c *Client) UpdateJobStatus(ctx context.Context, params *UpdateJobStatusInput, optFns ...func(*Options)) (*UpdateJobStatusOutput, error)
Updates the status for the specified job. Use this action 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/userguide/batch-ops.html) in the Amazon S3 User Guide. Related actions include:
* CreateJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html)
* ListJobs (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html)
* DescribeJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html)
* UpdateJobStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html)
type CreateAccessPointForObjectLambdaInput ¶ added in v1.3.0
type CreateAccessPointForObjectLambdaInput struct { // The Amazon Web Services account ID for owner of the specified Object Lambda // Access Point. // // This member is required. AccountId *string // Object Lambda Access Point configuration as a JSON document. // // This member is required. Configuration *types.ObjectLambdaConfiguration // The name you want to assign to this Object Lambda Access Point. // // This member is required. Name *string // contains filtered or unexported fields }
type CreateAccessPointForObjectLambdaOutput ¶ added in v1.3.0
type CreateAccessPointForObjectLambdaOutput struct { // Specifies the ARN for the Object Lambda Access Point. ObjectLambdaAccessPointArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateAccessPointInput ¶
type CreateAccessPointInput struct { // The Amazon Web Services account ID for the owner of the bucket for which you // want to create an access point. // // This member is required. AccountId *string // The name of the bucket that you want to associate this access point with. For // using this parameter with Amazon S3 on Outposts with the REST API, you must // specify the name and the x-amz-outpost-id as well. For using this parameter with // S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the // ARN of the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/. // 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. // // This member is required. Bucket *string // The name you want to assign to this access point. // // This member is required. Name *string // The PublicAccessBlock configuration that you want to apply to the access point. PublicAccessBlockConfiguration *types.PublicAccessBlockConfiguration // 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 *types.VpcConfiguration // contains filtered or unexported fields }
type CreateAccessPointOutput ¶
type CreateAccessPointOutput struct { // The ARN of the access point. This is only supported by Amazon S3 on Outposts. AccessPointArn *string // The name or alias of the access point. Alias *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateBucketInput ¶
type CreateBucketInput struct { // The name of the bucket. // // This member is required. Bucket *string // The canned ACL to apply to the bucket. This is not supported by Amazon S3 on // Outposts buckets. ACL types.BucketCannedACL // The configuration information for the bucket. This is not supported by Amazon S3 // on Outposts buckets. CreateBucketConfiguration *types.CreateBucketConfiguration // 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 // Allows grantee to list the objects in the bucket. This is not supported by // Amazon S3 on Outposts buckets. GrantRead *string // Allows grantee to read the bucket ACL. This is not supported by Amazon S3 on // Outposts buckets. GrantReadACP *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 // Allows grantee to write the ACL for the applicable bucket. This is not supported // by Amazon S3 on Outposts buckets. GrantWriteACP *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 // The ID of the Outposts where the bucket is being created. This is required by // Amazon S3 on Outposts buckets. OutpostId *string // contains filtered or unexported fields }
type CreateBucketOutput ¶
type CreateBucketOutput struct { // The Amazon Resource Name (ARN) of the bucket. For using this parameter with // Amazon S3 on Outposts with the REST API, you must specify the name and the // x-amz-outpost-id as well. For using this parameter with S3 on Outposts with the // Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed // in the format arn:aws:s3-outposts:::outpost//bucket/. 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 // The location of the bucket. Location *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateJobInput ¶
type CreateJobInput struct { // The Amazon Web Services account ID that creates the job. // // This member is required. AccountId *string // 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. // // This member is required. ClientRequestToken *string // The action that you want this job to perform on every object listed in the // manifest. For more information about the available actions, see Operations // (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-actions.html) in the // Amazon S3 User Guide. // // This member is required. Operation *types.JobOperation // The numerical priority for this job. Higher numbers indicate higher priority. // // This member is required. Priority int32 // Configuration parameters for the optional job-completion report. // // This member is required. Report *types.JobReport // The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role // that Batch Operations will use to run this job's action on every object in the // manifest. // // This member is required. RoleArn *string // 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 // 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 // Configuration parameters for the manifest. Manifest *types.JobManifest // The attribute container for the ManifestGenerator details. Jobs must be created // with either a manifest file or a ManifestGenerator, but not both. ManifestGenerator types.JobManifestGenerator // A set of tags to associate with the S3 Batch Operations job. This is an optional // parameter. Tags []types.S3Tag // contains filtered or unexported fields }
type CreateJobOutput ¶
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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateMultiRegionAccessPointInput ¶ added in v1.11.0
type CreateMultiRegionAccessPointInput struct { // The Amazon Web Services account ID for the owner of the Multi-Region Access // Point. The owner of the Multi-Region Access Point also must own the underlying // buckets. // // This member is required. AccountId *string // An idempotency token used to identify the request and guarantee that requests // are unique. // // This member is required. ClientToken *string // A container element containing details about the Multi-Region Access Point. // // This member is required. Details *types.CreateMultiRegionAccessPointInput // contains filtered or unexported fields }
type CreateMultiRegionAccessPointOutput ¶ added in v1.11.0
type CreateMultiRegionAccessPointOutput struct { // The request token associated with the request. You can use this token with // DescribeMultiRegionAccessPointOperation // (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html) // to determine the status of asynchronous requests. RequestTokenARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteAccessPointForObjectLambdaInput ¶ added in v1.3.0
type DeleteAccessPointForObjectLambdaInput struct { // The account ID for the account that owns the specified Object Lambda Access // Point. // // This member is required. AccountId *string // The name of the access point you want to delete. // // This member is required. Name *string // contains filtered or unexported fields }
type DeleteAccessPointForObjectLambdaOutput ¶ added in v1.3.0
type DeleteAccessPointForObjectLambdaOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteAccessPointInput ¶
type DeleteAccessPointInput struct { // The account ID for the account that owns the specified access point. // // This member is required. AccountId *string // The name of the access point you want to delete. For using this parameter with // Amazon S3 on Outposts with the REST API, you must specify the name and the // x-amz-outpost-id as well. For using this parameter with S3 on Outposts with the // Amazon Web Services SDK and CLI, you must specify the ARN of the access point // accessed in the format arn:aws:s3-outposts:::outpost//accesspoint/. 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. // // This member is required. Name *string // contains filtered or unexported fields }
type DeleteAccessPointOutput ¶
type DeleteAccessPointOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteAccessPointPolicyForObjectLambdaInput ¶ added in v1.3.0
type DeleteAccessPointPolicyForObjectLambdaInput struct { // The account ID for the account that owns the specified Object Lambda Access // Point. // // This member is required. AccountId *string // The name of the Object Lambda Access Point you want to delete the policy for. // // This member is required. Name *string // contains filtered or unexported fields }
type DeleteAccessPointPolicyForObjectLambdaOutput ¶ added in v1.3.0
type DeleteAccessPointPolicyForObjectLambdaOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteAccessPointPolicyInput ¶
type DeleteAccessPointPolicyInput struct { // The account ID for the account that owns the specified access point. // // This member is required. AccountId *string // The name of the access point whose policy you want to delete. For using this // parameter with Amazon S3 on Outposts with the REST API, you must specify the // name and the x-amz-outpost-id as well. For using this parameter with S3 on // Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of // the access point accessed in the format // arn:aws:s3-outposts:::outpost//accesspoint/. 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. // // This member is required. Name *string // contains filtered or unexported fields }
type DeleteAccessPointPolicyOutput ¶
type DeleteAccessPointPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteBucketInput ¶
type DeleteBucketInput struct { // The account ID that owns the Outposts bucket. // // This member is required. AccountId *string // Specifies the bucket being deleted. For using this parameter with Amazon S3 on // Outposts with the REST API, you must specify the name and the x-amz-outpost-id // as well. For using this parameter with S3 on Outposts with the Amazon Web // Services SDK and CLI, you must specify the ARN of the bucket accessed in the // format arn:aws:s3-outposts:::outpost//bucket/. 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. // // This member is required. Bucket *string // contains filtered or unexported fields }
type DeleteBucketLifecycleConfigurationInput ¶
type DeleteBucketLifecycleConfigurationInput struct { // The account ID of the lifecycle configuration to delete. // // This member is required. AccountId *string // Specifies the bucket. For using this parameter with Amazon S3 on Outposts with // the REST API, you must specify the name and the x-amz-outpost-id as well. For // using this parameter with S3 on Outposts with the Amazon Web Services SDK and // CLI, you must specify the ARN of the bucket accessed in the format // arn:aws:s3-outposts:::outpost//bucket/. 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. // // This member is required. Bucket *string // contains filtered or unexported fields }
type DeleteBucketLifecycleConfigurationOutput ¶
type DeleteBucketLifecycleConfigurationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteBucketOutput ¶
type DeleteBucketOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteBucketPolicyInput ¶
type DeleteBucketPolicyInput struct { // The account ID of the Outposts bucket. // // This member is required. AccountId *string // Specifies the bucket. For using this parameter with Amazon S3 on Outposts with // the REST API, you must specify the name and the x-amz-outpost-id as well. For // using this parameter with S3 on Outposts with the Amazon Web Services SDK and // CLI, you must specify the ARN of the bucket accessed in the format // arn:aws:s3-outposts:::outpost//bucket/. 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. // // This member is required. Bucket *string // contains filtered or unexported fields }
type DeleteBucketPolicyOutput ¶
type DeleteBucketPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteBucketTaggingInput ¶
type DeleteBucketTaggingInput struct { // The Amazon Web Services account ID of the Outposts bucket tag set to be removed. // // This member is required. AccountId *string // The bucket ARN that has the tag set to be removed. For using this parameter with // Amazon S3 on Outposts with the REST API, you must specify the name and the // x-amz-outpost-id as well. For using this parameter with S3 on Outposts with the // Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed // in the format arn:aws:s3-outposts:::outpost//bucket/. 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. // // This member is required. Bucket *string // contains filtered or unexported fields }
type DeleteBucketTaggingOutput ¶
type DeleteBucketTaggingOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteJobTaggingInput ¶
type DeleteJobTaggingInput struct { // The Amazon Web Services account ID associated with the S3 Batch Operations job. // // This member is required. AccountId *string // The ID for the S3 Batch Operations job whose tags you want to delete. // // This member is required. JobId *string // contains filtered or unexported fields }
type DeleteJobTaggingOutput ¶
type DeleteJobTaggingOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteMultiRegionAccessPointInput ¶ added in v1.11.0
type DeleteMultiRegionAccessPointInput struct { // The Amazon Web Services account ID for the owner of the Multi-Region Access // Point. // // This member is required. AccountId *string // An idempotency token used to identify the request and guarantee that requests // are unique. // // This member is required. ClientToken *string // A container element containing details about the Multi-Region Access Point. // // This member is required. Details *types.DeleteMultiRegionAccessPointInput // contains filtered or unexported fields }
type DeleteMultiRegionAccessPointOutput ¶ added in v1.11.0
type DeleteMultiRegionAccessPointOutput struct { // The request token associated with the request. You can use this token with // DescribeMultiRegionAccessPointOperation // (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html) // to determine the status of asynchronous requests. RequestTokenARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeletePublicAccessBlockInput ¶
type DeletePublicAccessBlockInput struct { // The account ID for the Amazon Web Services account whose PublicAccessBlock // configuration you want to remove. // // This member is required. AccountId *string // contains filtered or unexported fields }
type DeletePublicAccessBlockOutput ¶
type DeletePublicAccessBlockOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteStorageLensConfigurationInput ¶ added in v0.30.0
type DeleteStorageLensConfigurationOutput ¶ added in v0.30.0
type DeleteStorageLensConfigurationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteStorageLensConfigurationTaggingInput ¶ added in v0.30.0
type DeleteStorageLensConfigurationTaggingOutput ¶ added in v0.30.0
type DeleteStorageLensConfigurationTaggingOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeJobInput ¶
type DescribeJobInput struct { // The Amazon Web Services account ID associated with the S3 Batch Operations job. // // This member is required. AccountId *string // The ID for the job whose information you want to retrieve. // // This member is required. JobId *string // contains filtered or unexported fields }
type DescribeJobOutput ¶
type DescribeJobOutput struct { // Contains the configuration parameters and status for the job specified in the // Describe Job request. Job *types.JobDescriptor // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeMultiRegionAccessPointOperationInput ¶ added in v1.11.0
type DescribeMultiRegionAccessPointOperationInput struct { // The Amazon Web Services account ID for the owner of the Multi-Region Access // Point. // // This member is required. AccountId *string // The request token associated with the request you want to know about. This // request token is returned as part of the response when you make an asynchronous // request. You provide this token to query about the status of the asynchronous // action. // // This member is required. RequestTokenARN *string // contains filtered or unexported fields }
type DescribeMultiRegionAccessPointOperationOutput ¶ added in v1.11.0
type DescribeMultiRegionAccessPointOperationOutput struct { // A container element containing the details of the asynchronous operation. AsyncOperation *types.AsyncOperation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶ added in v1.1.0
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶ added in v0.29.0
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type GetAccessPointConfigurationForObjectLambdaInput ¶ added in v1.3.0
type GetAccessPointConfigurationForObjectLambdaInput struct { // The account ID for the account that owns the specified Object Lambda Access // Point. // // This member is required. AccountId *string // The name of the Object Lambda Access Point you want to return the configuration // for. // // This member is required. Name *string // contains filtered or unexported fields }
type GetAccessPointConfigurationForObjectLambdaOutput ¶ added in v1.3.0
type GetAccessPointConfigurationForObjectLambdaOutput struct { // Object Lambda Access Point configuration document. Configuration *types.ObjectLambdaConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetAccessPointForObjectLambdaInput ¶ added in v1.3.0
type GetAccessPointForObjectLambdaInput struct { // The account ID for the account that owns the specified Object Lambda Access // Point. // // This member is required. AccountId *string // The name of the Object Lambda Access Point. // // This member is required. Name *string // contains filtered or unexported fields }
type GetAccessPointForObjectLambdaOutput ¶ added in v1.3.0
type GetAccessPointForObjectLambdaOutput struct { // The date and time when the specified Object Lambda Access Point was created. CreationDate *time.Time // The name of the Object Lambda Access Point. Name *string // Configuration to block all public access. This setting is turned on and can not // be edited. PublicAccessBlockConfiguration *types.PublicAccessBlockConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetAccessPointInput ¶
type GetAccessPointInput struct { // The account ID for the account that owns the specified access point. // // This member is required. AccountId *string // The name of the access point whose configuration information you want to // retrieve. For using this parameter with Amazon S3 on Outposts with the REST API, // you must specify the name and the x-amz-outpost-id as well. For using this // parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must // specify the ARN of the access point accessed in the format // arn:aws:s3-outposts:::outpost//accesspoint/. 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. // // This member is required. Name *string // contains filtered or unexported fields }
type GetAccessPointOutput ¶
type GetAccessPointOutput struct { // The ARN of the access point. AccessPointArn *string // The name or alias of the access point. Alias *string // The name of the bucket associated with the specified access point. Bucket *string // The date and time when the specified access point was created. CreationDate *time.Time // The VPC endpoint for the access point. Endpoints map[string]string // The name of the specified access point. Name *string // Indicates whether this access point allows access from the public internet. If // VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, // and the access point doesn't allow access from the public internet. Otherwise, // NetworkOrigin is Internet, and the access point allows access from the public // internet, subject to the access point and bucket access policies. This will // always be true for an Amazon S3 on Outposts access point NetworkOrigin types.NetworkOrigin // The PublicAccessBlock configuration that you want to apply to this Amazon S3 // account. You can enable the configuration options in any combination. For more // information about when Amazon S3 considers a bucket or object public, see The // Meaning of "Public" // (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) // in the Amazon S3 User Guide. This is not supported for Amazon S3 on Outposts. PublicAccessBlockConfiguration *types.PublicAccessBlockConfiguration // Contains the virtual private cloud (VPC) configuration for the specified access // point. This element is empty if this access point is an Amazon S3 on Outposts // access point that is used by other Amazon Web Services. VpcConfiguration *types.VpcConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetAccessPointPolicyForObjectLambdaInput ¶ added in v1.3.0
type GetAccessPointPolicyForObjectLambdaInput struct { // The account ID for the account that owns the specified Object Lambda Access // Point. // // This member is required. AccountId *string // The name of the Object Lambda Access Point. // // This member is required. Name *string // contains filtered or unexported fields }
type GetAccessPointPolicyForObjectLambdaOutput ¶ added in v1.3.0
type GetAccessPointPolicyForObjectLambdaOutput struct { // Object Lambda Access Point resource policy document. Policy *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetAccessPointPolicyInput ¶
type GetAccessPointPolicyInput struct { // The account ID for the account that owns the specified access point. // // This member is required. AccountId *string // The name of the access point whose policy you want to retrieve. For using this // parameter with Amazon S3 on Outposts with the REST API, you must specify the // name and the x-amz-outpost-id as well. For using this parameter with S3 on // Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of // the access point accessed in the format // arn:aws:s3-outposts:::outpost//accesspoint/. 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. // // This member is required. Name *string // contains filtered or unexported fields }
type GetAccessPointPolicyOutput ¶
type GetAccessPointPolicyOutput struct { // The access point policy associated with the specified access point. Policy *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetAccessPointPolicyStatusForObjectLambdaInput ¶ added in v1.3.0
type GetAccessPointPolicyStatusForObjectLambdaInput struct { // The account ID for the account that owns the specified Object Lambda Access // Point. // // This member is required. AccountId *string // The name of the Object Lambda Access Point. // // This member is required. Name *string // contains filtered or unexported fields }
type GetAccessPointPolicyStatusForObjectLambdaOutput ¶ added in v1.3.0
type GetAccessPointPolicyStatusForObjectLambdaOutput struct { // Indicates whether this access point policy is public. For more information about // how Amazon S3 evaluates policies to determine whether they are public, see The // Meaning of "Public" // (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) // in the Amazon S3 User Guide. PolicyStatus *types.PolicyStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetAccessPointPolicyStatusInput ¶
type GetAccessPointPolicyStatusInput struct { // The account ID for the account that owns the specified access point. // // This member is required. AccountId *string // The name of the access point whose policy status you want to retrieve. // // This member is required. Name *string // contains filtered or unexported fields }
type GetAccessPointPolicyStatusOutput ¶
type GetAccessPointPolicyStatusOutput struct { // Indicates the current policy status of the specified access point. PolicyStatus *types.PolicyStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetBucketInput ¶
type GetBucketInput struct { // The Amazon Web Services account ID of the Outposts bucket. // // This member is required. AccountId *string // Specifies the bucket. For using this parameter with Amazon S3 on Outposts with // the REST API, you must specify the name and the x-amz-outpost-id as well. For // using this parameter with S3 on Outposts with the Amazon Web Services SDK and // CLI, you must specify the ARN of the bucket accessed in the format // arn:aws:s3-outposts:::outpost//bucket/. 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. // // This member is required. Bucket *string // contains filtered or unexported fields }
type GetBucketLifecycleConfigurationInput ¶
type GetBucketLifecycleConfigurationInput struct { // The Amazon Web Services account ID of the Outposts bucket. // // This member is required. AccountId *string // The Amazon Resource Name (ARN) of the bucket. For using this parameter with // Amazon S3 on Outposts with the REST API, you must specify the name and the // x-amz-outpost-id as well. For using this parameter with S3 on Outposts with the // Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed // in the format arn:aws:s3-outposts:::outpost//bucket/. 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. // // This member is required. Bucket *string // contains filtered or unexported fields }
type GetBucketLifecycleConfigurationOutput ¶
type GetBucketLifecycleConfigurationOutput struct { // Container for the lifecycle rule of the Outposts bucket. Rules []types.LifecycleRule // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetBucketOutput ¶
type GetBucketOutput struct { // The Outposts bucket requested. Bucket *string // The creation date of the Outposts bucket. CreationDate *time.Time // PublicAccessBlockEnabled bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetBucketPolicyInput ¶
type GetBucketPolicyInput struct { // The Amazon Web Services account ID of the Outposts bucket. // // This member is required. AccountId *string // Specifies the bucket. For using this parameter with Amazon S3 on Outposts with // the REST API, you must specify the name and the x-amz-outpost-id as well. For // using this parameter with S3 on Outposts with the Amazon Web Services SDK and // CLI, you must specify the ARN of the bucket accessed in the format // arn:aws:s3-outposts:::outpost//bucket/. 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. // // This member is required. Bucket *string // contains filtered or unexported fields }
type GetBucketPolicyOutput ¶
type GetBucketPolicyOutput struct { // The policy of the Outposts bucket. Policy *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetBucketTaggingInput ¶
type GetBucketTaggingInput struct { // The Amazon Web Services account ID of the Outposts bucket. // // This member is required. AccountId *string // Specifies the bucket. For using this parameter with Amazon S3 on Outposts with // the REST API, you must specify the name and the x-amz-outpost-id as well. For // using this parameter with S3 on Outposts with the Amazon Web Services SDK and // CLI, you must specify the ARN of the bucket accessed in the format // arn:aws:s3-outposts:::outpost//bucket/. 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. // // This member is required. Bucket *string // contains filtered or unexported fields }
type GetBucketTaggingOutput ¶
type GetBucketTaggingOutput struct { // The tags set of the Outposts bucket. // // This member is required. TagSet []types.S3Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetJobTaggingInput ¶
type GetJobTaggingInput struct { // The Amazon Web Services account ID associated with the S3 Batch Operations job. // // This member is required. AccountId *string // The ID for the S3 Batch Operations job whose tags you want to retrieve. // // This member is required. JobId *string // contains filtered or unexported fields }
type GetJobTaggingOutput ¶
type GetJobTaggingOutput struct { // The set of tags associated with the S3 Batch Operations job. Tags []types.S3Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetMultiRegionAccessPointInput ¶ added in v1.11.0
type GetMultiRegionAccessPointInput struct { // The Amazon Web Services account ID for the owner of the Multi-Region Access // Point. // // This member is required. AccountId *string // The name of the Multi-Region Access Point whose configuration information you // want to receive. The name of the Multi-Region Access Point is different from the // alias. For more information about the distinction between the name and the alias // of an Multi-Region Access Point, see Managing Multi-Region Access Points // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming) // in the Amazon S3 User Guide. // // This member is required. Name *string // contains filtered or unexported fields }
type GetMultiRegionAccessPointOutput ¶ added in v1.11.0
type GetMultiRegionAccessPointOutput struct { // A container element containing the details of the requested Multi-Region Access // Point. AccessPoint *types.MultiRegionAccessPointReport // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetMultiRegionAccessPointPolicyInput ¶ added in v1.11.0
type GetMultiRegionAccessPointPolicyInput struct { // The Amazon Web Services account ID for the owner of the Multi-Region Access // Point. // // This member is required. AccountId *string // Specifies the Multi-Region Access Point. The name of the Multi-Region Access // Point is different from the alias. For more information about the distinction // between the name and the alias of an Multi-Region Access Point, see Managing // Multi-Region Access Points // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming) // in the Amazon S3 User Guide. // // This member is required. Name *string // contains filtered or unexported fields }
type GetMultiRegionAccessPointPolicyOutput ¶ added in v1.11.0
type GetMultiRegionAccessPointPolicyOutput struct { // The policy associated with the specified Multi-Region Access Point. Policy *types.MultiRegionAccessPointPolicyDocument // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetMultiRegionAccessPointPolicyStatusInput ¶ added in v1.11.0
type GetMultiRegionAccessPointPolicyStatusInput struct { // The Amazon Web Services account ID for the owner of the Multi-Region Access // Point. // // This member is required. AccountId *string // Specifies the Multi-Region Access Point. The name of the Multi-Region Access // Point is different from the alias. For more information about the distinction // between the name and the alias of an Multi-Region Access Point, see Managing // Multi-Region Access Points // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming) // in the Amazon S3 User Guide. // // This member is required. Name *string // contains filtered or unexported fields }
type GetMultiRegionAccessPointPolicyStatusOutput ¶ added in v1.11.0
type GetMultiRegionAccessPointPolicyStatusOutput struct { // Indicates whether this access point policy is public. For more information about // how Amazon S3 evaluates policies to determine whether they are public, see The // Meaning of "Public" // (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) // in the Amazon S3 User Guide. Established *types.PolicyStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetPublicAccessBlockInput ¶
type GetPublicAccessBlockInput struct { // The account ID for the Amazon Web Services account whose PublicAccessBlock // configuration you want to retrieve. // // This member is required. AccountId *string // contains filtered or unexported fields }
type GetPublicAccessBlockOutput ¶
type GetPublicAccessBlockOutput struct { // The PublicAccessBlock configuration currently in effect for this Amazon Web // Services account. PublicAccessBlockConfiguration *types.PublicAccessBlockConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetStorageLensConfigurationInput ¶ added in v0.30.0
type GetStorageLensConfigurationOutput ¶ added in v0.30.0
type GetStorageLensConfigurationOutput struct { // The S3 Storage Lens configuration requested. StorageLensConfiguration *types.StorageLensConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetStorageLensConfigurationTaggingInput ¶ added in v0.30.0
type GetStorageLensConfigurationTaggingOutput ¶ added in v0.30.0
type GetStorageLensConfigurationTaggingOutput struct { // The tags of S3 Storage Lens configuration requested. Tags []types.StorageLensTag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type HTTPSignerV4 ¶
type IdempotencyTokenProvider ¶
IdempotencyTokenProvider interface for providing idempotency token
type ListAccessPointsAPIClient ¶ added in v0.30.0
type ListAccessPointsAPIClient interface {
ListAccessPoints(context.Context, *ListAccessPointsInput, ...func(*Options)) (*ListAccessPointsOutput, error)
}
ListAccessPointsAPIClient is a client that implements the ListAccessPoints operation.
type ListAccessPointsForObjectLambdaAPIClient ¶ added in v1.3.0
type ListAccessPointsForObjectLambdaAPIClient interface {
ListAccessPointsForObjectLambda(context.Context, *ListAccessPointsForObjectLambdaInput, ...func(*Options)) (*ListAccessPointsForObjectLambdaOutput, error)
}
ListAccessPointsForObjectLambdaAPIClient is a client that implements the ListAccessPointsForObjectLambda operation.
type ListAccessPointsForObjectLambdaInput ¶ added in v1.3.0
type ListAccessPointsForObjectLambdaInput struct { // The account ID for the account that owns the specified Object Lambda Access // Point. // // This member is required. AccountId *string // The maximum number of access points that you want to include in the list. The // response may contain fewer access points but will never contain more. If there // are 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 int32 // If the list 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 // contains filtered or unexported fields }
type ListAccessPointsForObjectLambdaOutput ¶ added in v1.3.0
type ListAccessPointsForObjectLambdaOutput struct { // If the list 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 // Returns list of Object Lambda Access Points. ObjectLambdaAccessPointList []types.ObjectLambdaAccessPoint // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAccessPointsForObjectLambdaPaginator ¶ added in v1.3.0
type ListAccessPointsForObjectLambdaPaginator struct {
// contains filtered or unexported fields
}
ListAccessPointsForObjectLambdaPaginator is a paginator for ListAccessPointsForObjectLambda
func NewListAccessPointsForObjectLambdaPaginator ¶ added in v1.3.0
func NewListAccessPointsForObjectLambdaPaginator(client ListAccessPointsForObjectLambdaAPIClient, params *ListAccessPointsForObjectLambdaInput, optFns ...func(*ListAccessPointsForObjectLambdaPaginatorOptions)) *ListAccessPointsForObjectLambdaPaginator
NewListAccessPointsForObjectLambdaPaginator returns a new ListAccessPointsForObjectLambdaPaginator
func (*ListAccessPointsForObjectLambdaPaginator) HasMorePages ¶ added in v1.3.0
func (p *ListAccessPointsForObjectLambdaPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAccessPointsForObjectLambdaPaginator) NextPage ¶ added in v1.3.0
func (p *ListAccessPointsForObjectLambdaPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAccessPointsForObjectLambdaOutput, error)
NextPage retrieves the next ListAccessPointsForObjectLambda page.
type ListAccessPointsForObjectLambdaPaginatorOptions ¶ added in v1.3.0
type ListAccessPointsForObjectLambdaPaginatorOptions struct { // The maximum number of access points that you want to include in the list. The // response may contain fewer access points but will never contain more. If there // are 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListAccessPointsForObjectLambdaPaginatorOptions is the paginator options for ListAccessPointsForObjectLambda
type ListAccessPointsInput ¶
type ListAccessPointsInput struct { // The Amazon Web Services account ID for owner of the bucket whose access points // you want to list. // // This member is required. AccountId *string // The name of the bucket whose associated access points you want to list. For // using this parameter with Amazon S3 on Outposts with the REST API, you must // specify the name and the x-amz-outpost-id as well. For using this parameter with // S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the // ARN of the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/. // 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 // 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 int32 // 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 // contains filtered or unexported fields }
type ListAccessPointsOutput ¶
type ListAccessPointsOutput struct { // Contains identification and configuration information for one or more access // points associated with the specified bucket. AccessPointList []types.AccessPoint // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAccessPointsPaginator ¶ added in v0.30.0
type ListAccessPointsPaginator struct {
// contains filtered or unexported fields
}
ListAccessPointsPaginator is a paginator for ListAccessPoints
func NewListAccessPointsPaginator ¶ added in v0.30.0
func NewListAccessPointsPaginator(client ListAccessPointsAPIClient, params *ListAccessPointsInput, optFns ...func(*ListAccessPointsPaginatorOptions)) *ListAccessPointsPaginator
NewListAccessPointsPaginator returns a new ListAccessPointsPaginator
func (*ListAccessPointsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListAccessPointsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAccessPointsPaginator) NextPage ¶ added in v0.30.0
func (p *ListAccessPointsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAccessPointsOutput, error)
NextPage retrieves the next ListAccessPoints page.
type ListAccessPointsPaginatorOptions ¶ added in v0.30.0
type ListAccessPointsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListAccessPointsPaginatorOptions is the paginator options for ListAccessPoints
type ListJobsAPIClient ¶ added in v0.30.0
type ListJobsAPIClient interface {
ListJobs(context.Context, *ListJobsInput, ...func(*Options)) (*ListJobsOutput, error)
}
ListJobsAPIClient is a client that implements the ListJobs operation.
type ListJobsInput ¶
type ListJobsInput struct { // The Amazon Web Services account ID associated with the S3 Batch Operations job. // // This member is required. AccountId *string // The List Jobs request returns jobs that match the statuses listed in this // element. JobStatuses []types.JobStatus // 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 int32 // 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 // contains filtered or unexported fields }
type ListJobsOutput ¶
type ListJobsOutput struct { // The list of current jobs and jobs that have ended within the last 30 days. Jobs []types.JobListDescriptor // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListJobsPaginator ¶ added in v0.30.0
type ListJobsPaginator struct {
// contains filtered or unexported fields
}
ListJobsPaginator is a paginator for ListJobs
func NewListJobsPaginator ¶ added in v0.30.0
func NewListJobsPaginator(client ListJobsAPIClient, params *ListJobsInput, optFns ...func(*ListJobsPaginatorOptions)) *ListJobsPaginator
NewListJobsPaginator returns a new ListJobsPaginator
func (*ListJobsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListJobsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListJobsPaginator) NextPage ¶ added in v0.30.0
func (p *ListJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListJobsOutput, error)
NextPage retrieves the next ListJobs page.
type ListJobsPaginatorOptions ¶ added in v0.30.0
type ListJobsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListJobsPaginatorOptions is the paginator options for ListJobs
type ListMultiRegionAccessPointsAPIClient ¶ added in v1.11.0
type ListMultiRegionAccessPointsAPIClient interface {
ListMultiRegionAccessPoints(context.Context, *ListMultiRegionAccessPointsInput, ...func(*Options)) (*ListMultiRegionAccessPointsOutput, error)
}
ListMultiRegionAccessPointsAPIClient is a client that implements the ListMultiRegionAccessPoints operation.
type ListMultiRegionAccessPointsInput ¶ added in v1.11.0
type ListMultiRegionAccessPointsInput struct { // The Amazon Web Services account ID for the owner of the Multi-Region Access // Point. // // This member is required. AccountId *string // Not currently used. Do not use this parameter. MaxResults int32 // Not currently used. Do not use this parameter. NextToken *string // contains filtered or unexported fields }
type ListMultiRegionAccessPointsOutput ¶ added in v1.11.0
type ListMultiRegionAccessPointsOutput struct { // The list of Multi-Region Access Points associated with the user. AccessPoints []types.MultiRegionAccessPointReport // If the specified bucket has more Multi-Region Access Points than can be returned // in one call to this action, this field contains a continuation token. You can // use this token tin subsequent calls to this action to retrieve additional // Multi-Region Access Points. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListMultiRegionAccessPointsPaginator ¶ added in v1.11.0
type ListMultiRegionAccessPointsPaginator struct {
// contains filtered or unexported fields
}
ListMultiRegionAccessPointsPaginator is a paginator for ListMultiRegionAccessPoints
func NewListMultiRegionAccessPointsPaginator ¶ added in v1.11.0
func NewListMultiRegionAccessPointsPaginator(client ListMultiRegionAccessPointsAPIClient, params *ListMultiRegionAccessPointsInput, optFns ...func(*ListMultiRegionAccessPointsPaginatorOptions)) *ListMultiRegionAccessPointsPaginator
NewListMultiRegionAccessPointsPaginator returns a new ListMultiRegionAccessPointsPaginator
func (*ListMultiRegionAccessPointsPaginator) HasMorePages ¶ added in v1.11.0
func (p *ListMultiRegionAccessPointsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListMultiRegionAccessPointsPaginator) NextPage ¶ added in v1.11.0
func (p *ListMultiRegionAccessPointsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMultiRegionAccessPointsOutput, error)
NextPage retrieves the next ListMultiRegionAccessPoints page.
type ListMultiRegionAccessPointsPaginatorOptions ¶ added in v1.11.0
type ListMultiRegionAccessPointsPaginatorOptions struct { // Not currently used. Do not use this parameter. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListMultiRegionAccessPointsPaginatorOptions is the paginator options for ListMultiRegionAccessPoints
type ListRegionalBucketsAPIClient ¶ added in v0.30.0
type ListRegionalBucketsAPIClient interface {
ListRegionalBuckets(context.Context, *ListRegionalBucketsInput, ...func(*Options)) (*ListRegionalBucketsOutput, error)
}
ListRegionalBucketsAPIClient is a client that implements the ListRegionalBuckets operation.
type ListRegionalBucketsInput ¶
type ListRegionalBucketsInput struct { // The Amazon Web Services account ID of the Outposts bucket. // // This member is required. AccountId *string // MaxResults int32 // NextToken *string // The ID of the Outposts. This is required by Amazon S3 on Outposts buckets. OutpostId *string // contains filtered or unexported fields }
type ListRegionalBucketsOutput ¶
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 // RegionalBucketList []types.RegionalBucket // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListRegionalBucketsPaginator ¶ added in v0.30.0
type ListRegionalBucketsPaginator struct {
// contains filtered or unexported fields
}
ListRegionalBucketsPaginator is a paginator for ListRegionalBuckets
func NewListRegionalBucketsPaginator ¶ added in v0.30.0
func NewListRegionalBucketsPaginator(client ListRegionalBucketsAPIClient, params *ListRegionalBucketsInput, optFns ...func(*ListRegionalBucketsPaginatorOptions)) *ListRegionalBucketsPaginator
NewListRegionalBucketsPaginator returns a new ListRegionalBucketsPaginator
func (*ListRegionalBucketsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListRegionalBucketsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListRegionalBucketsPaginator) NextPage ¶ added in v0.30.0
func (p *ListRegionalBucketsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRegionalBucketsOutput, error)
NextPage retrieves the next ListRegionalBuckets page.
type ListRegionalBucketsPaginatorOptions ¶ added in v0.30.0
type ListRegionalBucketsPaginatorOptions struct { // Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListRegionalBucketsPaginatorOptions is the paginator options for ListRegionalBuckets
type ListStorageLensConfigurationsAPIClient ¶ added in v1.4.0
type ListStorageLensConfigurationsAPIClient interface {
ListStorageLensConfigurations(context.Context, *ListStorageLensConfigurationsInput, ...func(*Options)) (*ListStorageLensConfigurationsOutput, error)
}
ListStorageLensConfigurationsAPIClient is a client that implements the ListStorageLensConfigurations operation.
type ListStorageLensConfigurationsInput ¶ added in v0.30.0
type ListStorageLensConfigurationsOutput ¶ added in v0.30.0
type ListStorageLensConfigurationsOutput struct { // If the request produced more than the maximum number of S3 Storage Lens // configuration results, you can pass this value into a subsequent request to // retrieve the next page of results. NextToken *string // A list of S3 Storage Lens configurations. StorageLensConfigurationList []types.ListStorageLensConfigurationEntry // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListStorageLensConfigurationsPaginator ¶ added in v1.4.0
type ListStorageLensConfigurationsPaginator struct {
// contains filtered or unexported fields
}
ListStorageLensConfigurationsPaginator is a paginator for ListStorageLensConfigurations
func NewListStorageLensConfigurationsPaginator ¶ added in v1.4.0
func NewListStorageLensConfigurationsPaginator(client ListStorageLensConfigurationsAPIClient, params *ListStorageLensConfigurationsInput, optFns ...func(*ListStorageLensConfigurationsPaginatorOptions)) *ListStorageLensConfigurationsPaginator
NewListStorageLensConfigurationsPaginator returns a new ListStorageLensConfigurationsPaginator
func (*ListStorageLensConfigurationsPaginator) HasMorePages ¶ added in v1.4.0
func (p *ListStorageLensConfigurationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListStorageLensConfigurationsPaginator) NextPage ¶ added in v1.4.0
func (p *ListStorageLensConfigurationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStorageLensConfigurationsOutput, error)
NextPage retrieves the next ListStorageLensConfigurations page.
type ListStorageLensConfigurationsPaginatorOptions ¶ added in v1.4.0
type ListStorageLensConfigurationsPaginatorOptions struct { // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListStorageLensConfigurationsPaginatorOptions is the paginator options for ListStorageLensConfigurations
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // Provides idempotency tokens values that will be automatically populated into // idempotent API operations. IdempotencyTokenProvider IdempotencyTokenProvider // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. When creating a new API Clients this // member will only be used if the Retryer Options member is nil. This value will // be ignored if Retryer is not nil. If specified in an operation call's functional // options with a value that is different than the constructed client's Options, // the Client's Retryer will be wrapped to use the operation's specific // RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. When creating a new API Clients this // member will only be used if the Retryer Options member is nil. This value will // be ignored if Retryer is not nil. Currently does not support per operation call // overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // Allows you to enable arn region support for the service. UseARNRegion bool // Allows you to enable dual-stack endpoint support for the service. // // Deprecated: Set dual-stack by setting UseDualStackEndpoint on // EndpointResolverOptions. When EndpointResolverOptions' UseDualStackEndpoint // field is set it overrides this field value. UseDualstack bool // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // contains filtered or unexported fields }
type PutAccessPointConfigurationForObjectLambdaInput ¶ added in v1.3.0
type PutAccessPointConfigurationForObjectLambdaInput struct { // The account ID for the account that owns the specified Object Lambda Access // Point. // // This member is required. AccountId *string // Object Lambda Access Point configuration document. // // This member is required. Configuration *types.ObjectLambdaConfiguration // The name of the Object Lambda Access Point. // // This member is required. Name *string // contains filtered or unexported fields }
type PutAccessPointConfigurationForObjectLambdaOutput ¶ added in v1.3.0
type PutAccessPointConfigurationForObjectLambdaOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PutAccessPointPolicyForObjectLambdaInput ¶ added in v1.3.0
type PutAccessPointPolicyForObjectLambdaInput struct { // The account ID for the account that owns the specified Object Lambda Access // Point. // // This member is required. AccountId *string // The name of the Object Lambda Access Point. // // This member is required. Name *string // Object Lambda Access Point resource policy document. // // This member is required. Policy *string // contains filtered or unexported fields }
type PutAccessPointPolicyForObjectLambdaOutput ¶ added in v1.3.0
type PutAccessPointPolicyForObjectLambdaOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PutAccessPointPolicyInput ¶
type PutAccessPointPolicyInput struct { // The Amazon Web Services account ID for owner of the bucket associated with the // specified access point. // // This member is required. AccountId *string // The name of the access point that you want to associate with the specified // policy. For using this parameter with Amazon S3 on Outposts with the REST API, // you must specify the name and the x-amz-outpost-id as well. For using this // parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must // specify the ARN of the access point accessed in the format // arn:aws:s3-outposts:::outpost//accesspoint/. 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. // // This member is required. Name *string // 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/userguide/access-points.html) in // the Amazon S3 User Guide. // // This member is required. Policy *string // contains filtered or unexported fields }
type PutAccessPointPolicyOutput ¶
type PutAccessPointPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PutBucketLifecycleConfigurationInput ¶
type PutBucketLifecycleConfigurationInput struct { // The Amazon Web Services account ID of the Outposts bucket. // // This member is required. AccountId *string // The name of the bucket for which to set the configuration. // // This member is required. Bucket *string // Container for lifecycle rules. You can add as many as 1,000 rules. LifecycleConfiguration *types.LifecycleConfiguration // contains filtered or unexported fields }
type PutBucketLifecycleConfigurationOutput ¶
type PutBucketLifecycleConfigurationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PutBucketPolicyInput ¶
type PutBucketPolicyInput struct { // The Amazon Web Services account ID of the Outposts bucket. // // This member is required. AccountId *string // Specifies the bucket. For using this parameter with Amazon S3 on Outposts with // the REST API, you must specify the name and the x-amz-outpost-id as well. For // using this parameter with S3 on Outposts with the Amazon Web Services SDK and // CLI, you must specify the ARN of the bucket accessed in the format // arn:aws:s3-outposts:::outpost//bucket/. 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. // // This member is required. Bucket *string // The bucket policy as a JSON document. // // This member is required. Policy *string // 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 // contains filtered or unexported fields }
type PutBucketPolicyOutput ¶
type PutBucketPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PutBucketTaggingInput ¶
type PutBucketTaggingInput struct { // The Amazon Web Services account ID of the Outposts bucket. // // This member is required. AccountId *string // The Amazon Resource Name (ARN) of the bucket. For using this parameter with // Amazon S3 on Outposts with the REST API, you must specify the name and the // x-amz-outpost-id as well. For using this parameter with S3 on Outposts with the // Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed // in the format arn:aws:s3-outposts:::outpost//bucket/. 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. // // This member is required. Bucket *string // // // This member is required. Tagging *types.Tagging // contains filtered or unexported fields }
type PutBucketTaggingOutput ¶
type PutBucketTaggingOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PutJobTaggingInput ¶
type PutJobTaggingInput struct { // The Amazon Web Services account ID associated with the S3 Batch Operations job. // // This member is required. AccountId *string // The ID for the S3 Batch Operations job whose tags you want to replace. // // This member is required. JobId *string // The set of tags to associate with the S3 Batch Operations job. // // This member is required. Tags []types.S3Tag // contains filtered or unexported fields }
type PutJobTaggingOutput ¶
type PutJobTaggingOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PutMultiRegionAccessPointPolicyInput ¶ added in v1.11.0
type PutMultiRegionAccessPointPolicyInput struct { // The Amazon Web Services account ID for the owner of the Multi-Region Access // Point. // // This member is required. AccountId *string // An idempotency token used to identify the request and guarantee that requests // are unique. // // This member is required. ClientToken *string // A container element containing the details of the policy for the Multi-Region // Access Point. // // This member is required. Details *types.PutMultiRegionAccessPointPolicyInput // contains filtered or unexported fields }
type PutMultiRegionAccessPointPolicyOutput ¶ added in v1.11.0
type PutMultiRegionAccessPointPolicyOutput struct { // The request token associated with the request. You can use this token with // DescribeMultiRegionAccessPointOperation // (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html) // to determine the status of asynchronous requests. RequestTokenARN *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PutPublicAccessBlockInput ¶
type PutPublicAccessBlockInput struct { // The account ID for the Amazon Web Services account whose PublicAccessBlock // configuration you want to set. // // This member is required. AccountId *string // The PublicAccessBlock configuration that you want to apply to the specified // Amazon Web Services account. // // This member is required. PublicAccessBlockConfiguration *types.PublicAccessBlockConfiguration // contains filtered or unexported fields }
type PutPublicAccessBlockOutput ¶
type PutPublicAccessBlockOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PutStorageLensConfigurationInput ¶ added in v0.30.0
type PutStorageLensConfigurationInput struct { // The account ID of the requester. // // This member is required. AccountId *string // The ID of the S3 Storage Lens configuration. // // This member is required. ConfigId *string // The S3 Storage Lens configuration. // // This member is required. StorageLensConfiguration *types.StorageLensConfiguration // The tag set of the S3 Storage Lens configuration. You can set up to a maximum of // 50 tags. Tags []types.StorageLensTag // contains filtered or unexported fields }
type PutStorageLensConfigurationOutput ¶ added in v0.30.0
type PutStorageLensConfigurationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PutStorageLensConfigurationTaggingInput ¶ added in v0.30.0
type PutStorageLensConfigurationTaggingInput struct { // The account ID of the requester. // // This member is required. AccountId *string // The ID of the S3 Storage Lens configuration. // // This member is required. ConfigId *string // The tag set of the S3 Storage Lens configuration. You can set up to a maximum of // 50 tags. // // This member is required. Tags []types.StorageLensTag // contains filtered or unexported fields }
type PutStorageLensConfigurationTaggingOutput ¶ added in v0.30.0
type PutStorageLensConfigurationTaggingOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type ResponseError ¶ added in v0.31.0
ResponseError provides the HTTP centric error type wrapping the underlying error with the HTTP response value and the deserialized RequestID.
type UpdateJobPriorityInput ¶
type UpdateJobPriorityInput struct { // The Amazon Web Services account ID associated with the S3 Batch Operations job. // // This member is required. AccountId *string // The ID for the job whose priority you want to update. // // This member is required. JobId *string // The priority you want to assign to this job. // // This member is required. Priority int32 // contains filtered or unexported fields }
type UpdateJobPriorityOutput ¶
type UpdateJobPriorityOutput struct { // The ID for the job whose priority Amazon S3 updated. // // This member is required. JobId *string // The new priority assigned to the specified job. // // This member is required. Priority int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateJobStatusInput ¶
type UpdateJobStatusInput struct { // The Amazon Web Services account ID associated with the S3 Batch Operations job. // // This member is required. AccountId *string // The ID of the job whose status you want to update. // // This member is required. JobId *string // The status that you want to move the specified job to. // // This member is required. RequestedJobStatus types.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 // contains filtered or unexported fields }
type UpdateJobStatusOutput ¶
type UpdateJobStatusOutput struct { // The ID for the job whose status was updated. JobId *string // The current status for the specified job. Status types.JobStatus // The reason that the specified job's status was updated. StatusUpdateReason *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files ¶
- api_client.go
- api_op_CreateAccessPoint.go
- api_op_CreateAccessPointForObjectLambda.go
- api_op_CreateBucket.go
- api_op_CreateJob.go
- api_op_CreateMultiRegionAccessPoint.go
- api_op_DeleteAccessPoint.go
- api_op_DeleteAccessPointForObjectLambda.go
- api_op_DeleteAccessPointPolicy.go
- api_op_DeleteAccessPointPolicyForObjectLambda.go
- api_op_DeleteBucket.go
- api_op_DeleteBucketLifecycleConfiguration.go
- api_op_DeleteBucketPolicy.go
- api_op_DeleteBucketTagging.go
- api_op_DeleteJobTagging.go
- api_op_DeleteMultiRegionAccessPoint.go
- api_op_DeletePublicAccessBlock.go
- api_op_DeleteStorageLensConfiguration.go
- api_op_DeleteStorageLensConfigurationTagging.go
- api_op_DescribeJob.go
- api_op_DescribeMultiRegionAccessPointOperation.go
- api_op_GetAccessPoint.go
- api_op_GetAccessPointConfigurationForObjectLambda.go
- api_op_GetAccessPointForObjectLambda.go
- api_op_GetAccessPointPolicy.go
- api_op_GetAccessPointPolicyForObjectLambda.go
- api_op_GetAccessPointPolicyStatus.go
- api_op_GetAccessPointPolicyStatusForObjectLambda.go
- api_op_GetBucket.go
- api_op_GetBucketLifecycleConfiguration.go
- api_op_GetBucketPolicy.go
- api_op_GetBucketTagging.go
- api_op_GetJobTagging.go
- api_op_GetMultiRegionAccessPoint.go
- api_op_GetMultiRegionAccessPointPolicy.go
- api_op_GetMultiRegionAccessPointPolicyStatus.go
- api_op_GetPublicAccessBlock.go
- api_op_GetStorageLensConfiguration.go
- api_op_GetStorageLensConfigurationTagging.go
- api_op_ListAccessPoints.go
- api_op_ListAccessPointsForObjectLambda.go
- api_op_ListJobs.go
- api_op_ListMultiRegionAccessPoints.go
- api_op_ListRegionalBuckets.go
- api_op_ListStorageLensConfigurations.go
- api_op_PutAccessPointConfigurationForObjectLambda.go
- api_op_PutAccessPointPolicy.go
- api_op_PutAccessPointPolicyForObjectLambda.go
- api_op_PutBucketLifecycleConfiguration.go
- api_op_PutBucketPolicy.go
- api_op_PutBucketTagging.go
- api_op_PutJobTagging.go
- api_op_PutMultiRegionAccessPointPolicy.go
- api_op_PutPublicAccessBlock.go
- api_op_PutStorageLensConfiguration.go
- api_op_PutStorageLensConfigurationTagging.go
- api_op_UpdateJobPriority.go
- api_op_UpdateJobStatus.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- serializers.go
- validators.go
Directories ¶
Path | Synopsis |
---|---|
internal
|
|
customizations
Package customizations provides customizations for the Amazon S3-Control API client.
|
Package customizations provides customizations for the Amazon S3-Control API client. |