package types

import "github.com/aws/aws-sdk-go-v2/service/s3control/types"

Index

Types

type AbortIncompleteMultipartUpload

type AbortIncompleteMultipartUpload struct {

	// Specifies the number of days after which Amazon S3 aborts an incomplete
	// multipart upload to the Outposts bucket.
	DaysAfterInitiation *int32
}

The container for abort incomplete multipart upload

type AccessPoint

type AccessPoint struct {

	// The name of the bucket associated with this access point.
	//
	// This member is required.
	Bucket *string

	// The name of this access point.
	//
	// This member is required.
	Name *string

	// Indicates whether this access point allows access from the public internet. If
	// VpcConfiguration is specified for this access point, then NetworkOrigin is VPC,
	// and the access point doesn't allow access from the public internet. Otherwise,
	// NetworkOrigin is Internet, and the access point allows access from the public
	// internet, subject to the access point and bucket access policies.
	//
	// This member is required.
	NetworkOrigin NetworkOrigin

	// The ARN for the access point.
	AccessPointArn *string

	// The virtual private cloud (VPC) configuration for this access point, if one
	// exists.
	VpcConfiguration *VpcConfiguration
}

An access point used to access a bucket.

type BadRequestException

type BadRequestException struct {
	Message *string
}

func (*BadRequestException) Error

func (e *BadRequestException) Error() string

func (*BadRequestException) ErrorCode

func (e *BadRequestException) ErrorCode() string

func (*BadRequestException) ErrorFault

func (e *BadRequestException) ErrorFault() smithy.ErrorFault

func (*BadRequestException) ErrorMessage

func (e *BadRequestException) ErrorMessage() string

type BucketAlreadyExists

type BucketAlreadyExists struct {
	Message *string
}

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

func (*BucketAlreadyExists) Error

func (e *BucketAlreadyExists) Error() string

func (*BucketAlreadyExists) ErrorCode

func (e *BucketAlreadyExists) ErrorCode() string

func (*BucketAlreadyExists) ErrorFault

func (e *BucketAlreadyExists) ErrorFault() smithy.ErrorFault

func (*BucketAlreadyExists) ErrorMessage

func (e *BucketAlreadyExists) ErrorMessage() string

type BucketAlreadyOwnedByYou

type BucketAlreadyOwnedByYou struct {
	Message *string
}

The Outposts bucket you tried to create already exists, and you own it.

func (*BucketAlreadyOwnedByYou) Error

func (e *BucketAlreadyOwnedByYou) Error() string

func (*BucketAlreadyOwnedByYou) ErrorCode

func (e *BucketAlreadyOwnedByYou) ErrorCode() string

func (*BucketAlreadyOwnedByYou) ErrorFault

func (e *BucketAlreadyOwnedByYou) ErrorFault() smithy.ErrorFault

func (*BucketAlreadyOwnedByYou) ErrorMessage

func (e *BucketAlreadyOwnedByYou) ErrorMessage() string

type BucketCannedACL

type BucketCannedACL string
const (
	BucketCannedACLPrivate           BucketCannedACL = "private"
	BucketCannedACLPublicRead        BucketCannedACL = "public-read"
	BucketCannedACLPublicReadWrite   BucketCannedACL = "public-read-write"
	BucketCannedACLAuthenticatedRead BucketCannedACL = "authenticated-read"
)

Enum values for BucketCannedACL

type BucketLocationConstraint

type BucketLocationConstraint string
const (
	BucketLocationConstraintEu           BucketLocationConstraint = "EU"
	BucketLocationConstraintEuWest1      BucketLocationConstraint = "eu-west-1"
	BucketLocationConstraintUsWest1      BucketLocationConstraint = "us-west-1"
	BucketLocationConstraintUsWest2      BucketLocationConstraint = "us-west-2"
	BucketLocationConstraintApSouth1     BucketLocationConstraint = "ap-south-1"
	BucketLocationConstraintApSoutheast1 BucketLocationConstraint = "ap-southeast-1"
	BucketLocationConstraintApSoutheast2 BucketLocationConstraint = "ap-southeast-2"
	BucketLocationConstraintApNortheast1 BucketLocationConstraint = "ap-northeast-1"
	BucketLocationConstraintSaEast1      BucketLocationConstraint = "sa-east-1"
	BucketLocationConstraintCnNorth1     BucketLocationConstraint = "cn-north-1"
	BucketLocationConstraintEuCentral1   BucketLocationConstraint = "eu-central-1"
)

