s3control

package
v1.99.1 Latest Latest
Warning

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

 Go to latest Published: Feb 10, 2020 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

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

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

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

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

Using the Client

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

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

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

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

Index

Constants

View Source 
const (
	// JobManifestFieldNameIgnore is a JobManifestFieldName enum value
	JobManifestFieldNameIgnore = "Ignore"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	// JobStatusSuspended is a JobStatus enum value
	JobStatusSuspended = "Suspended"
)
View Source 
const (
	// OperationNameLambdaInvoke is a OperationName enum value
	OperationNameLambdaInvoke = "LambdaInvoke"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	// 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"
)
View Source 
const (
	ServiceName = "S3 Control" // Name of service.
	EndpointsID = "s3-control" // ID to lookup a service endpoint with.
	ServiceID   = "S3 Control" // ServiceID is a unique identifer of a specific service.
)

Service information constants

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

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateJobInput 

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 *string `min:"1" type:"string" idempotencyToken:"true"`

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

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

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

	// The operation that you want this job to perform on each object listed in
	// the manifest. For more information about the available operations, see 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
}

func (CreateJobInput) GoString 

func (s CreateJobInput) GoString() string

GoString returns the string representation

func (*CreateJobInput) SetAccountId 

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

SetAccountId sets the AccountId field's value.

func (*CreateJobInput) SetClientRequestToken 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateJobInput) SetConfirmationRequired 

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

SetConfirmationRequired sets the ConfirmationRequired field's value.

func (*CreateJobInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*CreateJobInput) SetManifest 

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

SetManifest sets the Manifest field's value.

func (*CreateJobInput) SetOperation 

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

SetOperation sets the Operation field's value.

func (*CreateJobInput) SetPriority 

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

SetPriority sets the Priority field's value.

func (*CreateJobInput) SetReport 

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

SetReport sets the Report field's value.

func (*CreateJobInput) SetRoleArn 

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

SetRoleArn sets the RoleArn field's value.

func (CreateJobInput) String 

func (s CreateJobInput) String() string

String returns the string representation

func (*CreateJobInput) Validate 

func (s *CreateJobInput) Validate() error

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

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

func (CreateJobOutput) GoString 

func (s CreateJobOutput) GoString() string

GoString returns the string representation

func (*CreateJobOutput) SetJobId 

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

SetJobId sets the JobId field's value.

func (CreateJobOutput) String 

func (s CreateJobOutput) String() string

String returns the string representation

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
}

func (DeletePublicAccessBlockInput) GoString 

func (s DeletePublicAccessBlockInput) GoString() string

GoString returns the string representation

func (*DeletePublicAccessBlockInput) SetAccountId 

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

SetAccountId sets the AccountId field's value.

func (DeletePublicAccessBlockInput) String 

func (s DeletePublicAccessBlockInput) String() string

String returns the string representation

func (*DeletePublicAccessBlockInput) Validate 

func (s *DeletePublicAccessBlockInput) Validate() error

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

type DeletePublicAccessBlockOutput 

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

func (DeletePublicAccessBlockOutput) GoString 

func (s DeletePublicAccessBlockOutput) GoString() string

GoString returns the string representation

func (DeletePublicAccessBlockOutput) String 

func (s DeletePublicAccessBlockOutput) String() string

String returns the string representation

type DescribeJobInput 

