package s3control
import "github.com/aws/aws-sdk-go-v2/service/s3control"
Index ¶
- Constants
- func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) CreateAccessPoint(ctx context.Context, params *CreateAccessPointInput, optFns ...func(*Options)) (*CreateAccessPointOutput, error)
- func (c *Client) CreateJob(ctx context.Context, params *CreateJobInput, optFns ...func(*Options)) (*CreateJobOutput, error)
- func (c *Client) DeleteAccessPoint(ctx context.Context, params *DeleteAccessPointInput, optFns ...func(*Options)) (*DeleteAccessPointOutput, error)
- func (c *Client) DeleteAccessPointPolicy(ctx context.Context, params *DeleteAccessPointPolicyInput, optFns ...func(*Options)) (*DeleteAccessPointPolicyOutput, error)
- func (c *Client) DeleteJobTagging(ctx context.Context, params *DeleteJobTaggingInput, optFns ...func(*Options)) (*DeleteJobTaggingOutput, error)
- func (c *Client) DeletePublicAccessBlock(ctx context.Context, params *DeletePublicAccessBlockInput, optFns ...func(*Options)) (*DeletePublicAccessBlockOutput, error)
- func (c *Client) DescribeJob(ctx context.Context, params *DescribeJobInput, optFns ...func(*Options)) (*DescribeJobOutput, error)
- func (c *Client) GetAccessPoint(ctx context.Context, params *GetAccessPointInput, optFns ...func(*Options)) (*GetAccessPointOutput, error)
- func (c *Client) GetAccessPointPolicy(ctx context.Context, params *GetAccessPointPolicyInput, optFns ...func(*Options)) (*GetAccessPointPolicyOutput, error)
- func (c *Client) GetAccessPointPolicyStatus(ctx context.Context, params *GetAccessPointPolicyStatusInput, optFns ...func(*Options)) (*GetAccessPointPolicyStatusOutput, error)
- func (c *Client) GetJobTagging(ctx context.Context, params *GetJobTaggingInput, optFns ...func(*Options)) (*GetJobTaggingOutput, error)
- func (c *Client) GetPublicAccessBlock(ctx context.Context, params *GetPublicAccessBlockInput, optFns ...func(*Options)) (*GetPublicAccessBlockOutput, error)
- func (c *Client) ListAccessPoints(ctx context.Context, params *ListAccessPointsInput, optFns ...func(*Options)) (*ListAccessPointsOutput, error)
- func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ...func(*Options)) (*ListJobsOutput, error)
- func (c *Client) PutAccessPointPolicy(ctx context.Context, params *PutAccessPointPolicyInput, optFns ...func(*Options)) (*PutAccessPointPolicyOutput, error)
- func (c *Client) PutJobTagging(ctx context.Context, params *PutJobTaggingInput, optFns ...func(*Options)) (*PutJobTaggingOutput, error)
- func (c *Client) PutPublicAccessBlock(ctx context.Context, params *PutPublicAccessBlockInput, optFns ...func(*Options)) (*PutPublicAccessBlockOutput, 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 CreateAccessPointInput
- type CreateAccessPointOutput
- type CreateJobInput
- type CreateJobOutput
- type DeleteAccessPointInput
- type DeleteAccessPointOutput
- type DeleteAccessPointPolicyInput
- type DeleteAccessPointPolicyOutput
- type DeleteJobTaggingInput
- type DeleteJobTaggingOutput
- type DeletePublicAccessBlockInput
- type DeletePublicAccessBlockOutput
- type DescribeJobInput
- type DescribeJobOutput
- type EndpointResolver
- type EndpointResolverFunc
- type GetAccessPointInput
- type GetAccessPointOutput
- type GetAccessPointPolicyInput
- type GetAccessPointPolicyOutput
- type GetAccessPointPolicyStatusInput
- type GetAccessPointPolicyStatusOutput
- type GetJobTaggingInput
- type GetJobTaggingOutput
- type GetPublicAccessBlockInput
- type GetPublicAccessBlockOutput
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type ListAccessPointsInput
- type ListAccessPointsOutput
- type ListJobsInput
- type ListJobsOutput
- type Options
- func (o Options) Copy() Options
- func (o Options) GetCredentials() aws.CredentialsProvider
- func (o Options) GetEndpointOptions() ResolverOptions
- func (o Options) GetEndpointResolver() EndpointResolver
- func (o Options) GetHTTPSignerV4() HTTPSignerV4
- func (o Options) GetIdempotencyTokenProvider() IdempotencyTokenProvider
- func (o Options) GetRegion() string
- func (o Options) GetRetryer() retry.Retryer
- type PutAccessPointPolicyInput
- type PutAccessPointPolicyOutput
- type PutJobTaggingInput
- type PutJobTaggingOutput
- type PutPublicAccessBlockInput
- type PutPublicAccessBlockOutput
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type ResolveEndpointMiddlewareOptions
- type ResolverOptions
- type UpdateJobPriorityInput
- type UpdateJobPriorityOutput
- type UpdateJobStatusInput
- type UpdateJobStatusOutput
Constants ¶
const ServiceAPIVersion = "2018-08-20"
const ServiceID = "S3 Control"
Functions ¶
func AddResolveEndpointMiddleware ¶
func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func RemoveResolveEndpointMiddleware ¶
func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
AWS S3 Control provides access to Amazon S3 control plane operations.
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.
func (*Client) CreateJob ¶
func (c *Client) CreateJob(ctx context.Context, params *CreateJobInput, optFns ...func(*Options)) (*CreateJobOutput, error)
You can use Amazon S3 Batch Operations to perform large-scale Batch Operations on Amazon S3 objects. Amazon S3 Batch Operations can execute a single operation or action on lists of Amazon S3 objects that you specify. For more information, see Amazon S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html) in the Amazon Simple Storage Service Developer Guide. Related actions include:
*
DescribeJob ()
ListJobs ()
UpdateJobPriority ()
*
UpdateJobStatus ()
func (*Client) DeleteAccessPoint ¶
func (c *Client) DeleteAccessPoint(ctx context.Context, params *DeleteAccessPointInput, optFns ...func(*Options)) (*DeleteAccessPointOutput, error)
Deletes the specified access point.
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.
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 Amazon S3 Batch Operations job. To use this operation, you must have permission to perform the s3:DeleteJobTagging action. For more information, see Using Job Tags (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags) in the Amazon Simple Storage Service Developer Guide. Related actions include:
* CreateJob ()
GetJobTagging ()
PutJobTagging ()
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.
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 Amazon S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html) in the Amazon Simple Storage Service Developer Guide. Related actions include:
*
CreateJob ()
ListJobs ()
UpdateJobPriority ()
*
UpdateJobStatus ()
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.
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.
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/dev/access-points.html) in the Amazon Simple Storage Service Developer Guide.
func (*Client) GetJobTagging ¶
func (c *Client) GetJobTagging(ctx context.Context, params *GetJobTaggingInput, optFns ...func(*Options)) (*GetJobTaggingOutput, error)
Returns the tags on an Amazon S3 Batch Operations job. To use this operation, you must have permission to perform the s3:GetJobTagging action. For more information, see Using Job Tags (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags) in the Amazon Simple Storage Service Developer Guide. Related actions include:
* CreateJob ()
PutJobTagging ()
DeleteJobTagging ()
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.
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.
func (*Client) ListJobs ¶
func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ...func(*Options)) (*ListJobsOutput, error)
Lists current Amazon S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request. For more information, see Amazon S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html) in the Amazon Simple Storage Service Developer Guide. Related actions include:
*
CreateJob ()
DescribeJob ()
UpdateJobPriority ()
*
UpdateJobStatus ()
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.
func (*Client) PutJobTagging ¶
func (c *Client) PutJobTagging(ctx context.Context, params *PutJobTaggingInput, optFns ...func(*Options)) (*PutJobTaggingOutput, error)
Set the supplied tag-set on an Amazon S3 Batch Operations job. A tag is a key-value pair. You can associate Amazon 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 (), modify that tag set, and use this API action to replace the tag set with the one you have modified.. For more information, see Using Job Tags (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags) in the Amazon Simple Storage Service Developer Guide.
- If you send this
request with an empty tag set, Amazon S3 deletes the existing tag set on the Batch Operations job. If you use this method, you will be 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, DeleteJobTagging () 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).
To use this operation, you must have permission to perform the s3:PutJobTagging action. Related actions include:
CreateJob ()
GetJobTagging ()
* DeleteJobTagging ()
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.
func (*Client) UpdateJobPriority ¶
func (c *Client) UpdateJobPriority(ctx context.Context, params *UpdateJobPriorityInput, optFns ...func(*Options)) (*UpdateJobPriorityOutput, error)
Updates an existing Amazon S3 Batch Operations job's priority. For more information, see Amazon S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html) in the Amazon Simple Storage Service Developer Guide. Related actions include:
*
CreateJob ()
ListJobs ()
DescribeJob ()
UpdateJobStatus ()
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 operation to confirm that you want to run a job or to cancel an existing job. For more information, see Amazon S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html) in the Amazon Simple Storage Service Developer Guide. Related actions include:
*
CreateJob ()
ListJobs ()
DescribeJob ()
UpdateJobStatus ()
type CreateAccessPointInput ¶
type CreateAccessPointInput struct { // The name of the bucket that you want to associate this access point with. Bucket *string // The name you want to assign to this access point. Name *string // The PublicAccessBlock configuration that you want to apply to this Amazon S3 // bucket. You can enable the configuration options in any combination. For more // information about when Amazon S3 considers a bucket or object public, see The // Meaning of "Public" // (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) // in the Amazon Simple Storage Service Developer Guide. PublicAccessBlockConfiguration *types.PublicAccessBlockConfiguration // The AWS account ID for the owner of the bucket for which you want to create an // access point. AccountId *string // If you include this field, Amazon S3 restricts access to this access point to // requests from the specified virtual private cloud (VPC). VpcConfiguration *types.VpcConfiguration }
type CreateAccessPointOutput ¶
type CreateAccessPointOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateJobInput ¶
type CreateJobInput struct { // 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 // AccountId *string // Configuration parameters for the optional job-completion report. Report *types.JobReport // The numerical priority for this job. Higher numbers indicate higher priority. Priority *int32 // An idempotency token to ensure that you don't accidentally submit the same // request twice. You can use any string up to the maximum length. ClientRequestToken *string // 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 // The operation that you want this job to perform on each object listed in the // manifest. For more information about the available operations, see Available // Operations // (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html) in // the Amazon Simple Storage Service Developer Guide. Operation *types.JobOperation // Configuration parameters for the manifest. Manifest *types.JobManifest // The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) // role that Batch Operations will use to execute this job's operation on each // object in the manifest. RoleArn *string // A set of tags to associate with the Amazon S3 Batch Operations job. This is an // optional parameter. Tags []*types.S3Tag }
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 }
type DeleteAccessPointInput ¶
type DeleteAccessPointInput struct { // The account ID for the account that owns the specified access point. AccountId *string // The name of the access point you want to delete. Name *string }
type DeleteAccessPointOutput ¶
type DeleteAccessPointOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteAccessPointPolicyInput ¶
type DeleteAccessPointPolicyInput struct { // The account ID for the account that owns the specified access point. AccountId *string // The name of the access point whose policy you want to delete. Name *string }
type DeleteAccessPointPolicyOutput ¶
type DeleteAccessPointPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteJobTaggingInput ¶
type DeleteJobTaggingInput struct { // The ID for the Amazon S3 Batch Operations job whose tags you want to delete. JobId *string // The AWS account ID associated with the Amazon S3 Batch Operations job. AccountId *string }
type DeleteJobTaggingOutput ¶
type DeleteJobTaggingOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeletePublicAccessBlockInput ¶
type DeletePublicAccessBlockInput struct { // The account ID for the Amazon Web Services account whose PublicAccessBlock // configuration you want to remove. AccountId *string }
type DeletePublicAccessBlockOutput ¶
type DeletePublicAccessBlockOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeJobInput ¶
type DescribeJobInput struct { // The ID for the job whose information you want to retrieve. JobId *string // AccountId *string }
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 }
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func WithEndpointResolver ¶
func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options ResolverOptions) (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 ResolverOptions) (endpoint aws.Endpoint, err error)
type GetAccessPointInput ¶
type GetAccessPointInput struct { // The name of the access point whose configuration information you want to // retrieve. Name *string // The account ID for the account that owns the specified access point. AccountId *string }
type GetAccessPointOutput ¶
type GetAccessPointOutput struct { // The name of the specified access point. Name *string // The name of the bucket associated with the specified access point. Bucket *string // Contains the virtual private cloud (VPC) configuration for the specified access // point. VpcConfiguration *types.VpcConfiguration // The date and time when the specified access point was created. CreationDate *time.Time // Indicates whether this access point allows access from the public internet. If // VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, // and the access point doesn't allow access from the public internet. Otherwise, // NetworkOrigin is Internet, and the access point allows access from the public // internet, subject to the access point and bucket access policies. NetworkOrigin types.NetworkOrigin // The PublicAccessBlock configuration that you want to apply to this Amazon S3 // bucket. You can enable the configuration options in any combination. For more // information about when Amazon S3 considers a bucket or object public, see The // Meaning of "Public" // (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) // in the Amazon Simple Storage Service Developer Guide. PublicAccessBlockConfiguration *types.PublicAccessBlockConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetAccessPointPolicyInput ¶
type GetAccessPointPolicyInput struct { // The name of the access point whose policy you want to retrieve. Name *string // The account ID for the account that owns the specified access point. AccountId *string }
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 }
type GetAccessPointPolicyStatusInput ¶
type GetAccessPointPolicyStatusInput struct { // The name of the access point whose policy status you want to retrieve. Name *string // The account ID for the account that owns the specified access point. AccountId *string }
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 }
type GetJobTaggingInput ¶
type GetJobTaggingInput struct { // The ID for the Amazon S3 Batch Operations job whose tags you want to retrieve. JobId *string // The AWS account ID associated with the Amazon S3 Batch Operations job. AccountId *string }
type GetJobTaggingOutput ¶
type GetJobTaggingOutput struct { // The set of tags associated with the Amazon S3 Batch Operations job. Tags []*types.S3Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetPublicAccessBlockInput ¶
type GetPublicAccessBlockInput struct { // The account ID for the Amazon Web Services account whose PublicAccessBlock // configuration you want to retrieve. AccountId *string }
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 }
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error }
type IdempotencyTokenProvider ¶
IdempotencyTokenProvider interface for providing idempotency token
type ListAccessPointsInput ¶
type ListAccessPointsInput struct { // The name of the bucket whose associated access points you want to list. 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 // The AWS account ID for owner of the bucket whose access points you want to list. AccountId *string // 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 }
type ListAccessPointsOutput ¶
type ListAccessPointsOutput struct { // If the specified bucket has more access points than can be returned in one call // to this API, then this field contains a continuation token that you can provide // in subsequent calls to this API to retrieve additional access points. NextToken *string // Contains identification and configuration information for one or more access // points associated with the specified bucket. AccessPointList []*types.AccessPoint // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListJobsInput ¶
type ListJobsInput struct { // The List Jobs request returns jobs that match the statuses listed in this // element. JobStatuses []types.JobStatus // 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 // 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 // AccountId *string }
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 }
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 // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions ResolverOptions // 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 region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer retry.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
func (Options) GetCredentials ¶
func (o Options) GetCredentials() aws.CredentialsProvider
func (Options) GetEndpointOptions ¶
func (o Options) GetEndpointOptions() ResolverOptions
func (Options) GetEndpointResolver ¶
func (o Options) GetEndpointResolver() EndpointResolver
func (Options) GetHTTPSignerV4 ¶
func (o Options) GetHTTPSignerV4() HTTPSignerV4
func (Options) GetIdempotencyTokenProvider ¶
func (o Options) GetIdempotencyTokenProvider() IdempotencyTokenProvider
func (Options) GetRegion ¶
func (Options) GetRetryer ¶
type PutAccessPointPolicyInput ¶
type PutAccessPointPolicyInput struct { // The policy that you want to apply to the specified access point. For more // information about access point policies, see Managing Data Access with Amazon S3 // Access Points // (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points.html) in the // Amazon Simple Storage Service Developer Guide. Policy *string // The AWS account ID for owner of the bucket associated with the specified access // point. AccountId *string // The name of the access point that you want to associate with the specified // policy. Name *string }
type PutAccessPointPolicyOutput ¶
type PutAccessPointPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type PutJobTaggingInput ¶
type PutJobTaggingInput struct { // The ID for the Amazon S3 Batch Operations job whose tags you want to replace. JobId *string // The set of tags to associate with the Amazon S3 Batch Operations job. Tags []*types.S3Tag // The AWS account ID associated with the Amazon S3 Batch Operations job. AccountId *string }
type PutJobTaggingOutput ¶
type PutJobTaggingOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type PutPublicAccessBlockInput ¶
type PutPublicAccessBlockInput struct { // The PublicAccessBlock configuration that you want to apply to the specified // Amazon Web Services account. PublicAccessBlockConfiguration *types.PublicAccessBlockConfiguration // The account ID for the Amazon Web Services account whose PublicAccessBlock // configuration you want to set. AccountId *string }
type PutPublicAccessBlockOutput ¶
type PutPublicAccessBlockOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options ResolverOptions }
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 ResolveEndpointMiddlewareOptions ¶
type ResolveEndpointMiddlewareOptions interface { GetEndpointResolver() EndpointResolver GetEndpointOptions() ResolverOptions }
type ResolverOptions ¶
type ResolverOptions = internalendpoints.Options
ResolverOptions is the service endpoint resolver options
type UpdateJobPriorityInput ¶
type UpdateJobPriorityInput struct { // The ID for the job whose priority you want to update. JobId *string // AccountId *string // The priority you want to assign to this job. Priority *int32 }
type UpdateJobPriorityOutput ¶
type UpdateJobPriorityOutput struct { // The ID for the job whose priority Amazon S3 updated. JobId *string // The new priority assigned to the specified job. Priority *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateJobStatusInput ¶
type UpdateJobStatusInput struct { // The ID of the job whose status you want to update. JobId *string // 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 // The status that you want to move the specified job to. RequestedJobStatus types.RequestedJobStatus // AccountId *string }
type UpdateJobStatusOutput ¶
type UpdateJobStatusOutput struct { // The reason that the specified job's status was updated. StatusUpdateReason *string // The ID for the job whose status was updated. JobId *string // The current status for the specified job. Status types.JobStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Source Files ¶
api_client.go api_op_CreateAccessPoint.go api_op_CreateJob.go api_op_DeleteAccessPoint.go api_op_DeleteAccessPointPolicy.go api_op_DeleteJobTagging.go api_op_DeletePublicAccessBlock.go api_op_DescribeJob.go api_op_GetAccessPoint.go api_op_GetAccessPointPolicy.go api_op_GetAccessPointPolicyStatus.go api_op_GetJobTagging.go api_op_GetPublicAccessBlock.go api_op_ListAccessPoints.go api_op_ListJobs.go api_op_PutAccessPointPolicy.go api_op_PutJobTagging.go api_op_PutPublicAccessBlock.go api_op_UpdateJobPriority.go api_op_UpdateJobStatus.go deserializers.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v0.1.0
- Published
- Sep 29, 2020
- Platform
- js/wasm
- Imports
- 28 packages
- Last checked
- 1 second ago –
Tools for package owners.