Enum values for BucketLocationConstraint

type CreateBucketConfiguration

type CreateBucketConfiguration struct {

	// Specifies the Region where the bucket will be created. If you are creating a
	// bucket on the US East (N. Virginia) Region (us-east-1), you do not need to
	// specify the location. This is not supported by Amazon S3 on Outposts buckets.
	LocationConstraint BucketLocationConstraint
}

The container for the bucket configuration. This is not supported by Amazon S3 on Outposts buckets.

type ExpirationStatus

type ExpirationStatus string
const (
	ExpirationStatusEnabled  ExpirationStatus = "Enabled"
	ExpirationStatusDisabled ExpirationStatus = "Disabled"
)

Enum values for ExpirationStatus

type IdempotencyException

type IdempotencyException struct {
	Message *string
}

func (*IdempotencyException) Error

func (e *IdempotencyException) Error() string

func (*IdempotencyException) ErrorCode

func (e *IdempotencyException) ErrorCode() string

func (*IdempotencyException) ErrorFault

func (e *IdempotencyException) ErrorFault() smithy.ErrorFault

func (*IdempotencyException) ErrorMessage

func (e *IdempotencyException) ErrorMessage() string

type InternalServiceException

type InternalServiceException struct {
	Message *string
}

func (*InternalServiceException) Error

func (e *InternalServiceException) Error() string

func (*InternalServiceException) ErrorCode

func (e *InternalServiceException) ErrorCode() string

func (*InternalServiceException) ErrorFault

func (e *InternalServiceException) ErrorFault() smithy.ErrorFault

func (*InternalServiceException) ErrorMessage

func (e *InternalServiceException) ErrorMessage() string

type InvalidNextTokenException

type InvalidNextTokenException struct {
	Message *string
}

func (*InvalidNextTokenException) Error

func (e *InvalidNextTokenException) Error() string

func (*InvalidNextTokenException) ErrorCode

func (e *InvalidNextTokenException) ErrorCode() string

func (*InvalidNextTokenException) ErrorFault

func (*InvalidNextTokenException) ErrorMessage

func (e *InvalidNextTokenException) ErrorMessage() string

type InvalidRequestException

type InvalidRequestException struct {
	Message *string
}

func (*InvalidRequestException) Error

func (e *InvalidRequestException) Error() string

func (*InvalidRequestException) ErrorCode

func (e *InvalidRequestException) ErrorCode() string

func (*InvalidRequestException) ErrorFault

func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault

func (*InvalidRequestException) ErrorMessage

func (e *InvalidRequestException) ErrorMessage() string

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

	// A timestamp indicating when this job was created.
	CreationTime *time.Time

	// The description for this job, if one was provided in this job's Create Job
	// request.
	Description *string

	// If the specified job failed, this field contains information describing the
	// failure.
	FailureReasons []*JobFailure

	// The Amazon Resource Name (ARN) for this job.
	JobArn *string

	// The ID for the specified job.
	JobId *string

	// The configuration information for the specified job's manifest object.
	Manifest *JobManifest

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

	// The priority of the specified job.
	Priority *int32

	// Describes the total number of tasks that the specified job has run, the number
	// of tasks that succeeded, and the number of tasks that failed.
	ProgressSummary *JobProgressSummary

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

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

	// The current status of the specified job.
	Status JobStatus

	// The reason for updating the job.
	StatusUpdateReason *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

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

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

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

type JobFailure

type JobFailure struct {

	// The failure code, if any, for the specified job.
	FailureCode *string

	// The failure reason, if any, for the specified job.
	FailureReason *string
}

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

type JobListDescriptor

type JobListDescriptor struct {

	// A timestamp indicating when the specified job was created.
	CreationTime *time.Time

	// The user-specified description that was included in the specified job's Create
	// Job request.
	Description *string

	// The ID for the specified job.
	JobId *string

	// The operation that the specified job is configured to run on each object listed
	// in the manifest.
	Operation OperationName

	// The current priority for the specified job.
	Priority *int32

	// Describes the total number of tasks that the specified job has run, the number
	// of tasks that succeeded, and the number of tasks that failed.
	ProgressSummary *JobProgressSummary

	// The specified job's current status.
	Status 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
}

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