type DescribeJobInput struct {

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

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

func (DescribeJobInput) GoString 

func (s DescribeJobInput) GoString() string

GoString returns the string representation

func (*DescribeJobInput) SetAccountId 

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

SetAccountId sets the AccountId field's value.

func (*DescribeJobInput) SetJobId 

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

SetJobId sets the JobId field's value.

func (DescribeJobInput) String 

func (s DescribeJobInput) String() string

String returns the string representation

func (*DescribeJobInput) Validate 

func (s *DescribeJobInput) Validate() error

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

type DescribeJobOutput 

type DescribeJobOutput struct {

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

func (DescribeJobOutput) GoString 

func (s DescribeJobOutput) GoString() string

GoString returns the string representation

func (*DescribeJobOutput) SetJob 

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

SetJob sets the Job field's value.

func (DescribeJobOutput) String 

func (s DescribeJobOutput) String() string

String returns the string representation

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
}

func (GetPublicAccessBlockInput) GoString 

func (s GetPublicAccessBlockInput) GoString() string

GoString returns the string representation

func (*GetPublicAccessBlockInput) SetAccountId 

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

SetAccountId sets the AccountId field's value.

func (GetPublicAccessBlockInput) String 

func (s GetPublicAccessBlockInput) String() string

String returns the string representation

func (*GetPublicAccessBlockInput) Validate 

func (s *GetPublicAccessBlockInput) Validate() error

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

type GetPublicAccessBlockOutput 

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

func (GetPublicAccessBlockOutput) GoString 

func (s GetPublicAccessBlockOutput) GoString() string

GoString returns the string representation

func (*GetPublicAccessBlockOutput) SetPublicAccessBlockConfiguration 

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

SetPublicAccessBlockConfiguration sets the PublicAccessBlockConfiguration field's value.

func (GetPublicAccessBlockOutput) String 

func (s GetPublicAccessBlockOutput) String() string

String returns the string representation

type JobDescriptor 

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 *string `type:"string" enum:"JobStatus"`

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

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

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

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

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

func (JobDescriptor) GoString 

func (s JobDescriptor) GoString() string

GoString returns the string representation

func (*JobDescriptor) SetConfirmationRequired 

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

SetConfirmationRequired sets the ConfirmationRequired field's value.

func (*JobDescriptor) SetCreationTime 

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

SetCreationTime sets the CreationTime field's value.

func (*JobDescriptor) SetDescription 

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

SetDescription sets the Description field's value.

func (*JobDescriptor) SetFailureReasons 

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

SetFailureReasons sets the FailureReasons field's value.

func (*JobDescriptor) SetJobArn 

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

SetJobArn sets the JobArn field's value.

func (*JobDescriptor) SetJobId 

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

SetJobId sets the JobId field's value.

func (*JobDescriptor) SetManifest 

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

SetManifest sets the Manifest field's value.

func (*JobDescriptor) SetOperation 

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

SetOperation sets the Operation field's value.

func (*JobDescriptor) SetPriority 

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

SetPriority sets the Priority field's value.

func (*JobDescriptor) SetProgressSummary 

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

SetProgressSummary sets the ProgressSummary field's value.

func (*JobDescriptor) SetReport 

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

SetReport sets the Report field's value.

func (*JobDescriptor) SetRoleArn 

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

SetRoleArn sets the RoleArn field's value.

func (*JobDescriptor) SetStatus 

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

SetStatus sets the Status field's value.

func (*JobDescriptor) SetStatusUpdateReason 

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

SetStatusUpdateReason sets the StatusUpdateReason field's value.

func (*JobDescriptor) SetSuspendedCause 

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

SetSuspendedCause sets the SuspendedCause field's value.

func (*JobDescriptor) SetSuspendedDate 

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

SetSuspendedDate sets the SuspendedDate field's value.

func (*JobDescriptor) SetTerminationDate 

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

SetTerminationDate sets the TerminationDate field's value.

func (JobDescriptor) String 

func (s JobDescriptor) String() string

String returns the string representation

type JobFailure 

type JobFailure struct {

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

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

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

func (JobFailure) GoString 

func (s JobFailure) GoString() string

GoString returns the string representation

func (*JobFailure) SetFailureCode 

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

SetFailureCode sets the FailureCode field's value.

func (*JobFailure) SetFailureReason 

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

SetFailureReason sets the FailureReason field's value.

func (JobFailure) String 

func (s JobFailure) String() string

String returns the string representation

type JobListDescriptor 

type JobListDescriptor struct {

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

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

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

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

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

	// Describes the total number of tasks that the specified job has 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 *string `type:"string" enum:"JobStatus"`

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

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

func (JobListDescriptor) GoString 

func (s JobListDescriptor) GoString() string

GoString returns the string representation

func (*JobListDescriptor) SetCreationTime 

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

SetCreationTime sets the CreationTime field's value.

func (*JobListDescriptor) SetDescription 

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

SetDescription sets the Description field's value.

func (*JobListDescriptor) SetJobId 

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

SetJobId sets the JobId field's value.

func (*JobListDescriptor) SetOperation 

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

SetOperation sets the Operation field's value.

func (*JobListDescriptor) SetPriority 

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

SetPriority sets the Priority field's value.

func (*JobListDescriptor) SetProgressSummary 

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

SetProgressSummary sets the ProgressSummary field's value.

func (*JobListDescriptor) SetStatus 

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

SetStatus sets the Status field's value.

func (*JobListDescriptor) SetTerminationDate 

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

SetTerminationDate sets the TerminationDate field's value.

func (JobListDescriptor) String 

func (s JobListDescriptor) String() string

String returns the string representation

type JobManifest 

type JobManifest struct {

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

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

Contains the configuration information for a job's manifest.

func (JobManifest) GoString 

func (s JobManifest) GoString() string

GoString returns the string representation

func (*JobManifest) SetLocation 

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

SetLocation sets the Location field's value.

func (*JobManifest) SetSpec 

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

SetSpec sets the Spec field's value.

func (JobManifest) String 

func (s JobManifest) String() string

String returns the string representation

func (*JobManifest) Validate 

func (s *JobManifest) Validate() error

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

type JobManifestLocation 

type JobManifestLocation struct {

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

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

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

Contains the information required to locate a manifest object.

func (JobManifestLocation) GoString 

func (s JobManifestLocation) GoString() string

GoString returns the string representation

func (*JobManifestLocation) SetETag 

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

SetETag sets the ETag field's value.

func (*JobManifestLocation) SetObjectArn 

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

SetObjectArn sets the ObjectArn field's value.

func (*JobManifestLocation) SetObjectVersionId 

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

SetObjectVersionId sets the ObjectVersionId field's value.

func (JobManifestLocation) String 

func (s JobManifestLocation) String() string

String returns the string representation

func (*JobManifestLocation) Validate 

func (s *JobManifestLocation) Validate() error

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

type JobManifestSpec 

type JobManifestSpec struct {

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

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

Describes the format of a manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.

func (JobManifestSpec) GoString 

func (s JobManifestSpec) GoString() string

GoString returns the string representation

func (*JobManifestSpec) SetFields 

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

SetFields sets the Fields field's value.

func (*JobManifestSpec) SetFormat 

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

SetFormat sets the Format field's value.

func (JobManifestSpec) String 

func (s JobManifestSpec) String() string

String returns the string representation

func (*JobManifestSpec) Validate 

func (s *JobManifestSpec) Validate() error

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

type JobOperation 

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.

func (JobOperation) GoString 

func (s JobOperation) GoString() string

GoString returns the string representation

func (*JobOperation) SetLambdaInvoke 

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

SetLambdaInvoke sets the LambdaInvoke field's value.

func (*JobOperation) SetS3InitiateRestoreObject 

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

SetS3InitiateRestoreObject sets the S3InitiateRestoreObject field's value.

func (*JobOperation) SetS3PutObjectAcl 

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

SetS3PutObjectAcl sets the S3PutObjectAcl field's value.

func (*JobOperation) SetS3PutObjectCopy 

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

SetS3PutObjectCopy sets the S3PutObjectCopy field's value.

func (*JobOperation) SetS3PutObjectTagging 

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

SetS3PutObjectTagging sets the S3PutObjectTagging field's value.

func (JobOperation) String 

func (s JobOperation) String() string

String returns the string representation

func (*JobOperation) Validate 

func (s *JobOperation) Validate() error

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

type JobProgressSummary 

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.

func (JobProgressSummary) GoString 

func (s JobProgressSummary) GoString() string

GoString returns the string representation

func (*JobProgressSummary) SetNumberOfTasksFailed 

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

SetNumberOfTasksFailed sets the NumberOfTasksFailed field's value.

func (*JobProgressSummary) SetNumberOfTasksSucceeded 

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

SetNumberOfTasksSucceeded sets the NumberOfTasksSucceeded field's value.

func (*JobProgressSummary) SetTotalNumberOfTasks 

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

SetTotalNumberOfTasks sets the TotalNumberOfTasks field's value.

func (JobProgressSummary) String 

func (s JobProgressSummary) String() string

String returns the string representation

type JobReport 

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 *string `type:"string" enum:"JobReportFormat"`

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

Contains the configuration parameters for a job-completion report.

func (JobReport) GoString 

func (s JobReport) GoString() string

GoString returns the string representation

func (*JobReport) SetBucket 

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

SetBucket sets the Bucket field's value.

func (*JobReport) SetEnabled 

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

SetEnabled sets the Enabled field's value.

func (*JobReport) SetFormat 

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

SetFormat sets the Format field's value.

func (*JobReport) SetPrefix 

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

SetPrefix sets the Prefix field's value.

func (*JobReport) SetReportScope 

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

SetReportScope sets the ReportScope field's value.

func (JobReport) String 

func (s JobReport) String() string

String returns the string representation

func (*JobReport) Validate 

func (s *JobReport) Validate() error

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

type LambdaInvokeOperation 

type LambdaInvokeOperation struct {

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

Contains the configuration parameters for a Lambda Invoke operation.

func (LambdaInvokeOperation) GoString 

func (s LambdaInvokeOperation) GoString() string

GoString returns the string representation

func (*LambdaInvokeOperation) SetFunctionArn 

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

SetFunctionArn sets the FunctionArn field's value.

func (LambdaInvokeOperation) String 

func (s LambdaInvokeOperation) String() string

String returns the string representation

func (*LambdaInvokeOperation) Validate 

func (s *LambdaInvokeOperation) Validate() error

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

type ListJobsInput 

type ListJobsInput struct {

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

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

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

func (ListJobsInput) GoString 

func (s ListJobsInput) GoString() string

GoString returns the string representation

func (*ListJobsInput) SetAccountId 

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

SetAccountId sets the AccountId field's value.

func (*ListJobsInput) SetJobStatuses 

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

SetJobStatuses sets the JobStatuses field's value.

func (*ListJobsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListJobsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListJobsInput) String 

func (s ListJobsInput) String() string

String returns the string representation

func (*ListJobsInput) Validate 

func (s *ListJobsInput) Validate() error

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

type ListJobsOutput 

type ListJobsOutput struct {

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

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

func (ListJobsOutput) GoString 

func (s ListJobsOutput) GoString() string

GoString returns the string representation

func (*ListJobsOutput) SetJobs 

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

SetJobs sets the Jobs field's value.

func (*ListJobsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListJobsOutput) String 

func (s ListJobsOutput) String() string

String returns the string representation

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
}

func (PublicAccessBlockConfiguration) GoString 

func (s PublicAccessBlockConfiguration) GoString() string

GoString returns the string representation

func (*PublicAccessBlockConfiguration) SetBlockPublicAcls 

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

SetBlockPublicAcls sets the BlockPublicAcls field's value.

func (*PublicAccessBlockConfiguration) SetBlockPublicPolicy 

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

SetBlockPublicPolicy sets the BlockPublicPolicy field's value.

func (*PublicAccessBlockConfiguration) SetIgnorePublicAcls 

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

SetIgnorePublicAcls sets the IgnorePublicAcls field's value.

func (*PublicAccessBlockConfiguration) SetRestrictPublicBuckets 

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

SetRestrictPublicBuckets sets the RestrictPublicBuckets field's value.

func (PublicAccessBlockConfiguration) String 

func (s PublicAccessBlockConfiguration) String() string

String returns the string representation

type 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
}

func (PutPublicAccessBlockInput) GoString 

func (s PutPublicAccessBlockInput) GoString() string

GoString returns the string representation

func (*PutPublicAccessBlockInput) SetAccountId 

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

SetAccountId sets the AccountId field's value.

func (*PutPublicAccessBlockInput) SetPublicAccessBlockConfiguration 

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

SetPublicAccessBlockConfiguration sets the PublicAccessBlockConfiguration field's value.

func (PutPublicAccessBlockInput) String 

func (s PutPublicAccessBlockInput) String() string

String returns the string representation

func (*PutPublicAccessBlockInput) Validate 

func (s *PutPublicAccessBlockInput) Validate() error

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

type PutPublicAccessBlockOutput 

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

func (PutPublicAccessBlockOutput) GoString 

func (s PutPublicAccessBlockOutput) GoString() string

GoString returns the string representation

func (PutPublicAccessBlockOutput) String 

func (s PutPublicAccessBlockOutput) String() string

String returns the string representation

type S3AccessControlList 

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

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

func (S3AccessControlList) GoString 

func (s S3AccessControlList) GoString() string

GoString returns the string representation

func (*S3AccessControlList) SetGrants 

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

SetGrants sets the Grants field's value.

func (*S3AccessControlList) SetOwner 

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

SetOwner sets the Owner field's value.

func (S3AccessControlList) String 

func (s S3AccessControlList) String() string

String returns the string representation

func (*S3AccessControlList) Validate 

func (s *S3AccessControlList) Validate() error

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

type S3AccessControlPolicy 

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

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

func (S3AccessControlPolicy) GoString 

func (s S3AccessControlPolicy) GoString() string

GoString returns the string representation

func (*S3AccessControlPolicy) SetAccessControlList 

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

SetAccessControlList sets the AccessControlList field's value.

func (*S3AccessControlPolicy) SetCannedAccessControlList 

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

SetCannedAccessControlList sets the CannedAccessControlList field's value.

func (S3AccessControlPolicy) String 

func (s S3AccessControlPolicy) String() string

String returns the string representation

func (*S3AccessControlPolicy) Validate 

func (s *S3AccessControlPolicy) Validate() error

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

type S3Control 

type S3Control struct {
	*client.Client
}

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

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

func New 

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

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

Example: 

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

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

func (*S3Control) CreateJob 

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

CreateJob API operation for AWS S3 Control.

Creates an Amazon S3 batch operations job.

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

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

Returned Error Codes:

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeIdempotencyException "IdempotencyException"

  • ErrCodeInternalServiceException "InternalServiceException"

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

func (*S3Control) CreateJobRequest 

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

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

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

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

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

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

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

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

func (*S3Control) CreateJobWithContext 

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

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

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

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

func (*S3Control) DeletePublicAccessBlock 

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

DeletePublicAccessBlock API operation for AWS S3 Control.

Deletes the block public access configuration for the specified account.

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

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

func (*S3Control) DeletePublicAccessBlockRequest 

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

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

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

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

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

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

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

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

func (*S3Control) DeletePublicAccessBlockWithContext 

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

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

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

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

func (*S3Control) DescribeJob 

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

DescribeJob API operation for AWS S3 Control.

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

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

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

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeInternalServiceException "InternalServiceException"

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

func (*S3Control) DescribeJobRequest 

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

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

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

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

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

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

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

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

func (*S3Control) DescribeJobWithContext 

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

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

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

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

func (*S3Control) GetPublicAccessBlock 

func (c *S3Control) GetPublicAccessBlock(input *GetPublicAccessBlockInput) (*GetPublicAccessBlockOutput, error)

GetPublicAccessBlock API operation for AWS S3 Control.

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

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

Returned Error Codes:

  • ErrCodeNoSuchPublicAccessBlockConfiguration "NoSuchPublicAccessBlockConfiguration"

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

func (*S3Control) GetPublicAccessBlockRequest 

func (c *S3Control) GetPublicAccessBlockRequest(input *GetPublicAccessBlockInput) (req *request.Request, output *GetPublicAccessBlockOutput)

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

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

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

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

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

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

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

func (*S3Control) GetPublicAccessBlockWithContext 

func (c *S3Control) GetPublicAccessBlockWithContext(ctx aws.Context, input *GetPublicAccessBlockInput, opts ...request.Option) (*GetPublicAccessBlockOutput, error)

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

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

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

func (*S3Control) ListJobs 

func (c *S3Control) ListJobs(input *ListJobsInput) (*ListJobsOutput, error)

ListJobs 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.

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

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException"

  • ErrCodeInternalServiceException "InternalServiceException"

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException"

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

func (*S3Control) ListJobsPages 

func (c *S3Control) ListJobsPages(input *ListJobsInput, fn func(*ListJobsOutput, bool) bool) error

ListJobsPages iterates over the pages of a ListJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListJobs method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListJobs operation.
pageNum := 0
err := client.ListJobsPages(params,
    func(page *s3control.ListJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*S3Control) ListJobsPagesWithContext 

func (c *S3Control) ListJobsPagesWithContext(ctx aws.Context, input *ListJobsInput, fn func(*ListJobsOutput, bool) bool, opts ...request.Option) error

ListJobsPagesWithContext same as ListJobsPages except it takes a Context and allows setting request options on the pages.

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

func (*S3Control) ListJobsRequest 

func (c *S3Control) ListJobsRequest(input *ListJobsInput) (req *request.Request, output *ListJobsOutput)

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

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

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

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

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

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

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

func (*S3Control) ListJobsWithContext 

func (c *S3Control) ListJobsWithContext(ctx aws.Context, input *ListJobsInput, opts ...request.Option) (*ListJobsOutput, error)

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

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

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

func (*S3Control) PutPublicAccessBlock 

func (c *S3Control) PutPublicAccessBlock(input *PutPublicAccessBlockInput) (*PutPublicAccessBlockOutput, error)

PutPublicAccessBlock API operation for AWS S3 Control.

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

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

func (*S3Control) PutPublicAccessBlockRequest 

func (c *S3Control) PutPublicAccessBlockRequest(input *PutPublicAccessBlockInput) (req *request.Request, output *PutPublicAccessBlockOutput)

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

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

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

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

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

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

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

func (*S3Control) PutPublicAccessBlockWithContext 

func (c *S3Control) PutPublicAccessBlockWithContext(ctx aws.Context, input *PutPublicAccessBlockInput, opts ...request.Option) (*PutPublicAccessBlockOutput, error)

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

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

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

func (*S3Control) UpdateJobPriority 

func (c *S3Control) UpdateJobPriority(input *UpdateJobPriorityInput) (*UpdateJobPriorityOutput, error)

UpdateJobPriority API operation for AWS S3 Control.

Updates an existing job's priority.

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

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

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeInternalServiceException "InternalServiceException"

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

func (*S3Control) UpdateJobPriorityRequest 

func (c *S3Control) UpdateJobPriorityRequest(input *UpdateJobPriorityInput) (req *request.Request, output *UpdateJobPriorityOutput)

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

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

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

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

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

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

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

func (*S3Control) UpdateJobPriorityWithContext 

func (c *S3Control) UpdateJobPriorityWithContext(ctx aws.Context, input *UpdateJobPriorityInput, opts ...request.Option) (*UpdateJobPriorityOutput, error)

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

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

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

func (*S3Control) UpdateJobStatus 

func (c *S3Control) UpdateJobStatus(input *UpdateJobStatusInput) (*UpdateJobStatusOutput, error)

UpdateJobStatus API operation for AWS S3 Control.

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

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

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

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

  • ErrCodeNotFoundException "NotFoundException"

  • ErrCodeJobStatusException "JobStatusException"

  • ErrCodeInternalServiceException "InternalServiceException"

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

func (*S3Control) UpdateJobStatusRequest 

func (c *S3Control) UpdateJobStatusRequest(input *UpdateJobStatusInput) (req *request.Request, output *UpdateJobStatusOutput)

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

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

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

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

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

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

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

func (*S3Control) UpdateJobStatusWithContext 

func (c *S3Control) UpdateJobStatusWithContext(ctx aws.Context, input *UpdateJobStatusInput, opts ...request.Option) (*UpdateJobStatusOutput, error)

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

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

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

type S3CopyObjectOperation 

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

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

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

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

	NewObjectMetadata *S3ObjectMetadata `type:"structure"`

	NewObjectTagging []*S3Tag `type:"list"`

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

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

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

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

	RequesterPays *bool `type:"boolean"`

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

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

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

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

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

Contains the configuration parameters for a PUT Copy object operation. 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).

func (S3CopyObjectOperation) GoString 

func (s S3CopyObjectOperation) GoString() string

GoString returns the string representation

func (*S3CopyObjectOperation) SetAccessControlGrants 

func (s *S3CopyObjectOperation) SetAccessControlGrants(v []*S3Grant) *S3CopyObjectOperation

SetAccessControlGrants sets the AccessControlGrants field's value.

func (*S3CopyObjectOperation) SetCannedAccessControlList 

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

SetCannedAccessControlList sets the CannedAccessControlList field's value.

func (*S3CopyObjectOperation) SetMetadataDirective 

func (s *S3CopyObjectOperation) SetMetadataDirective(v string) *S3CopyObjectOperation

SetMetadataDirective sets the MetadataDirective field's value.

func (*S3CopyObjectOperation) SetModifiedSinceConstraint 

func (s *S3CopyObjectOperation) SetModifiedSinceConstraint(v time.Time) *S3CopyObjectOperation

SetModifiedSinceConstraint sets the ModifiedSinceConstraint field's value.

func (*S3CopyObjectOperation) SetNewObjectMetadata 

func (s *S3CopyObjectOperation) SetNewObjectMetadata(v *S3ObjectMetadata) *S3CopyObjectOperation

SetNewObjectMetadata sets the NewObjectMetadata field's value.

func (*S3CopyObjectOperation) SetNewObjectTagging 

func (s *S3CopyObjectOperation) SetNewObjectTagging(v []*S3Tag) *S3CopyObjectOperation

SetNewObjectTagging sets the NewObjectTagging field's value.

func (*S3CopyObjectOperation) SetObjectLockLegalHoldStatus 

func (s *S3CopyObjectOperation) SetObjectLockLegalHoldStatus(v string) *S3CopyObjectOperation

SetObjectLockLegalHoldStatus sets the ObjectLockLegalHoldStatus field's value.

func (*S3CopyObjectOperation) SetObjectLockMode 

func (s *S3CopyObjectOperation) SetObjectLockMode(v string) *S3CopyObjectOperation

SetObjectLockMode sets the ObjectLockMode field's value.

func (*S3CopyObjectOperation) SetObjectLockRetainUntilDate 

func (s *S3CopyObjectOperation) SetObjectLockRetainUntilDate(v time.Time) *S3CopyObjectOperation

SetObjectLockRetainUntilDate sets the ObjectLockRetainUntilDate field's value.

func (*S3CopyObjectOperation) SetRedirectLocation 

func (s *S3CopyObjectOperation) SetRedirectLocation(v string) *S3CopyObjectOperation

SetRedirectLocation sets the RedirectLocation field's value.

func (*S3CopyObjectOperation) SetRequesterPays 

func (s *S3CopyObjectOperation) SetRequesterPays(v bool) *S3CopyObjectOperation

SetRequesterPays sets the RequesterPays field's value.

func (*S3CopyObjectOperation) SetSSEAwsKmsKeyId 

func (s *S3CopyObjectOperation) SetSSEAwsKmsKeyId(v string) *S3CopyObjectOperation

SetSSEAwsKmsKeyId sets the SSEAwsKmsKeyId field's value.

func (*S3CopyObjectOperation) SetStorageClass 

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

SetStorageClass sets the StorageClass field's value.

func (*S3CopyObjectOperation) SetTargetKeyPrefix 

func (s *S3CopyObjectOperation) SetTargetKeyPrefix(v string) *S3CopyObjectOperation

SetTargetKeyPrefix sets the TargetKeyPrefix field's value.

func (*S3CopyObjectOperation) SetTargetResource 

func (s *S3CopyObjectOperation) SetTargetResource(v string) *S3CopyObjectOperation

SetTargetResource sets the TargetResource field's value.

func (*S3CopyObjectOperation) SetUnModifiedSinceConstraint 

func (s *S3CopyObjectOperation) SetUnModifiedSinceConstraint(v time.Time) *S3CopyObjectOperation

SetUnModifiedSinceConstraint sets the UnModifiedSinceConstraint field's value.

func (S3CopyObjectOperation) String 

func (s S3CopyObjectOperation) String() string

String returns the string representation

func (*S3CopyObjectOperation) Validate 

func (s *S3CopyObjectOperation) Validate() error

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

type S3Grant 

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

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

func (S3Grant) GoString 

func (s S3Grant) GoString() string

GoString returns the string representation

func (*S3Grant) SetGrantee 

func (s *S3Grant) SetGrantee(v *S3Grantee) *S3Grant

SetGrantee sets the Grantee field's value.

func (*S3Grant) SetPermission 

func (s *S3Grant) SetPermission(v string) *S3Grant

SetPermission sets the Permission field's value.

func (S3Grant) String 

func (s S3Grant) String() string

String returns the string representation

func (*S3Grant) Validate 

func (s *S3Grant) Validate() error

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

type S3Grantee 

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

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

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

func (S3Grantee) GoString 

func (s S3Grantee) GoString() string

GoString returns the string representation

func (*S3Grantee) SetDisplayName 

func (s *S3Grantee) SetDisplayName(v string) *S3Grantee

SetDisplayName sets the DisplayName field's value.

func (*S3Grantee) SetIdentifier 

func (s *S3Grantee) SetIdentifier(v string) *S3Grantee

SetIdentifier sets the Identifier field's value.

func (*S3Grantee) SetTypeIdentifier 

func (s *S3Grantee) SetTypeIdentifier(v string) *S3Grantee

SetTypeIdentifier sets the TypeIdentifier field's value.

func (S3Grantee) String 

func (s S3Grantee) String() string

String returns the string representation

func (*S3Grantee) Validate 

func (s *S3Grantee) Validate() error

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

type S3InitiateRestoreObjectOperation 

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

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

Contains the configuration parameters for an Initiate Glacier Restore job. 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).

func (S3InitiateRestoreObjectOperation) GoString 

func (s S3InitiateRestoreObjectOperation) GoString() string

GoString returns the string representation

func (*S3InitiateRestoreObjectOperation) SetExpirationInDays 

func (s *S3InitiateRestoreObjectOperation) SetExpirationInDays(v int64) *S3InitiateRestoreObjectOperation

SetExpirationInDays sets the ExpirationInDays field's value.

func (*S3InitiateRestoreObjectOperation) SetGlacierJobTier 

func (s *S3InitiateRestoreObjectOperation) SetGlacierJobTier(v string) *S3InitiateRestoreObjectOperation

SetGlacierJobTier sets the GlacierJobTier field's value.

func (S3InitiateRestoreObjectOperation) String 

func (s S3InitiateRestoreObjectOperation) String() string

String returns the string representation

type S3ObjectMetadata 

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

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

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

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

	ContentLength *int64 `type:"long"`

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

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

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

	RequesterCharged *bool `type:"boolean"`

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

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

func (S3ObjectMetadata) GoString 

func (s S3ObjectMetadata) GoString() string

GoString returns the string representation

func (*S3ObjectMetadata) SetCacheControl 

func (s *S3ObjectMetadata) SetCacheControl(v string) *S3ObjectMetadata

SetCacheControl sets the CacheControl field's value.

func (*S3ObjectMetadata) SetContentDisposition 

func (s *S3ObjectMetadata) SetContentDisposition(v string) *S3ObjectMetadata

SetContentDisposition sets the ContentDisposition field's value.

func (*S3ObjectMetadata) SetContentEncoding 

func (s *S3ObjectMetadata) SetContentEncoding(v string) *S3ObjectMetadata

SetContentEncoding sets the ContentEncoding field's value.

func (*S3ObjectMetadata) SetContentLanguage 

func (s *S3ObjectMetadata) SetContentLanguage(v string) *S3ObjectMetadata

SetContentLanguage sets the ContentLanguage field's value.

func (*S3ObjectMetadata) SetContentLength 

func (s *S3ObjectMetadata) SetContentLength(v int64) *S3ObjectMetadata

SetContentLength sets the ContentLength field's value.

func (*S3ObjectMetadata) SetContentMD5 

func (s *S3ObjectMetadata) SetContentMD5(v string) *S3ObjectMetadata

SetContentMD5 sets the ContentMD5 field's value.

func (*S3ObjectMetadata) SetContentType 

func (s *S3ObjectMetadata) SetContentType(v string) *S3ObjectMetadata

SetContentType sets the ContentType field's value.

func (*S3ObjectMetadata) SetHttpExpiresDate 

func (s *S3ObjectMetadata) SetHttpExpiresDate(v time.Time) *S3ObjectMetadata

SetHttpExpiresDate sets the HttpExpiresDate field's value.

func (*S3ObjectMetadata) SetRequesterCharged 

func (s *S3ObjectMetadata) SetRequesterCharged(v bool) *S3ObjectMetadata

SetRequesterCharged sets the RequesterCharged field's value.

func (*S3ObjectMetadata) SetSSEAlgorithm 

func (s *S3ObjectMetadata) SetSSEAlgorithm(v string) *S3ObjectMetadata

SetSSEAlgorithm sets the SSEAlgorithm field's value.

func (*S3ObjectMetadata) SetUserMetadata 

func (s *S3ObjectMetadata) SetUserMetadata(v map[string]*string) *S3ObjectMetadata

SetUserMetadata sets the UserMetadata field's value.

func (S3ObjectMetadata) String 

func (s S3ObjectMetadata) String() string

String returns the string representation

func (*S3ObjectMetadata) Validate 

func (s *S3ObjectMetadata) Validate() error

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

type S3ObjectOwner 

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

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

func (S3ObjectOwner) GoString 

func (s S3ObjectOwner) GoString() string

GoString returns the string representation

func (*S3ObjectOwner) SetDisplayName 

func (s *S3ObjectOwner) SetDisplayName(v string) *S3ObjectOwner

SetDisplayName sets the DisplayName field's value.

func (*S3ObjectOwner) SetID 

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

SetID sets the ID field's value.

func (S3ObjectOwner) String 

func (s S3ObjectOwner) String() string

String returns the string representation

func (*S3ObjectOwner) Validate 

func (s *S3ObjectOwner) Validate() error

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

type S3SetObjectAclOperation 

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).

func (S3SetObjectAclOperation) GoString 

func (s S3SetObjectAclOperation) GoString() string

GoString returns the string representation

func (*S3SetObjectAclOperation) SetAccessControlPolicy 

func (s *S3SetObjectAclOperation) SetAccessControlPolicy(v *S3AccessControlPolicy) *S3SetObjectAclOperation

SetAccessControlPolicy sets the AccessControlPolicy field's value.

func (S3SetObjectAclOperation) String 

func (s S3SetObjectAclOperation) String() string

String returns the string representation

func (*S3SetObjectAclOperation) Validate 

func (s *S3SetObjectAclOperation) Validate() error

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

type S3SetObjectTaggingOperation 

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).

func (S3SetObjectTaggingOperation) GoString 

func (s S3SetObjectTaggingOperation) GoString() string

GoString returns the string representation

func (*S3SetObjectTaggingOperation) SetTagSet 

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

SetTagSet sets the TagSet field's value.

func (S3SetObjectTaggingOperation) String 

func (s S3SetObjectTaggingOperation) String() string

String returns the string representation

func (*S3SetObjectTaggingOperation) Validate 

func (s *S3SetObjectTaggingOperation) Validate() error

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

type S3Tag 

type S3Tag struct {

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

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

func (S3Tag) GoString 

func (s S3Tag) GoString() string

GoString returns the string representation

func (*S3Tag) SetKey 

func (s *S3Tag) SetKey(v string) *S3Tag

SetKey sets the Key field's value.

func (*S3Tag) SetValue 

func (s *S3Tag) SetValue(v string) *S3Tag

SetValue sets the Value field's value.

func (S3Tag) String 

func (s S3Tag) String() string

String returns the string representation

func (*S3Tag) Validate 

func (s *S3Tag) Validate() error

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

type UpdateJobPriorityInput 

type UpdateJobPriorityInput struct {

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

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

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

func (UpdateJobPriorityInput) GoString 

func (s UpdateJobPriorityInput) GoString() string

GoString returns the string representation

func (*UpdateJobPriorityInput) SetAccountId 

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

SetAccountId sets the AccountId field's value.

func (*UpdateJobPriorityInput) SetJobId 

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

SetJobId sets the JobId field's value.

func (*UpdateJobPriorityInput) SetPriority 

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

SetPriority sets the Priority field's value.

func (UpdateJobPriorityInput) String 

func (s UpdateJobPriorityInput) String() string

String returns the string representation

func (*UpdateJobPriorityInput) Validate 

func (s *UpdateJobPriorityInput) Validate() error

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

type UpdateJobPriorityOutput 

type UpdateJobPriorityOutput struct {

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

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

func (UpdateJobPriorityOutput) GoString 

func (s UpdateJobPriorityOutput) GoString() string

GoString returns the string representation

func (*UpdateJobPriorityOutput) SetJobId 

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

SetJobId sets the JobId field's value.

func (*UpdateJobPriorityOutput) SetPriority 

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

SetPriority sets the Priority field's value.

func (UpdateJobPriorityOutput) String 

func (s UpdateJobPriorityOutput) String() string

String returns the string representation

type UpdateJobStatusInput 

type UpdateJobStatusInput struct {

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

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

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

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

func (UpdateJobStatusInput) GoString 

func (s UpdateJobStatusInput) GoString() string

GoString returns the string representation

func (*UpdateJobStatusInput) SetAccountId 

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

SetAccountId sets the AccountId field's value.

func (*UpdateJobStatusInput) SetJobId 

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

SetJobId sets the JobId field's value.

func (*UpdateJobStatusInput) SetRequestedJobStatus 

func (s *UpdateJobStatusInput) SetRequestedJobStatus(v string) *UpdateJobStatusInput

SetRequestedJobStatus sets the RequestedJobStatus field's value.

func (*UpdateJobStatusInput) SetStatusUpdateReason 

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

SetStatusUpdateReason sets the StatusUpdateReason field's value.

func (UpdateJobStatusInput) String 

func (s UpdateJobStatusInput) String() string

String returns the string representation

func (*UpdateJobStatusInput) Validate 

func (s *UpdateJobStatusInput) Validate() error

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

type UpdateJobStatusOutput 

type UpdateJobStatusOutput struct {

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

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

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

func (UpdateJobStatusOutput) GoString 

func (s UpdateJobStatusOutput) GoString() string

GoString returns the string representation

func (*UpdateJobStatusOutput) SetJobId 

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

SetJobId sets the JobId field's value.

func (*UpdateJobStatusOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (*UpdateJobStatusOutput) SetStatusUpdateReason 

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

SetStatusUpdateReason sets the StatusUpdateReason field's value.

func (UpdateJobStatusOutput) String 

func (s UpdateJobStatusOutput) String() string

String returns the string representation

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.