s3control

package
v0.11.0 Latest Latest
Warning

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

 Go to latest Published: Aug 23, 2019 License: Apache-2.0 Imports: 9 Imported by: 30

Documentation

Overview

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

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

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

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

Using the Client

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

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

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

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

Index

Constants

View Source 
const (
	ServiceName = "AWS S3 Control" // Service's name
	ServiceID   = "S3Control"      // Service's identifier
	EndpointsID = "s3-control"     // Service's Endpoint identifier
)
View Source 
const (

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

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

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

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

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

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

	// ErrCodeNoSuchPublicAccessBlockConfiguration for service response error code
	// "NoSuchPublicAccessBlockConfiguration".
	ErrCodeNoSuchPublicAccessBlockConfiguration = "NoSuchPublicAccessBlockConfiguration"

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

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

Variables

This section is empty.

Functions

This section is empty.

Types

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

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

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

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := s3control.New(myConfig)

func (*Client) CreateJobRequest added in v0.9.0 

func (c *Client) CreateJobRequest(input *CreateJobInput) CreateJobRequest

CreateJobRequest returns a request value for making API operation for AWS S3 Control.

Creates an Amazon S3 batch operations job. 

// Example sending a request using CreateJobRequest.
req := client.CreateJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeletePublicAccessBlockRequest added in v0.9.0 

func (c *Client) DeletePublicAccessBlockRequest(input *DeletePublicAccessBlockInput) DeletePublicAccessBlockRequest

DeletePublicAccessBlockRequest returns a request value for making API operation for AWS S3 Control.

Deletes the block public access configuration for the specified account. 

// Example sending a request using DeletePublicAccessBlockRequest.
req := client.DeletePublicAccessBlockRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeJobRequest added in v0.9.0 

func (c *Client) DescribeJobRequest(input *DescribeJobInput) DescribeJobRequest

DescribeJobRequest returns a request value for making API operation for AWS S3 Control.

Retrieves the configuration parameters and status for a batch operations job. 

// Example sending a request using DescribeJobRequest.
req := client.DescribeJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetPublicAccessBlockRequest added in v0.9.0 

func (c *Client) GetPublicAccessBlockRequest(input *GetPublicAccessBlockInput) GetPublicAccessBlockRequest

GetPublicAccessBlockRequest returns a request value for making API operation for AWS S3 Control. 

// Example sending a request using GetPublicAccessBlockRequest.
req := client.GetPublicAccessBlockRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetPublicAccessBlock

func (*Client) ListJobsRequest added in v0.9.0 

func (c *Client) ListJobsRequest(input *ListJobsInput) ListJobsRequest

ListJobsRequest returns a request value for making API operation for AWS S3 Control.

Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request. 

// Example sending a request using ListJobsRequest.
req := client.ListJobsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/ListJobs

func (*Client) PutPublicAccessBlockRequest added in v0.9.0 

func (c *Client) PutPublicAccessBlockRequest(input *PutPublicAccessBlockInput) PutPublicAccessBlockRequest

PutPublicAccessBlockRequest returns a request value for making API operation for AWS S3 Control. 

// Example sending a request using PutPublicAccessBlockRequest.
req := client.PutPublicAccessBlockRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutPublicAccessBlock

func (*Client) UpdateJobPriorityRequest added in v0.9.0 

func (c *Client) UpdateJobPriorityRequest(input *UpdateJobPriorityInput) UpdateJobPriorityRequest

UpdateJobPriorityRequest returns a request value for making API operation for AWS S3 Control.

Updates an existing job's priority. 

// Example sending a request using UpdateJobPriorityRequest.
req := client.UpdateJobPriorityRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/UpdateJobPriority

func (*Client) UpdateJobStatusRequest added in v0.9.0 

func (c *Client) UpdateJobStatusRequest(input *UpdateJobStatusInput) UpdateJobStatusRequest

UpdateJobStatusRequest returns a request value for making API operation for AWS S3 Control.

Updates the status for the specified job. Use this operation to confirm that you want to run a job or to cancel an existing job. 

// Example sending a request using UpdateJobStatusRequest.
req := client.UpdateJobStatusRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/UpdateJobStatus

type CreateJobInput added in v0.9.0 

type CreateJobInput struct {

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

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

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

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

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

	// The operation that you want this job to perform on each object listed in
	// the manifest. For more information about the available operations, see Available
	// Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// Operation is a required field
	Operation *JobOperation `type:"structure" required:"true"`

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

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

	// The Amazon Resource Name (ARN) for the Identity and Access Management (IAM)
	// Role that batch operations will use to execute this job's operation on each
	// object in the manifest.
	//
	// RoleArn is a required field
	RoleArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/CreateJobRequest

func (CreateJobInput) MarshalFields added in v0.9.0 

func (s CreateJobInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateJobInput) String added in v0.9.0 

func (s CreateJobInput) String() string

String returns the string representation

func (*CreateJobInput) Validate added in v0.9.0 

func (s *CreateJobInput) Validate() error

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

type CreateJobOutput added in v0.9.0 

type CreateJobOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/CreateJobResult

func (CreateJobOutput) MarshalFields added in v0.9.0 

func (s CreateJobOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateJobOutput) String added in v0.9.0 

func (s CreateJobOutput) String() string

String returns the string representation

type CreateJobRequest added in v0.9.0 

type CreateJobRequest struct {
	*aws.Request
	Input *CreateJobInput
	Copy  func(*CreateJobInput) CreateJobRequest
}

CreateJobRequest is the request type for the CreateJob API operation.

func (CreateJobRequest) Send added in v0.9.0 

func (r CreateJobRequest) Send(ctx context.Context) (*CreateJobResponse, error)

Send marshals and sends the CreateJob API request.

type CreateJobResponse added in v0.9.0 

type CreateJobResponse struct {
	*CreateJobOutput
	// contains filtered or unexported fields
}

CreateJobResponse is the response type for the CreateJob API operation.

func (*CreateJobResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateJob request.

type DeletePublicAccessBlockInput 

type DeletePublicAccessBlockInput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeletePublicAccessBlockRequest

func (DeletePublicAccessBlockInput) MarshalFields 

func (s DeletePublicAccessBlockInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeletePublicAccessBlockInput) String 

func (s DeletePublicAccessBlockInput) String() string

String returns the string representation

func (*DeletePublicAccessBlockInput) Validate 

func (s *DeletePublicAccessBlockInput) Validate() error

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

type DeletePublicAccessBlockOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeletePublicAccessBlockOutput

func (DeletePublicAccessBlockOutput) MarshalFields 

func (s DeletePublicAccessBlockOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeletePublicAccessBlockOutput) String 

func (s DeletePublicAccessBlockOutput) String() string

String returns the string representation

type DeletePublicAccessBlockRequest 

type DeletePublicAccessBlockRequest struct {
	*aws.Request
	Input *DeletePublicAccessBlockInput
	Copy  func(*DeletePublicAccessBlockInput) DeletePublicAccessBlockRequest
}

DeletePublicAccessBlockRequest is the request type for the DeletePublicAccessBlock API operation.

func (DeletePublicAccessBlockRequest) Send 

func (r DeletePublicAccessBlockRequest) Send(ctx context.Context) (*DeletePublicAccessBlockResponse, error)

Send marshals and sends the DeletePublicAccessBlock API request.

type DeletePublicAccessBlockResponse added in v0.9.0 

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

DeletePublicAccessBlockResponse is the response type for the DeletePublicAccessBlock API operation.

func (*DeletePublicAccessBlockResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeletePublicAccessBlockResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeletePublicAccessBlock request.

type DescribeJobInput added in v0.9.0 

type DescribeJobInput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DescribeJobRequest

func (DescribeJobInput) MarshalFields added in v0.9.0 

func (s DescribeJobInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeJobInput) String added in v0.9.0 

func (s DescribeJobInput) String() string

String returns the string representation

func (*DescribeJobInput) Validate added in v0.9.0 

func (s *DescribeJobInput) Validate() error

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

type DescribeJobOutput added in v0.9.0 

type DescribeJobOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DescribeJobResult

func (DescribeJobOutput) MarshalFields added in v0.9.0 

func (s DescribeJobOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeJobOutput) String added in v0.9.0 

func (s DescribeJobOutput) String() string

String returns the string representation

type DescribeJobRequest added in v0.9.0 

type DescribeJobRequest struct {
	*aws.Request
	Input *DescribeJobInput
	Copy  func(*DescribeJobInput) DescribeJobRequest
}

DescribeJobRequest is the request type for the DescribeJob API operation.

func (DescribeJobRequest) Send added in v0.9.0 

func (r DescribeJobRequest) Send(ctx context.Context) (*DescribeJobResponse, error)

Send marshals and sends the DescribeJob API request.

type DescribeJobResponse added in v0.9.0 

type DescribeJobResponse struct {
	*DescribeJobOutput
	// contains filtered or unexported fields
}

DescribeJobResponse is the response type for the DescribeJob API operation.

func (*DescribeJobResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeJob request.

type GetPublicAccessBlockInput 

type GetPublicAccessBlockInput struct {

	// AccountId is a required field
	AccountId *string `location:"header" locationName:"x-amz-account-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetPublicAccessBlockRequest

func (GetPublicAccessBlockInput) MarshalFields 

func (s GetPublicAccessBlockInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetPublicAccessBlockInput) String 

func (s GetPublicAccessBlockInput) String() string

String returns the string representation

func (*GetPublicAccessBlockInput) Validate 

func (s *GetPublicAccessBlockInput) Validate() error

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

type GetPublicAccessBlockOutput 

type GetPublicAccessBlockOutput struct {
	PublicAccessBlockConfiguration *PublicAccessBlockConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetPublicAccessBlockOutput

func (GetPublicAccessBlockOutput) MarshalFields 

func (s GetPublicAccessBlockOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetPublicAccessBlockOutput) String 

func (s GetPublicAccessBlockOutput) String() string

String returns the string representation

type GetPublicAccessBlockRequest 

type GetPublicAccessBlockRequest struct {
	*aws.Request
	Input *GetPublicAccessBlockInput
	Copy  func(*GetPublicAccessBlockInput) GetPublicAccessBlockRequest
}

GetPublicAccessBlockRequest is the request type for the GetPublicAccessBlock API operation.

func (GetPublicAccessBlockRequest) Send 

func (r GetPublicAccessBlockRequest) Send(ctx context.Context) (*GetPublicAccessBlockResponse, error)

Send marshals and sends the GetPublicAccessBlock API request.

type GetPublicAccessBlockResponse added in v0.9.0 

type GetPublicAccessBlockResponse struct {
	*GetPublicAccessBlockOutput
	// contains filtered or unexported fields
}

GetPublicAccessBlockResponse is the response type for the GetPublicAccessBlock API operation.

func (*GetPublicAccessBlockResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetPublicAccessBlockResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetPublicAccessBlock request.

type JobDescriptor added in v0.9.0 

type JobDescriptor struct {

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

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

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

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

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

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

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

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

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

	// Describes the total number of tasks that the specified job has executed,
	// the number of tasks that succeeded, and the number of tasks that failed.
	ProgressSummary *JobProgressSummary `type:"structure"`

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

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

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

	StatusUpdateReason *string `min:"1" type:"string"`

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

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

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

A container element for the job configuration and status information returned by a Describe Job request. Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobDescriptor

func (JobDescriptor) MarshalFields added in v0.9.0 

func (s JobDescriptor) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JobDescriptor) String added in v0.9.0 

func (s JobDescriptor) String() string

String returns the string representation

type JobFailure added in v0.9.0 

type JobFailure struct {

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

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

If this job failed, this element indicates why the job failed. Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobFailure

func (JobFailure) MarshalFields added in v0.9.0 

func (s JobFailure) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JobFailure) String added in v0.9.0 

func (s JobFailure) String() string

String returns the string representation

type JobListDescriptor added in v0.9.0 

type JobListDescriptor struct {

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

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

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

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

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

	// Describes the total number of tasks that the specified job has executed,
	// the number of tasks that succeeded, and the number of tasks that failed.
	ProgressSummary *JobProgressSummary `type:"structure"`

	// The specified job's current status.
	Status JobStatus `type:"string" enum:"true"`

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

Contains the configuration and status information for a single job retrieved as part of a job list. Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobListDescriptor

func (JobListDescriptor) MarshalFields added in v0.9.0 

func (s JobListDescriptor) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JobListDescriptor) String added in v0.9.0 

func (s JobListDescriptor) String() string

String returns the string representation

type JobManifest added in v0.9.0 

type JobManifest struct {

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

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

Contains the configuration information for a job's manifest. Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobManifest

func (JobManifest) MarshalFields added in v0.9.0 

func (s JobManifest) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JobManifest) String added in v0.9.0 

func (s JobManifest) String() string

String returns the string representation

func (*JobManifest) Validate added in v0.9.0 

func (s *JobManifest) Validate() error

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

type JobManifestFieldName added in v0.9.0 

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

Enum values for JobManifestFieldName

func (JobManifestFieldName) MarshalValue added in v0.9.0 

func (enum JobManifestFieldName) MarshalValue() (string, error)

func (JobManifestFieldName) MarshalValueBuf added in v0.9.0 

func (enum JobManifestFieldName) MarshalValueBuf(b []byte) ([]byte, error)

type JobManifestFormat added in v0.9.0 

type JobManifestFormat string
const (
	JobManifestFormatS3batchOperationsCsv20180820 JobManifestFormat = "S3BatchOperations_CSV_20180820"
	JobManifestFormatS3inventoryReportCsv20161130 JobManifestFormat = "S3InventoryReport_CSV_20161130"
)

Enum values for JobManifestFormat

func (JobManifestFormat) MarshalValue added in v0.9.0 

func (enum JobManifestFormat) MarshalValue() (string, error)

func (JobManifestFormat) MarshalValueBuf added in v0.9.0 

func (enum JobManifestFormat) MarshalValueBuf(b []byte) ([]byte, error)

type JobManifestLocation added in v0.9.0 

type JobManifestLocation struct {

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

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

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

Contains the information required to locate a manifest object. Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobManifestLocation

func (JobManifestLocation) MarshalFields added in v0.9.0 

func (s JobManifestLocation) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JobManifestLocation) String added in v0.9.0 

func (s JobManifestLocation) String() string

String returns the string representation

func (*JobManifestLocation) Validate added in v0.9.0 

func (s *JobManifestLocation) Validate() error

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

type JobManifestSpec added in v0.9.0 

type JobManifestSpec struct {

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

	// Indicates which of the available formats the specified manifest uses.
	//
	// Format is a required field
	Format JobManifestFormat `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Describes the format of a manifest. If the manifest is in CSV format, also describes the columns contained within the manifest. Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobManifestSpec

func (JobManifestSpec) MarshalFields added in v0.9.0 

func (s JobManifestSpec) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JobManifestSpec) String added in v0.9.0 

func (s JobManifestSpec) String() string

String returns the string representation

func (*JobManifestSpec) Validate added in v0.9.0 

func (s *JobManifestSpec) Validate() error

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

type JobOperation added in v0.9.0 

type JobOperation struct {

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

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

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

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

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

The operation that you want this job to perform on each object listed in the manifest. For more information about the available operations, see Available Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html) in the Amazon Simple Storage Service Developer Guide. Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobOperation

func (JobOperation) MarshalFields added in v0.9.0 

func (s JobOperation) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JobOperation) String added in v0.9.0 

func (s JobOperation) String() string

String returns the string representation

func (*JobOperation) Validate added in v0.9.0 

func (s *JobOperation) Validate() error

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

type JobProgressSummary added in v0.9.0 

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

	NumberOfTasksSucceeded *int64 `type:"long"`

	TotalNumberOfTasks *int64 `type:"long"`
	// contains filtered or unexported fields
}

Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed. Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobProgressSummary

func (JobProgressSummary) MarshalFields added in v0.9.0 

func (s JobProgressSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JobProgressSummary) String added in v0.9.0 

func (s JobProgressSummary) String() string

String returns the string representation

type JobReport added in v0.9.0 

type JobReport struct {

	// The bucket where specified job-completion report will be stored.
	Bucket *string `min:"1" type:"string"`

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

	// The format of the specified job-completion report.
	Format JobReportFormat `type:"string" enum:"true"`

	// An optional prefix to describe where in the specified bucket the job-completion
	// report will be stored. Amazon S3 will store the job-completion report at
	// <prefix>/job-<job-id>/report.json.
	Prefix *string `min:"1" type:"string"`

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

Contains the configuration parameters for a job-completion report. Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobReport

func (JobReport) MarshalFields added in v0.9.0 

func (s JobReport) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JobReport) String added in v0.9.0 

func (s JobReport) String() string

String returns the string representation

func (*JobReport) Validate added in v0.9.0 

func (s *JobReport) Validate() error

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

type JobReportFormat added in v0.9.0 

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

Enum values for JobReportFormat

func (JobReportFormat) MarshalValue added in v0.9.0 

func (enum JobReportFormat) MarshalValue() (string, error)

func (JobReportFormat) MarshalValueBuf added in v0.9.0 

func (enum JobReportFormat) MarshalValueBuf(b []byte) ([]byte, error)

type JobReportScope added in v0.9.0 

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

Enum values for JobReportScope

func (JobReportScope) MarshalValue added in v0.9.0 

func (enum JobReportScope) MarshalValue() (string, error)

func (JobReportScope) MarshalValueBuf added in v0.9.0 

func (enum JobReportScope) MarshalValueBuf(b []byte) ([]byte, error)

type JobStatus added in v0.9.0 

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

Enum values for JobStatus

func (JobStatus) MarshalValue added in v0.9.0 

func (enum JobStatus) MarshalValue() (string, error)

func (JobStatus) MarshalValueBuf added in v0.9.0 

func (enum JobStatus) MarshalValueBuf(b []byte) ([]byte, error)

type LambdaInvokeOperation added in v0.9.0 

type LambdaInvokeOperation struct {

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

Contains the configuration parameters for a Lambda Invoke operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/LambdaInvokeOperation

func (LambdaInvokeOperation) MarshalFields added in v0.9.0 

func (s LambdaInvokeOperation) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (LambdaInvokeOperation) String added in v0.9.0 

func (s LambdaInvokeOperation) String() string

String returns the string representation

func (*LambdaInvokeOperation) Validate added in v0.9.0 

func (s *LambdaInvokeOperation) Validate() error

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

type ListJobsInput added in v0.9.0 

type ListJobsInput struct {

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

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

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/ListJobsRequest

func (ListJobsInput) MarshalFields added in v0.9.0 

func (s ListJobsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListJobsInput) String added in v0.9.0 

func (s ListJobsInput) String() string

String returns the string representation

func (*ListJobsInput) Validate added in v0.9.0 

func (s *ListJobsInput) Validate() error

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

type ListJobsOutput added in v0.9.0 

type ListJobsOutput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/ListJobsResult

func (ListJobsOutput) MarshalFields added in v0.9.0 

func (s ListJobsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListJobsOutput) String added in v0.9.0 

func (s ListJobsOutput) String() string

String returns the string representation

type ListJobsPaginator added in v0.9.0 

type ListJobsPaginator struct {
	aws.Pager
}

ListJobsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListJobsPaginator added in v0.9.0 

func NewListJobsPaginator(req ListJobsRequest) ListJobsPaginator

NewListJobsRequestPaginator returns a paginator for ListJobs. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListJobsRequest(input)
p := s3control.NewListJobsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListJobsPaginator) CurrentPage added in v0.9.0 

func (p *ListJobsPaginator) CurrentPage() *ListJobsOutput

type ListJobsRequest added in v0.9.0 

type ListJobsRequest struct {
	*aws.Request
	Input *ListJobsInput
	Copy  func(*ListJobsInput) ListJobsRequest
}

ListJobsRequest is the request type for the ListJobs API operation.

func (ListJobsRequest) Send added in v0.9.0 

func (r ListJobsRequest) Send(ctx context.Context) (*ListJobsResponse, error)

Send marshals and sends the ListJobs API request.

type ListJobsResponse added in v0.9.0 

type ListJobsResponse struct {
	*ListJobsOutput
	// contains filtered or unexported fields
}

ListJobsResponse is the response type for the ListJobs API operation.

func (*ListJobsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListJobsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListJobs request.

type OperationName added in v0.9.0 

type OperationName string
const (
	OperationNameLambdaInvoke            OperationName = "LambdaInvoke"
	OperationNameS3putObjectCopy         OperationName = "S3PutObjectCopy"
	OperationNameS3putObjectAcl          OperationName = "S3PutObjectAcl"
	OperationNameS3putObjectTagging      OperationName = "S3PutObjectTagging"
	OperationNameS3initiateRestoreObject OperationName = "S3InitiateRestoreObject"
)

Enum values for OperationName

func (OperationName) MarshalValue added in v0.9.0 

func (enum OperationName) MarshalValue() (string, error)

func (OperationName) MarshalValueBuf added in v0.9.0 

func (enum OperationName) MarshalValueBuf(b []byte) ([]byte, error)

type PublicAccessBlockConfiguration 

type PublicAccessBlockConfiguration struct {
	BlockPublicAcls *bool `locationName:"BlockPublicAcls" type:"boolean"`

	BlockPublicPolicy *bool `locationName:"BlockPublicPolicy" type:"boolean"`

	IgnorePublicAcls *bool `locationName:"IgnorePublicAcls" type:"boolean"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PublicAccessBlockConfiguration

func (PublicAccessBlockConfiguration) MarshalFields 

func (s PublicAccessBlockConfiguration) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PublicAccessBlockConfiguration) String 

func (s PublicAccessBlockConfiguration) String() string

String returns the string representation

type PutPublicAccessBlockInput 

type PutPublicAccessBlockInput struct {

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

	// PublicAccessBlockConfiguration is a required field
	PublicAccessBlockConfiguration *PublicAccessBlockConfiguration `` /* 137-byte string literal not displayed */
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutPublicAccessBlockRequest

func (PutPublicAccessBlockInput) MarshalFields 

func (s PutPublicAccessBlockInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutPublicAccessBlockInput) String 

func (s PutPublicAccessBlockInput) String() string

String returns the string representation

func (*PutPublicAccessBlockInput) Validate 

func (s *PutPublicAccessBlockInput) Validate() error

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

type PutPublicAccessBlockOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutPublicAccessBlockOutput

func (PutPublicAccessBlockOutput) MarshalFields 

func (s PutPublicAccessBlockOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutPublicAccessBlockOutput) String 

func (s PutPublicAccessBlockOutput) String() string

String returns the string representation

type PutPublicAccessBlockRequest 

type PutPublicAccessBlockRequest struct {
	*aws.Request
	Input *PutPublicAccessBlockInput
	Copy  func(*PutPublicAccessBlockInput) PutPublicAccessBlockRequest
}

PutPublicAccessBlockRequest is the request type for the PutPublicAccessBlock API operation.

func (PutPublicAccessBlockRequest) Send 

func (r PutPublicAccessBlockRequest) Send(ctx context.Context) (*PutPublicAccessBlockResponse, error)

Send marshals and sends the PutPublicAccessBlock API request.

type PutPublicAccessBlockResponse added in v0.9.0 

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

PutPublicAccessBlockResponse is the response type for the PutPublicAccessBlock API operation.

func (*PutPublicAccessBlockResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutPublicAccessBlockResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutPublicAccessBlock request.

type RequestedJobStatus added in v0.9.0 

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

Enum values for RequestedJobStatus

func (RequestedJobStatus) MarshalValue added in v0.9.0 

func (enum RequestedJobStatus) MarshalValue() (string, error)

func (RequestedJobStatus) MarshalValueBuf added in v0.9.0 

func (enum RequestedJobStatus) MarshalValueBuf(b []byte) ([]byte, error)

type S3AccessControlList added in v0.9.0 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3AccessControlList

func (S3AccessControlList) MarshalFields added in v0.9.0 

func (s S3AccessControlList) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (S3AccessControlList) String added in v0.9.0 

func (s S3AccessControlList) String() string

String returns the string representation

func (*S3AccessControlList) Validate added in v0.9.0 

func (s *S3AccessControlList) Validate() error

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

type S3AccessControlPolicy added in v0.9.0 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3AccessControlPolicy

func (S3AccessControlPolicy) MarshalFields added in v0.9.0 

func (s S3AccessControlPolicy) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (S3AccessControlPolicy) String added in v0.9.0 

func (s S3AccessControlPolicy) String() string

String returns the string representation

func (*S3AccessControlPolicy) Validate added in v0.9.0 

func (s *S3AccessControlPolicy) Validate() error

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

type S3CannedAccessControlList added in v0.9.0 

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

Enum values for S3CannedAccessControlList

func (S3CannedAccessControlList) MarshalValue added in v0.9.0 

func (enum S3CannedAccessControlList) MarshalValue() (string, error)

func (S3CannedAccessControlList) MarshalValueBuf added in v0.9.0 

func (enum S3CannedAccessControlList) MarshalValueBuf(b []byte) ([]byte, error)

type S3CopyObjectOperation added in v0.9.0 

type S3CopyObjectOperation struct {
	AccessControlGrants []S3Grant `type:"list"`

	CannedAccessControlList S3CannedAccessControlList `type:"string" enum:"true"`

	MetadataDirective S3MetadataDirective `type:"string" enum:"true"`

	ModifiedSinceConstraint *time.Time `type:"timestamp"`

	NewObjectMetadata *S3ObjectMetadata `type:"structure"`

	NewObjectTagging []S3Tag `type:"list"`

	ObjectLockLegalHoldStatus S3ObjectLockLegalHoldStatus `type:"string" enum:"true"`

	ObjectLockMode S3ObjectLockMode `type:"string" enum:"true"`

	ObjectLockRetainUntilDate *time.Time `type:"timestamp"`

	RedirectLocation *string `min:"1" type:"string"`

	RequesterPays *bool `type:"boolean"`

	SSEAwsKmsKeyId *string `min:"1" type:"string"`

	StorageClass S3StorageClass `type:"string" enum:"true"`

	TargetKeyPrefix *string `min:"1" type:"string"`

	TargetResource *string `min:"1" type:"string"`

	UnModifiedSinceConstraint *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Contains the configuration parameters for a PUT Copy object operation. Amazon S3 batch operations passes each value through to the underlying PUT Copy object API. For more information about the parameters for this operation, see PUT Object - Copy (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectCOPY.html). Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3CopyObjectOperation

func (S3CopyObjectOperation) MarshalFields added in v0.9.0 

func (s S3CopyObjectOperation) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (S3CopyObjectOperation) String added in v0.9.0 

func (s S3CopyObjectOperation) String() string

String returns the string representation

func (*S3CopyObjectOperation) Validate added in v0.9.0 

func (s *S3CopyObjectOperation) Validate() error

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

type S3GlacierJobTier added in v0.9.0 

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

Enum values for S3GlacierJobTier

func (S3GlacierJobTier) MarshalValue added in v0.9.0 

func (enum S3GlacierJobTier) MarshalValue() (string, error)

func (S3GlacierJobTier) MarshalValueBuf added in v0.9.0 

func (enum S3GlacierJobTier) MarshalValueBuf(b []byte) ([]byte, error)

type S3Grant added in v0.9.0 

type S3Grant struct {
	Grantee *S3Grantee `type:"structure"`

	Permission S3Permission `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3Grant

func (S3Grant) MarshalFields added in v0.9.0 

func (s S3Grant) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (S3Grant) String added in v0.9.0 

func (s S3Grant) String() string

String returns the string representation

func (*S3Grant) Validate added in v0.9.0 

func (s *S3Grant) Validate() error

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

type S3Grantee added in v0.9.0 

type S3Grantee struct {
	DisplayName *string `min:"1" type:"string"`

	Identifier *string `min:"1" type:"string"`

	TypeIdentifier S3GranteeTypeIdentifier `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3Grantee

func (S3Grantee) MarshalFields added in v0.9.0 

func (s S3Grantee) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (S3Grantee) String added in v0.9.0 

func (s S3Grantee) String() string

String returns the string representation

func (*S3Grantee) Validate added in v0.9.0 

func (s *S3Grantee) Validate() error

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

type S3GranteeTypeIdentifier added in v0.9.0 

type S3GranteeTypeIdentifier string
const (
	S3GranteeTypeIdentifierId           S3GranteeTypeIdentifier = "id"
	S3GranteeTypeIdentifierEmailAddress S3GranteeTypeIdentifier = "emailAddress"
	S3GranteeTypeIdentifierUri          S3GranteeTypeIdentifier = "uri"
)

Enum values for S3GranteeTypeIdentifier

func (S3GranteeTypeIdentifier) MarshalValue added in v0.9.0 

func (enum S3GranteeTypeIdentifier) MarshalValue() (string, error)

func (S3GranteeTypeIdentifier) MarshalValueBuf added in v0.9.0 

func (enum S3GranteeTypeIdentifier) MarshalValueBuf(b []byte) ([]byte, error)

type S3InitiateRestoreObjectOperation added in v0.9.0 

type S3InitiateRestoreObjectOperation struct {
	ExpirationInDays *int64 `type:"integer"`

	GlacierJobTier S3GlacierJobTier `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Contains the configuration parameters for an Initiate Glacier Restore job. Amazon S3 batch operations passes each value through to the underlying POST Object restore API. For more information about the parameters for this operation, see Restoring Archives (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOSTrestore.html#RESTObjectPOSTrestore-restore-request). Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3InitiateRestoreObjectOperation

func (S3InitiateRestoreObjectOperation) MarshalFields added in v0.9.0 

func (s S3InitiateRestoreObjectOperation) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (S3InitiateRestoreObjectOperation) String added in v0.9.0 

func (s S3InitiateRestoreObjectOperation) String() string

String returns the string representation

type S3MetadataDirective added in v0.9.0 

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

Enum values for S3MetadataDirective

func (S3MetadataDirective) MarshalValue added in v0.9.0 

func (enum S3MetadataDirective) MarshalValue() (string, error)

func (S3MetadataDirective) MarshalValueBuf added in v0.9.0 

func (enum S3MetadataDirective) MarshalValueBuf(b []byte) ([]byte, error)

type S3ObjectLockLegalHoldStatus added in v0.9.0 

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

Enum values for S3ObjectLockLegalHoldStatus

func (S3ObjectLockLegalHoldStatus) MarshalValue added in v0.9.0 

func (enum S3ObjectLockLegalHoldStatus) MarshalValue() (string, error)

func (S3ObjectLockLegalHoldStatus) MarshalValueBuf added in v0.9.0 

func (enum S3ObjectLockLegalHoldStatus) MarshalValueBuf(b []byte) ([]byte, error)

type S3ObjectLockMode added in v0.9.0 

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

Enum values for S3ObjectLockMode

func (S3ObjectLockMode) MarshalValue added in v0.9.0 

func (enum S3ObjectLockMode) MarshalValue() (string, error)

func (S3ObjectLockMode) MarshalValueBuf added in v0.9.0 

func (enum S3ObjectLockMode) MarshalValueBuf(b []byte) ([]byte, error)

type S3ObjectMetadata added in v0.9.0 

type S3ObjectMetadata struct {
	CacheControl *string `min:"1" type:"string"`

	ContentDisposition *string `min:"1" type:"string"`

	ContentEncoding *string `min:"1" type:"string"`

	ContentLanguage *string `min:"1" type:"string"`

	ContentLength *int64 `type:"long"`

	ContentMD5 *string `min:"1" type:"string"`

	ContentType *string `min:"1" type:"string"`

	HttpExpiresDate *time.Time `type:"timestamp"`

	RequesterCharged *bool `type:"boolean"`

	SSEAlgorithm S3SSEAlgorithm `type:"string" enum:"true"`

	UserMetadata map[string]string `type:"map"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3ObjectMetadata

func (S3ObjectMetadata) MarshalFields added in v0.9.0 

func (s S3ObjectMetadata) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (S3ObjectMetadata) String added in v0.9.0 

func (s S3ObjectMetadata) String() string

String returns the string representation

func (*S3ObjectMetadata) Validate added in v0.9.0 

func (s *S3ObjectMetadata) Validate() error

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

type S3ObjectOwner added in v0.9.0 

type S3ObjectOwner struct {
	DisplayName *string `min:"1" type:"string"`

	ID *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3ObjectOwner

func (S3ObjectOwner) MarshalFields added in v0.9.0 

func (s S3ObjectOwner) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (S3ObjectOwner) String added in v0.9.0 

func (s S3ObjectOwner) String() string

String returns the string representation

func (*S3ObjectOwner) Validate added in v0.9.0 

func (s *S3ObjectOwner) Validate() error

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

type S3Permission added in v0.9.0 

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

Enum values for S3Permission

func (S3Permission) MarshalValue added in v0.9.0 

func (enum S3Permission) MarshalValue() (string, error)

func (S3Permission) MarshalValueBuf added in v0.9.0 

func (enum S3Permission) MarshalValueBuf(b []byte) ([]byte, error)

type S3SSEAlgorithm added in v0.9.0 

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

Enum values for S3SSEAlgorithm

func (S3SSEAlgorithm) MarshalValue added in v0.9.0 

func (enum S3SSEAlgorithm) MarshalValue() (string, error)

func (S3SSEAlgorithm) MarshalValueBuf added in v0.9.0 

func (enum S3SSEAlgorithm) MarshalValueBuf(b []byte) ([]byte, error)

type S3SetObjectAclOperation added in v0.9.0 

type S3SetObjectAclOperation struct {
	AccessControlPolicy *S3AccessControlPolicy `type:"structure"`
	// contains filtered or unexported fields
}

Contains the configuration parameters for a Set Object ACL operation. Amazon S3 batch operations passes each value through to the underlying PUT Object acl API. For more information about the parameters for this operation, see PUT Object acl (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUTacl.html). Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3SetObjectAclOperation

func (S3SetObjectAclOperation) MarshalFields added in v0.9.0 

func (s S3SetObjectAclOperation) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (S3SetObjectAclOperation) String added in v0.9.0 

func (s S3SetObjectAclOperation) String() string

String returns the string representation

func (*S3SetObjectAclOperation) Validate added in v0.9.0 

func (s *S3SetObjectAclOperation) Validate() error

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

type S3SetObjectTaggingOperation added in v0.9.0 

type S3SetObjectTaggingOperation struct {
	TagSet []S3Tag `type:"list"`
	// contains filtered or unexported fields
}

Contains the configuration parameters for a Set Object Tagging operation. Amazon S3 batch operations passes each value through to the underlying PUT Object tagging API. For more information about the parameters for this operation, see PUT Object tagging (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUTtagging.html). Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3SetObjectTaggingOperation

func (S3SetObjectTaggingOperation) MarshalFields added in v0.9.0 

func (s S3SetObjectTaggingOperation) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (S3SetObjectTaggingOperation) String added in v0.9.0 

func (s S3SetObjectTaggingOperation) String() string

String returns the string representation

func (*S3SetObjectTaggingOperation) Validate added in v0.9.0 

func (s *S3SetObjectTaggingOperation) Validate() error

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

type S3StorageClass added in v0.9.0 

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

Enum values for S3StorageClass

func (S3StorageClass) MarshalValue added in v0.9.0 

func (enum S3StorageClass) MarshalValue() (string, error)

func (S3StorageClass) MarshalValueBuf added in v0.9.0 

func (enum S3StorageClass) MarshalValueBuf(b []byte) ([]byte, error)

type S3Tag added in v0.9.0 

type S3Tag struct {

	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3Tag

func (S3Tag) MarshalFields added in v0.9.0 

func (s S3Tag) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (S3Tag) String added in v0.9.0 

func (s S3Tag) String() string

String returns the string representation

func (*S3Tag) Validate added in v0.9.0 

func (s *S3Tag) Validate() error

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

type UpdateJobPriorityInput added in v0.9.0 

type UpdateJobPriorityInput struct {

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

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

	// The priority you want to assign to this job.
	//
	// Priority is a required field
	Priority *int64 `location:"querystring" locationName:"priority" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/UpdateJobPriorityRequest

func (UpdateJobPriorityInput) MarshalFields added in v0.9.0 

func (s UpdateJobPriorityInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateJobPriorityInput) String added in v0.9.0 

func (s UpdateJobPriorityInput) String() string

String returns the string representation

func (*UpdateJobPriorityInput) Validate added in v0.9.0 

func (s *UpdateJobPriorityInput) Validate() error

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

type UpdateJobPriorityOutput added in v0.9.0 

type UpdateJobPriorityOutput struct {

	// The ID for the job whose priority Amazon S3 updated.
	//
	// JobId is a required field
	JobId *string `min:"5" type:"string" required:"true"`

	// The new priority assigned to the specified job.
	//
	// Priority is a required field
	Priority *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/UpdateJobPriorityResult

func (UpdateJobPriorityOutput) MarshalFields added in v0.9.0 

func (s UpdateJobPriorityOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateJobPriorityOutput) String added in v0.9.0 

func (s UpdateJobPriorityOutput) String() string

String returns the string representation

type UpdateJobPriorityRequest added in v0.9.0 

type UpdateJobPriorityRequest struct {
	*aws.Request
	Input *UpdateJobPriorityInput
	Copy  func(*UpdateJobPriorityInput) UpdateJobPriorityRequest
}

UpdateJobPriorityRequest is the request type for the UpdateJobPriority API operation.

func (UpdateJobPriorityRequest) Send added in v0.9.0 

func (r UpdateJobPriorityRequest) Send(ctx context.Context) (*UpdateJobPriorityResponse, error)

Send marshals and sends the UpdateJobPriority API request.

type UpdateJobPriorityResponse added in v0.9.0 

type UpdateJobPriorityResponse struct {
	*UpdateJobPriorityOutput
	// contains filtered or unexported fields
}

UpdateJobPriorityResponse is the response type for the UpdateJobPriority API operation.

func (*UpdateJobPriorityResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateJobPriorityResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateJobPriority request.

type UpdateJobStatusInput added in v0.9.0 

type UpdateJobStatusInput struct {

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

	// The ID of the job whose status you want to update.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"id" min:"5" type:"string" required:"true"`

	// The status that you want to move the specified job to.
	//
	// RequestedJobStatus is a required field
	RequestedJobStatus RequestedJobStatus `location:"querystring" locationName:"requestedJobStatus" type:"string" required:"true" enum:"true"`

	// A description of the reason why you want to change the specified job's status.
	// This field can be any string up to the maximum length.
	StatusUpdateReason *string `location:"querystring" locationName:"statusUpdateReason" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/UpdateJobStatusRequest

func (UpdateJobStatusInput) MarshalFields added in v0.9.0 

func (s UpdateJobStatusInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateJobStatusInput) String added in v0.9.0 

func (s UpdateJobStatusInput) String() string

String returns the string representation

func (*UpdateJobStatusInput) Validate added in v0.9.0 

func (s *UpdateJobStatusInput) Validate() error

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

type UpdateJobStatusOutput added in v0.9.0 

type UpdateJobStatusOutput struct {

	// The ID for the job whose status was updated.
	JobId *string `min:"5" type:"string"`

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

	// The reason that the specified job's status was updated.
	StatusUpdateReason *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/UpdateJobStatusResult

func (UpdateJobStatusOutput) MarshalFields added in v0.9.0 

func (s UpdateJobStatusOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateJobStatusOutput) String added in v0.9.0 

func (s UpdateJobStatusOutput) String() string

String returns the string representation

type UpdateJobStatusRequest added in v0.9.0 

type UpdateJobStatusRequest struct {
	*aws.Request
	Input *UpdateJobStatusInput
	Copy  func(*UpdateJobStatusInput) UpdateJobStatusRequest
}

UpdateJobStatusRequest is the request type for the UpdateJobStatus API operation.

func (UpdateJobStatusRequest) Send added in v0.9.0 

func (r UpdateJobStatusRequest) Send(ctx context.Context) (*UpdateJobStatusResponse, error)

Send marshals and sends the UpdateJobStatus API request.

type UpdateJobStatusResponse added in v0.9.0 

type UpdateJobStatusResponse struct {
	*UpdateJobStatusOutput
	// contains filtered or unexported fields
}

UpdateJobStatusResponse is the response type for the UpdateJobStatus API operation.

func (*UpdateJobStatusResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateJobStatusResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateJobStatus request.

Source Files

View all Source files

Directories

Path Synopsis
Package s3controliface provides an interface to enable mocking the AWS S3 Control service client for testing your code.
 Package s3controliface provides an interface to enable mocking the AWS S3 Control service client for testing your code.

Jump to

Keyboard shortcuts

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