type JobManifest

type JobManifest struct {

	// Contains the information required to locate the specified job's manifest.
	//
	// This member is required.
	Location *JobManifestLocation

	// Describes the format of the specified job's manifest. If the manifest is in CSV
	// format, also describes the columns contained within the manifest.
	//
	// This member is required.
	Spec *JobManifestSpec
}

Contains the configuration information for a job's manifest.

type JobManifestFieldName

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

Enum values for JobManifestFieldName

type JobManifestFormat

type JobManifestFormat string
const (
	JobManifestFormatS3batchoperations_csv_20180820 JobManifestFormat = "S3BatchOperations_CSV_20180820"
	JobManifestFormatS3inventoryreport_csv_20161130 JobManifestFormat = "S3InventoryReport_CSV_20161130"
)

Enum values for JobManifestFormat

type JobManifestLocation

type JobManifestLocation struct {

	// The ETag for the specified manifest object.
	//
	// This member is required.
	ETag *string

	// The Amazon Resource Name (ARN) for a manifest object.
	//
	// This member is required.
	ObjectArn *string

	// The optional version ID to identify a specific version of the manifest object.
	ObjectVersionId *string
}

Contains the information required to locate a manifest object.

type JobManifestSpec

type JobManifestSpec struct {

	// Indicates which of the available formats the specified manifest uses.
	//
	// This member is required.
	Format JobManifestFormat

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

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

type JobOperation

type JobOperation struct {

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

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

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

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

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

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

	// Directs the specified job to run a PUT Object tagging call on each object in the
	// manifest.
	S3PutObjectTagging *S3SetObjectTaggingOperation
}

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

type JobProgressSummary

type JobProgressSummary struct {

	//
	NumberOfTasksFailed *int64

	//
	NumberOfTasksSucceeded *int64

	//
	TotalNumberOfTasks *int64
}

Describes the total number of tasks that the specified job has started, the number of tasks that succeeded, and the number of tasks that failed.

type JobReport

type JobReport struct {

	// Indicates whether the specified job will generate a job-completion report.
	//
	// This member is required.
	Enabled *bool

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

	// The format of the specified job-completion report.
	Format JobReportFormat

	// An optional prefix to describe where in the specified bucket the job-completion
	// report will be stored. Amazon S3 stores the job-completion report at
	// /job-/report.json.
	Prefix *string

	// Indicates whether the job-completion report will include details of all tasks or
	// only failed tasks.
	ReportScope JobReportScope
}

Contains the configuration parameters for a job-completion report.

type JobReportFormat

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

Enum values for JobReportFormat

type JobReportScope

type JobReportScope string
const (
	JobReportScopeAlltasks        JobReportScope = "AllTasks"
	JobReportScopeFailedtasksonly JobReportScope = "FailedTasksOnly"
)

Enum values for JobReportScope

type JobStatus

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

type JobStatusException

type JobStatusException struct {
	Message *string
}

func (*JobStatusException) Error

func (e *JobStatusException) Error() string

func (*JobStatusException) ErrorCode

func (e *JobStatusException) ErrorCode() string

func (*JobStatusException) ErrorFault

func (e *JobStatusException) ErrorFault() smithy.ErrorFault

func (*JobStatusException) ErrorMessage

func (e *JobStatusException) ErrorMessage() string

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
}

Contains the configuration parameters for a Lambda Invoke operation.

type LifecycleConfiguration

type LifecycleConfiguration struct {

	// A lifecycle rule for individual objects in an Outposts bucket.
	Rules []*LifecycleRule
}

The container for the Outposts bucket lifecycle configuration.

type LifecycleExpiration

type LifecycleExpiration struct {

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

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

	// Indicates whether Amazon S3 will remove a delete marker with no noncurrent
	// versions. If set to true, the delete marker will be expired. If set to false,
	// the policy takes no action. This cannot be specified with Days or Date in a
	// Lifecycle Expiration Policy.
	ExpiredObjectDeleteMarker *bool
}

The container of the Outposts bucket lifecycle expiration.

type LifecycleRule

