snowball

type CancelClusterInput struct {
	// The 39-character ID for the cluster that you want to cancel, for example
	// CID123e4567-e89b-12d3-a456-426655440000.
	ClusterId *string
}

type CancelClusterOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CancelJobInput struct {
	// The 39-character job ID for the job that you want to cancel, for example
	// JID123e4567-e89b-12d3-a456-426655440000.
	JobId *string
}

type CancelJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type CreateAddressInput struct {
	// The address that you want the Snowball shipped to.
	Address *types.Address
}

type CreateAddressOutput struct {
	// The automatically generated ID for a specific address. You'll use this ID when
	// you create a job to specify which address you want the Snowball for that job
	// shipped to.
	AddressId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateClusterInput struct {
	// The ID for the address that you want the cluster shipped to.
	AddressId *string
	// An optional description of this specific cluster, for example Environmental Data
	// Cluster-01.
	Description *string
	// The RoleARN that you want to associate with this cluster. RoleArn values are
	// created by using the CreateRole
	// (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) API
	// action in AWS Identity and Access Management (IAM).
	RoleARN *string
	// The tax documents required in your AWS Region.
	TaxDocuments *types.TaxDocuments
	// The forwarding address ID for a cluster. This field is not supported in most
	// regions.
	ForwardingAddressId *string
	// The shipping speed for each node in this cluster. This speed doesn't dictate how
	// soon you'll get each Snowball Edge device, rather it represents how quickly each
	// device moves to its destination while in transit. Regional shipping speeds are
	// as follows:
	//
	//     * In Australia, you have access to express shipping. Typically,
	// Snowballs shipped express are delivered in about a day.
	//
	//     * In the European
	// Union (EU), you have access to express shipping. Typically, Snowballs shipped
	// express are delivered in about a day. In addition, most countries in the EU have
	// access to standard shipping, which typically takes less than a week, one way.
	//
	//
	// * In India, Snowballs are delivered in one to seven days.
	//
	//     * In the United
	// States of America (US), you have access to one-day shipping and two-day
	// shipping.
	//
	//     <ul> <li> <p>In Australia, you have access to express shipping.
	// Typically, devices shipped express are delivered in about a day.</p> </li> <li>
	// <p>In the European Union (EU), you have access to express shipping. Typically,
	// Snowball Edges shipped express are delivered in about a day. In addition, most
	// countries in the EU have access to standard shipping, which typically takes less
	// than a week, one way.</p> </li> <li> <p>In India, Snowball Edges are delivered
	// in one to seven days.</p> </li> <li> <p>In the US, you have access to one-day
	// shipping and two-day shipping.</p> </li> </ul>
	ShippingOption types.ShippingOption
	// The type of AWS Snowball device to use for this cluster. </p> <note> <p>For
	// cluster jobs, AWS Snowball currently supports only the <code>EDGE</code> device
	// type.</p> </note>
	SnowballType types.SnowballType
	// The Amazon Simple Notification Service (Amazon SNS) notification settings for
	// this cluster.
	Notification *types.Notification
	// The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN
	// values are created by using the CreateKey
	// (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) API
	// action in AWS Key Management Service (AWS KMS).
	KmsKeyARN *string
	// The type of job for this cluster. Currently, the only job type supported for
	// clusters is LOCAL_USE.
	JobType types.JobType
	// The resources associated with the cluster job. These resources include Amazon S3
	// buckets and optional AWS Lambda functions written in the Python language.
	Resources *types.JobResource
}

type CreateClusterOutput struct {
	// The automatically generated ID for a cluster.
	ClusterId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateJobInput struct {
	// The shipping speed for this job. This speed doesn't dictate how soon you'll get
	// the Snowball, rather it represents how quickly the Snowball moves to its
	// destination while in transit. Regional shipping speeds are as follows:  <ul>
	// <li> <p>In Australia, you have access to express shipping. Typically, Snowballs
	// shipped express are delivered in about a day.</p> </li> <li> <p>In the European
	// Union (EU), you have access to express shipping. Typically, Snowballs shipped
	// express are delivered in about a day. In addition, most countries in the EU have
	// access to standard shipping, which typically takes less than a week, one
	// way.</p> </li> <li> <p>In India, Snowballs are delivered in one to seven
	// days.</p> </li> <li> <p>In the US, you have access to one-day shipping and
	// two-day shipping.</p> </li> </ul>
	ShippingOption types.ShippingOption
	// The forwarding address ID for a job. This field is not supported in most
	// regions.
	ForwardingAddressId *string
	// If your job is being created in one of the US regions, you have the option of
	// specifying what size Snowball you'd like for this job. In all other regions,
	// Snowballs come with 80 TB in storage capacity.
	SnowballCapacityPreference types.SnowballCapacity
	// The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created
	// using the CreateKey
	// (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) AWS Key
	// Management Service (KMS) API action.
	KmsKeyARN *string
	// Defines the type of job that you're creating.
	JobType types.JobType
	// The RoleARN that you want to associate with this job. RoleArns are created using
	// the CreateRole
	// (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) AWS
	// Identity and Access Management (IAM) API action.
	RoleARN *string
	// Defines the Amazon Simple Notification Service (Amazon SNS) notification
	// settings for this job.
	Notification *types.Notification
	// The tax documents required in your AWS Region.
	TaxDocuments *types.TaxDocuments
	// Defines the device configuration for an AWS Snowcone job.
	DeviceConfiguration *types.DeviceConfiguration
	// The type of AWS Snowball device to use for this job. For cluster jobs, AWS
	// Snowball currently supports only the EDGE device type. The type of AWS Snowball
	// device to use for this job. Currently, the only supported device type for
	// cluster jobs is EDGE. For more information, see Snowball Edge Device Options
	// (https://docs.aws.amazon.com/snowball/latest/developer-guide/device-differences.html)
	// in the Snowball Edge Developer Guide.
	SnowballType types.SnowballType
	// Defines an optional description of this specific job, for example Important
	// Photos 2016-08-11.
	Description *string
	// Defines the Amazon S3 buckets associated with this job.  <p>With
	// <code>IMPORT</code> jobs, you specify the bucket or buckets that your
	// transferred data will be imported into.</p> <p>With <code>EXPORT</code> jobs,
	// you specify the bucket or buckets that your transferred data will be exported
	// from. Optionally, you can also specify a <code>KeyRange</code> value. If you
	// choose to export a range, you define the length of the range by providing either
	// an inclusive <code>BeginMarker</code> value, an inclusive <code>EndMarker</code>
	// value, or both. Ranges are UTF-8 binary sorted.</p>
	Resources *types.JobResource
	// The ID of a cluster. If you're creating a job for a node in a cluster, you need
	// to provide only this clusterId value. The other job attributes are inherited
	// from the cluster.
	ClusterId *string
	// The ID for the address that you want the Snowball shipped to.
	AddressId *string
}

type CreateJobOutput struct {
	// The automatically generated ID for a job, for example
	// JID123e4567-e89b-12d3-a456-426655440000.
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeAddressInput struct {
	// The automatically generated ID for a specific address.
	AddressId *string
}

type DescribeAddressOutput struct {
	// The address that you want the Snowball or Snowballs associated with a specific
	// job to be shipped to.
	Address *types.Address

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeAddressesInput struct {
	// HTTP requests are stateless. To identify what object comes "next" in the list of
	// ADDRESS objects, you have the option of specifying a value for NextToken as the
	// starting point for your list of returned addresses.
	NextToken *string
	// The number of ADDRESS objects to return.
	MaxResults *int32
}

type DescribeAddressesOutput struct {
	// The Snowball shipping addresses that were created for this account.
	Addresses []*types.Address
	// HTTP requests are stateless. If you use the automatically generated NextToken
	// value in your next DescribeAddresses call, your list of returned addresses will
	// start from this point in the array.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeClusterInput struct {
	// The automatically generated ID for a cluster.
	ClusterId *string
}

type DescribeClusterOutput struct {
	// Information about a specific cluster, including shipping information, cluster
	// status, and other important metadata.
	ClusterMetadata *types.ClusterMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeJobInput struct {
	// The automatically generated ID for a job, for example
	// JID123e4567-e89b-12d3-a456-426655440000.
	JobId *string
}

type DescribeJobOutput struct {
	// Information about a specific job, including shipping information, job status,
	// and other important metadata.
	JobMetadata *types.JobMetadata
	// Information about a specific job part (in the case of an export job), including
	// shipping information, job status, and other important metadata.
	SubJobMetadata []*types.JobMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver interface {
	ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error)
}

type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)

type GetJobManifestInput struct {
	// The ID for a job that you want to get the manifest file for, for example
	// JID123e4567-e89b-12d3-a456-426655440000.
	JobId *string
}

type GetJobManifestOutput struct {
	// The Amazon S3 presigned URL for the manifest file associated with the specified
	// JobId value.
	ManifestURI *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetJobUnlockCodeInput struct {
	// The ID for the job that you want to get the UnlockCode value for, for example
	// JID123e4567-e89b-12d3-a456-426655440000.
	JobId *string
}

type GetJobUnlockCodeOutput struct {
	// The UnlockCode value for the specified job. The UnlockCode value can be accessed
	// for up to 90 days after the job has been created.
	UnlockCode *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetSnowballUsageInput struct {
}

type GetSnowballUsageOutput struct {
	// The service limit for number of Snowballs this account can have at once. The
	// default service limit is 1 (one).
	SnowballLimit *int32
	// The number of Snowballs that this account is currently using.
	SnowballsInUse *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetSoftwareUpdatesInput struct {
	// The ID for a job that you want to get the software update file for, for example
	// JID123e4567-e89b-12d3-a456-426655440000.
	JobId *string
}

type GetSoftwareUpdatesOutput struct {
	// The Amazon S3 presigned URL for the update file associated with the specified
	// JobId value. The software update will be available for 2 days after this request
	// is made. To access an update after the 2 days have passed, you'll have to make
	// another call to GetSoftwareUpdates.
	UpdatesURI *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error
}

type ListClusterJobsInput struct {
	// HTTP requests are stateless. To identify what object comes "next" in the list of
	// JobListEntry objects, you have the option of specifying NextToken as the
	// starting point for your returned list.
	NextToken *string
	// The 39-character ID for the cluster that you want to list, for example
	// CID123e4567-e89b-12d3-a456-426655440000.
	ClusterId *string
	// The number of JobListEntry objects to return.
	MaxResults *int32
}

type ListClusterJobsOutput struct {
	// HTTP requests are stateless. If you use the automatically generated NextToken
	// value in your next ListClusterJobsResult call, your list of returned jobs will
	// start from this point in the array.
	NextToken *string
	// Each JobListEntry object contains a job's state, a job's ID, and a value that
	// indicates whether the job is a job part, in the case of export jobs.
	JobListEntries []*types.JobListEntry

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListClustersInput struct {
	// The number of ClusterListEntry objects to return.
	MaxResults *int32
	// HTTP requests are stateless. To identify what object comes "next" in the list of
	// ClusterListEntry objects, you have the option of specifying NextToken as the
	// starting point for your returned list.
	NextToken *string
}

type ListClustersOutput struct {
	// HTTP requests are stateless. If you use the automatically generated NextToken
	// value in your next ClusterListEntry call, your list of returned clusters will
	// start from this point in the array.
	NextToken *string
	// Each ClusterListEntry object contains a cluster's state, a cluster's ID, and
	// other important status information.
	ClusterListEntries []*types.ClusterListEntry

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListCompatibleImagesInput struct {
	// The maximum number of results for the list of compatible images. Currently, a
	// Snowball Edge device can store 10 AMIs.
	MaxResults *int32
	// HTTP requests are stateless. To identify what object comes "next" in the list of
	// compatible images, you can specify a value for NextToken as the starting point
	// for your list of returned images.
	NextToken *string
}

type ListCompatibleImagesOutput struct {
	// A JSON-formatted object that describes a compatible AMI, including the ID and
	// name for a Snowball Edge AMI.
	CompatibleImages []*types.CompatibleImage
	// Because HTTP requests are stateless, this is the starting point for your next
	// list of returned images.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListJobsInput struct {
	// HTTP requests are stateless. To identify what object comes "next" in the list of
	// JobListEntry objects, you have the option of specifying NextToken as the
	// starting point for your returned list.
	NextToken *string
	// The number of JobListEntry objects to return.
	MaxResults *int32
}

type ListJobsOutput struct {
	// Each JobListEntry object contains a job's state, a job's ID, and a value that
	// indicates whether the job is a job part, in the case of export jobs.
	JobListEntries []*types.JobListEntry
	// HTTP requests are stateless. If you use this automatically generated NextToken
	// value in your next ListJobs call, your returned JobListEntry objects will start
	// from this point in the array.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions ResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions = internalendpoints.Options

type UpdateClusterInput struct {
	// The updated ID for the forwarding address for a cluster. This field is not
	// supported in most regions.
	ForwardingAddressId *string
	// The updated shipping option value of this cluster's ShippingDetails () object.
	ShippingOption types.ShippingOption
	// The cluster ID of the cluster that you want to update, for example
	// CID123e4567-e89b-12d3-a456-426655440000.
	ClusterId *string
	// The updated description of this cluster.
	Description *string
	// The updated arrays of JobResource () objects that can include updated S3Resource
	// () objects or LambdaResource () objects.
	Resources *types.JobResource
	// The ID of the updated Address () object.
	AddressId *string
	// The new or updated Notification () object.
	Notification *types.Notification
	// The new role Amazon Resource Name (ARN) that you want to associate with this
	// cluster. To create a role ARN, use the CreateRole
	// (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) API
	// action in AWS Identity and Access Management (IAM).
	RoleARN *string
}

type UpdateClusterOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateJobInput struct {
	// The updated shipping option value of this job's ShippingDetails () object.
	ShippingOption types.ShippingOption
	// The updated ID for the forwarding address for a job. This field is not supported
	// in most regions.
	ForwardingAddressId *string
	// The updated description of this job's JobMetadata () object.
	Description *string
	// The ID of the updated Address () object.
	AddressId *string
	// The new or updated Notification () object.
	Notification *types.Notification
	// The job ID of the job that you want to update, for example
	// JID123e4567-e89b-12d3-a456-426655440000.
	JobId *string
	// The new role Amazon Resource Name (ARN) that you want to associate with this
	// job. To create a role ARN, use the CreateRole
	// (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html)AWS
	// Identity and Access Management (IAM) API action.
	RoleARN *string
	// The updated SnowballCapacityPreference of this job's JobMetadata () object. The
	// 50 TB Snowballs are only available in the US regions.
	SnowballCapacityPreference types.SnowballCapacity
	// The updated JobResource object, or the updated JobResource () object.
	Resources *types.JobResource
}

type UpdateJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}