type LifecycleRule struct {

	// If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is
	// not currently being applied.
	//
	// This member is required.
	Status ExpirationStatus

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

	// Specifies the expiration for the lifecycle of the object in the form of date,
	// days and, whether the object has a delete marker.
	Expiration *LifecycleExpiration

	// The container for the filter of lifecycle rule.
	Filter *LifecycleRuleFilter

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

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

	// Specifies the transition rule for the lifecycle rule that describes when
	// noncurrent objects transition to a specific storage class. If your bucket is
	// versioning-enabled (or versioning is suspended), you can set this action to
	// request that Amazon S3 transition noncurrent object versions to a specific
	// storage class at a set period in the object's lifetime. This is not supported by
	// Amazon S3 on Outposts buckets.
	NoncurrentVersionTransitions []*NoncurrentVersionTransition

	// Specifies when an Amazon S3 object transitions to a specified storage class.
	// This is not supported by Amazon S3 on Outposts buckets.
	Transitions []*Transition
}

The container for the Outposts bucket lifecycle rule.

type LifecycleRuleAndOperator

type LifecycleRuleAndOperator struct {

	// Prefix identifying one or more objects to which the rule applies.
	Prefix *string

	// All of these tags must exist in the object's tag set in order for the rule to
	// apply.
	Tags []*S3Tag
}

The container for the Outposts bucket lifecycle rule and operator.

type LifecycleRuleFilter

type LifecycleRuleFilter struct {

	// The container for the AND condition for the lifecycle rule.
	And *LifecycleRuleAndOperator

	// Prefix identifying one or more objects to which the rule applies.
	Prefix *string

	//
	Tag *S3Tag
}

The container for the filter of the lifecycle rule.

type NetworkOrigin

type NetworkOrigin string
const (
	NetworkOriginInternet NetworkOrigin = "Internet"
	NetworkOriginVpc      NetworkOrigin = "VPC"
)

Enum values for NetworkOrigin

type NoSuchPublicAccessBlockConfiguration

type NoSuchPublicAccessBlockConfiguration struct {
	Message *string
}

Amazon S3 throws this exception if you make a GetPublicAccessBlock request against an account that doesn't have a PublicAccessBlockConfiguration set.

func (*NoSuchPublicAccessBlockConfiguration) Error

func (*NoSuchPublicAccessBlockConfiguration) ErrorCode

func (*NoSuchPublicAccessBlockConfiguration) ErrorFault

func (*NoSuchPublicAccessBlockConfiguration) ErrorMessage

func (e *NoSuchPublicAccessBlockConfiguration) ErrorMessage() string

type NoncurrentVersionExpiration

type NoncurrentVersionExpiration struct {

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

The container of the noncurrent version expiration.

type NoncurrentVersionTransition

type NoncurrentVersionTransition struct {

	// Specifies the number of days an object is noncurrent before Amazon S3 can
	// perform the associated action. For information about the noncurrent days
	// calculations, see  How Amazon S3 Calculates How Long an Object Has Been
	// Noncurrent
	// (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations)
	// in the Amazon Simple Storage Service Developer Guide.
	NoncurrentDays *int32

	// The class of storage used to store the object.
	StorageClass TransitionStorageClass
}

The container for the noncurrent version transition.

type NotFoundException

type NotFoundException struct {
	Message *string
}

func (*NotFoundException) Error

func (e *NotFoundException) Error() string

func (*NotFoundException) ErrorCode

func (e *NotFoundException) ErrorCode() string

func (*NotFoundException) ErrorFault

func (e *NotFoundException) ErrorFault() smithy.ErrorFault

func (*NotFoundException) ErrorMessage

func (e *NotFoundException) ErrorMessage() string

type OperationName

type OperationName string
const (
	OperationNameLambdainvoke            OperationName = "LambdaInvoke"
	OperationNameS3putobjectcopy         OperationName = "S3PutObjectCopy"
	OperationNameS3putobjectacl          OperationName = "S3PutObjectAcl"
	OperationNameS3putobjecttagging      OperationName = "S3PutObjectTagging"
	OperationNameS3initiaterestoreobject OperationName = "S3InitiateRestoreObject"
	OperationNameS3putobjectlegalhold    OperationName = "S3PutObjectLegalHold"
	OperationNameS3putobjectretention    OperationName = "S3PutObjectRetention"
)

Enum values for OperationName

type PolicyStatus

type PolicyStatus struct {

	//
	IsPublic *bool
}

Indicates whether this access point policy is public. For more information about how Amazon S3 evaluates policies to determine whether they are public, see The Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) in the Amazon Simple Storage Service Developer Guide.

type PublicAccessBlockConfiguration

type PublicAccessBlockConfiguration struct {

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

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

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

	// Specifies whether Amazon S3 should restrict public bucket policies for buckets
	// in this account. Setting this element to TRUE restricts access to buckets with
	// public policies to only AWS services and authorized users within this account.
	// Enabling this setting doesn't affect previously stored bucket policies, except
	// that public and cross-account access within any public bucket policy, including
	// non-public delegation to specific accounts, is blocked. This is not supported
	// for Amazon S3 on Outposts.
	RestrictPublicBuckets *bool
}

The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) in the Amazon Simple Storage Service Developer Guide. This is not supported for Amazon S3 on Outposts.

type RegionalBucket

type RegionalBucket struct {

	//
	//
	// This member is required.
	Bucket *string

	// The creation date of the regional bucket
	//
	// This member is required.
	CreationDate *time.Time

	//
	//
	// This member is required.
	PublicAccessBlockEnabled *bool

	// The Amazon Resource Name (ARN) for the regional bucket.
	BucketArn *string

	// The AWS Outposts ID of the regional bucket.
	OutpostId *string
}

The container for the regional bucket.

type RequestedJobStatus

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

Enum values for RequestedJobStatus

type S3AccessControlList

type S3AccessControlList struct {

	//
	//
	// This member is required.
	Owner *S3ObjectOwner

	//
	Grants []*S3Grant
}

type S3AccessControlPolicy

type S3AccessControlPolicy struct {

	//
	AccessControlList *S3AccessControlList

	//
	CannedAccessControlList S3CannedAccessControlList
}

type S3CannedAccessControlList

type S3CannedAccessControlList string
const (
	S3CannedAccessControlListPrivate                   S3CannedAccessControlList = "private"
	S3CannedAccessControlListPublic_read               S3CannedAccessControlList = "public-read"
	S3CannedAccessControlListPublic_read_write         S3CannedAccessControlList = "public-read-write"
	S3CannedAccessControlListAws_exec_read             S3CannedAccessControlList = "aws-exec-read"
	S3CannedAccessControlListAuthenticated_read        S3CannedAccessControlList = "authenticated-read"
	S3CannedAccessControlListBucket_owner_read         S3CannedAccessControlList = "bucket-owner-read"
	S3CannedAccessControlListBucket_owner_full_control S3CannedAccessControlList = "bucket-owner-full-control"
)

Enum values for S3CannedAccessControlList

type S3CopyObjectOperation

type S3CopyObjectOperation struct {

	//
	AccessControlGrants []*S3Grant

	//
	CannedAccessControlList S3CannedAccessControlList

	//
	MetadataDirective S3MetadataDirective

	//
	ModifiedSinceConstraint *time.Time

	//
	NewObjectMetadata *S3ObjectMetadata

	//
	NewObjectTagging []*S3Tag

	// The legal hold status to be applied to all objects in the Batch Operations job.
	ObjectLockLegalHoldStatus S3ObjectLockLegalHoldStatus

	// The retention mode to be applied to all objects in the Batch Operations job.
	ObjectLockMode S3ObjectLockMode

	// The date when the applied object retention configuration expires on all objects
	// in the Batch Operations job.
	ObjectLockRetainUntilDate *time.Time

	//
	RedirectLocation *string

	//
	RequesterPays *bool

	//
	SSEAwsKmsKeyId *string

	//
	StorageClass S3StorageClass

	//
	TargetKeyPrefix *string

	//
	TargetResource *string

	//
	UnModifiedSinceConstraint *time.Time
}

Contains the configuration parameters for a PUT Copy object operation. S3 Batch Operations passes each value through to the underlying PUT Copy object API. For more information about the parameters for this operation, see PUT Object - Copy (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectCOPY.html).

type S3GlacierJobTier

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

Enum values for S3GlacierJobTier

type S3Grant

type S3Grant struct {

	//
	Grantee *S3Grantee

	//
	Permission S3Permission
}

type S3Grantee

type S3Grantee struct {

	//
	DisplayName *string

	//
	Identifier *string

	//
	TypeIdentifier S3GranteeTypeIdentifier
}

type S3GranteeTypeIdentifier

type S3GranteeTypeIdentifier string
const (
	S3GranteeTypeIdentifierCanonical     S3GranteeTypeIdentifier = "id"
	S3GranteeTypeIdentifierEmail_address S3GranteeTypeIdentifier = "emailAddress"
	S3GranteeTypeIdentifierGroup         S3GranteeTypeIdentifier = "uri"
)

Enum values for S3GranteeTypeIdentifier

type S3InitiateRestoreObjectOperation

type S3InitiateRestoreObjectOperation struct {

	//
	ExpirationInDays *int32

	//
	GlacierJobTier S3GlacierJobTier
}

Contains the configuration parameters for an Initiate Glacier Restore job. S3 Batch Operations passes each value through to the underlying POST Object restore API. For more information about the parameters for this operation, see RestoreObject (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOSTrestore.html#RESTObjectPOSTrestore-restore-request).

type S3MetadataDirective

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

Enum values for S3MetadataDirective

type S3ObjectLockLegalHold

type S3ObjectLockLegalHold struct {

	// The Object Lock legal hold status to be applied to all objects in the Batch
	// Operations job.
	//
	// This member is required.
	Status S3ObjectLockLegalHoldStatus
}

Whether S3 Object Lock legal hold will be applied to objects in an S3 Batch Operations job.

type S3ObjectLockLegalHoldStatus

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

Enum values for S3ObjectLockLegalHoldStatus

type S3ObjectLockMode

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

Enum values for S3ObjectLockMode

type S3ObjectLockRetentionMode

type S3ObjectLockRetentionMode string
const (
	S3ObjectLockRetentionModeCompliance S3ObjectLockRetentionMode = "COMPLIANCE"
	S3ObjectLockRetentionModeGovernance S3ObjectLockRetentionMode = "GOVERNANCE"
)

Enum values for S3ObjectLockRetentionMode

type S3ObjectMetadata

type S3ObjectMetadata struct {

	//
	CacheControl *string

	//
	ContentDisposition *string

	//
	ContentEncoding *string

	//
	ContentLanguage *string

	//
	ContentLength *int64

	//
	ContentMD5 *string

	//
	ContentType *string

	//
	HttpExpiresDate *time.Time

	//
	RequesterCharged *bool

	//
	SSEAlgorithm S3SSEAlgorithm

	//
	UserMetadata map[string]*string
}

type S3ObjectOwner

type S3ObjectOwner struct {

	//
	DisplayName *string

	//
	ID *string
}

type S3Permission

type S3Permission string
const (
	S3PermissionFull_control S3Permission = "FULL_CONTROL"
	S3PermissionRead         S3Permission = "READ"
	S3PermissionWrite        S3Permission = "WRITE"
	S3PermissionRead_acp     S3Permission = "READ_ACP"
	S3PermissionWrite_acp    S3Permission = "WRITE_ACP"
)

Enum values for S3Permission

type S3Retention

type S3Retention struct {

	// The Object Lock retention mode to be applied to all objects in the Batch
	// Operations job.
	Mode S3ObjectLockRetentionMode

	// The date when the applied Object Lock retention will expire on all objects set
	// by the Batch Operations job.
	RetainUntilDate *time.Time
}

Contains the S3 Object Lock retention mode to be applied to all objects in the S3 Batch Operations job. If you don't provide Mode and RetainUntilDate data types in your operation, you will remove the retention from your objects. For more information, see Using S3 Object Lock retention with S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html) in the Amazon Simple Storage Service Developer Guide.

type S3SSEAlgorithm

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

Enum values for S3SSEAlgorithm

type S3SetObjectAclOperation

type S3SetObjectAclOperation struct {

	//
	AccessControlPolicy *S3AccessControlPolicy
}

Contains the configuration parameters for a Set Object ACL operation. S3 Batch Operations passes each value through to the underlying PUT Object acl API. For more information about the parameters for this operation, see PUT Object acl (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUTacl.html).

type S3SetObjectLegalHoldOperation

type S3SetObjectLegalHoldOperation struct {

	// Contains the Object Lock legal hold status to be applied to all objects in the
	// Batch Operations job.
	//
	// This member is required.
	LegalHold *S3ObjectLockLegalHold
}

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

type S3SetObjectRetentionOperation

type S3SetObjectRetentionOperation struct {

	// Contains the Object Lock retention mode to be applied to all objects in the
	// Batch Operations job. For more information, see Using S3 Object Lock retention
	// with S3 Batch Operations
	// (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html)
	// in the Amazon Simple Storage Service Developer Guide.
	//
	// This member is required.
	Retention *S3Retention

	// Indicates if the action should be applied to objects in the Batch Operations job
	// even if they have Object Lock  GOVERNANCE type in place.
	BypassGovernanceRetention *bool
}

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

type S3SetObjectTaggingOperation

type S3SetObjectTaggingOperation struct {

	//
	TagSet []*S3Tag
}

Contains the configuration parameters for a Set Object Tagging operation. S3 Batch Operations passes each value through to the underlying PUT Object tagging API. For more information about the parameters for this operation, see PUT Object tagging (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUTtagging.html).

type S3StorageClass

type S3StorageClass string
const (
	S3StorageClassStandard            S3StorageClass = "STANDARD"
	S3StorageClassStandard_ia         S3StorageClass = "STANDARD_IA"
	S3StorageClassOnezone_ia          S3StorageClass = "ONEZONE_IA"
	S3StorageClassGlacier             S3StorageClass = "GLACIER"
	S3StorageClassIntelligent_tiering S3StorageClass = "INTELLIGENT_TIERING"
	S3StorageClassDeep_archive        S3StorageClass = "DEEP_ARCHIVE"
)

Enum values for S3StorageClass

type S3Tag

type S3Tag struct {

	//
	//
	// This member is required.
	Key *string

	//
	//
	// This member is required.
	Value *string
}

type Tagging

type Tagging struct {

	// A collection for a set of tags.
	//
	// This member is required.
	TagSet []*S3Tag
}

type TooManyRequestsException

type TooManyRequestsException struct {
	Message *string
}

func (*TooManyRequestsException) Error

func (e *TooManyRequestsException) Error() string

func (*TooManyRequestsException) ErrorCode

func (e *TooManyRequestsException) ErrorCode() string

func (*TooManyRequestsException) ErrorFault

func (e *TooManyRequestsException) ErrorFault() smithy.ErrorFault

func (*TooManyRequestsException) ErrorMessage

func (e *TooManyRequestsException) ErrorMessage() string

type TooManyTagsException

type TooManyTagsException struct {
	Message *string
}

Amazon S3 throws this exception if you have too many tags in your tag set.

func (*TooManyTagsException) Error

func (e *TooManyTagsException) Error() string

func (*TooManyTagsException) ErrorCode

func (e *TooManyTagsException) ErrorCode() string

func (*TooManyTagsException) ErrorFault

func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault

func (*TooManyTagsException) ErrorMessage

func (e *TooManyTagsException) ErrorMessage() string

type Transition

type Transition struct {

	// Indicates when objects are transitioned to the specified storage class. The date
	// value must be in ISO 8601 format. The time is always midnight UTC.
	Date *time.Time

	// Indicates the number of days after creation when objects are transitioned to the
	// specified storage class. The value must be a positive integer.
	Days *int32

	// The storage class to which you want the object to transition.
	StorageClass TransitionStorageClass
}

Specifies when an object transitions to a specified storage class. For more information about Amazon S3 Lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle (https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html) in the Amazon Simple Storage Service Developer Guide.

type TransitionStorageClass

type TransitionStorageClass string
const (
	TransitionStorageClassGlacier             TransitionStorageClass = "GLACIER"
	TransitionStorageClassStandard_ia         TransitionStorageClass = "STANDARD_IA"
	TransitionStorageClassOnezone_ia          TransitionStorageClass = "ONEZONE_IA"
	TransitionStorageClassIntelligent_tiering TransitionStorageClass = "INTELLIGENT_TIERING"
	TransitionStorageClassDeep_archive        TransitionStorageClass = "DEEP_ARCHIVE"
)

Enum values for TransitionStorageClass

type VpcConfiguration

type VpcConfiguration struct {

	// If this field is specified, this access point will only allow connections from
	// the specified VPC ID.
	//
	// This member is required.
	VpcId *string
}

The virtual private cloud (VPC) configuration for an access point.

Source Files

enums.go errors.go types.go

Version
v0.28.0
Published
Oct 26, 2020
Platform
js/wasm
Imports
3 packages
Last checked
6 hours ago

Tools for package owners.