dataexchange/types/types.go

// Code generated by smithy-go-codegen DO NOT EDIT.

package types

import (
	"time"
)

// The destination for the asset.
type AssetDestinationEntry struct {

	// The unique identifier for the asset.
	//
	// This member is required.
	AssetId *string

	// The S3 bucket that is the destination for the asset.
	//
	// This member is required.
	Bucket *string

	// The name of the object in Amazon S3 for the asset.
	Key *string
}

type AssetDetails struct {

	// The S3 object that is the asset.
	S3SnapshotAsset *S3SnapshotAsset
}

// An asset in AWS Data Exchange is a piece of data that can be stored as an S3
// object. The asset can be a structured data file, an image file, or some other
// data file. When you create an import job for your files, you create an asset in
// AWS Data Exchange for each of those files.
type AssetEntry struct {

	// The ARN for the asset.
	//
	// This member is required.
	Arn *string

	// Information about the asset, including its size.
	//
	// This member is required.
	AssetDetails *AssetDetails

	// The type of file your data is stored in. Currently, the supported asset type is
	// S3_SNAPSHOT.
	//
	// This member is required.
	AssetType AssetType

	// The date and time that the asset was created, in ISO 8601 format.
	//
	// This member is required.
	CreatedAt *time.Time

	// The unique identifier for the data set associated with this asset.
	//
	// This member is required.
	DataSetId *string

	// The unique identifier for the asset.
	//
	// This member is required.
	Id *string

	// The name of the asset. When importing from Amazon S3, the S3 object key is used
	// as the asset name. When exporting to Amazon S3, the asset name is used as
	// default target S3 object key.
	//
	// This member is required.
	Name *string

	// The unique identifier for the revision associated with this asset.
	//
	// This member is required.
	RevisionId *string

	// The date and time that the asset was last updated, in ISO 8601 format.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The asset ID of the owned asset corresponding to the entitled asset being
	// viewed. This parameter is returned when an asset owner is viewing the entitled
	// copy of its owned asset.
	SourceId *string
}

// The source of the assets.
type AssetSourceEntry struct {

	// The S3 bucket that's part of the source of the asset.
	//
	// This member is required.
	Bucket *string

	// The name of the object in Amazon S3 for the asset.
	//
	// This member is required.
	Key *string
}

// A data set is an AWS resource with one or more revisions.
type DataSetEntry struct {

	// The ARN for the data set.
	//
	// This member is required.
	Arn *string

	// The type of file your data is stored in. Currently, the supported asset type is
	// S3_SNAPSHOT.
	//
	// This member is required.
	AssetType AssetType

	// The date and time that the data set was created, in ISO 8601 format.
	//
	// This member is required.
	CreatedAt *time.Time

	// The description for the data set.
	//
	// This member is required.
	Description *string

	// The unique identifier for the data set.
	//
	// This member is required.
	Id *string

	// The name of the data set.
	//
	// This member is required.
	Name *string

	// A property that defines the data set as OWNED by the account (for providers) or
	// ENTITLED to the account (for subscribers).
	//
	// This member is required.
	Origin Origin

	// The date and time that the data set was last updated, in ISO 8601 format.
	//
	// This member is required.
	UpdatedAt *time.Time

	// If the origin of this data set is ENTITLED, includes the details for the product
	// on AWS Marketplace.
	OriginDetails *OriginDetails

	// The data set ID of the owned data set corresponding to the entitled data set
	// being viewed. This parameter is returned when a data set owner is viewing the
	// entitled copy of its owned data set.
	SourceId *string
}

type Details struct {
	ImportAssetFromSignedUrlJobErrorDetails *ImportAssetFromSignedUrlJobErrorDetails

	// The list of sources for the assets.
	ImportAssetsFromS3JobErrorDetails []AssetSourceEntry
}

// Details of the operation to be performed by the job.
type ExportAssetsToS3RequestDetails struct {

	// The destination for the asset.
	//
	// This member is required.
	AssetDestinations []AssetDestinationEntry

	// The unique identifier for the data set associated with this export job.
	//
	// This member is required.
	DataSetId *string

	// The unique identifier for the revision associated with this export request.
	//
	// This member is required.
	RevisionId *string

	// Encryption configuration for the export job.
	Encryption *ExportServerSideEncryption
}

// Details about the export to Amazon S3 response.
type ExportAssetsToS3ResponseDetails struct {

	// The destination in Amazon S3 where the asset is exported.
	//
	// This member is required.
	AssetDestinations []AssetDestinationEntry

	// The unique identifier for the data set associated with this export job.
	//
	// This member is required.
	DataSetId *string

	// The unique identifier for the revision associated with this export response.
	//
	// This member is required.
	RevisionId *string

	// Encryption configuration of the export job.
	Encryption *ExportServerSideEncryption
}

// Details of the operation to be performed by the job.
type ExportAssetToSignedUrlRequestDetails struct {

	// The unique identifier for the asset that is exported to a signed URL.
	//
	// This member is required.
	AssetId *string

	// The unique identifier for the data set associated with this export job.
	//
	// This member is required.
	DataSetId *string

	// The unique identifier for the revision associated with this export request.
	//
	// This member is required.
	RevisionId *string
}

// The details of the export to signed URL response.
type ExportAssetToSignedUrlResponseDetails struct {

	// The unique identifier for the asset associated with this export job.
	//
	// This member is required.
	AssetId *string

	// The unique identifier for the data set associated with this export job.
	//
	// This member is required.
	DataSetId *string

	// The unique identifier for the revision associated with this export response.
	//
	// This member is required.
	RevisionId *string

	// The signed URL for the export request.
	SignedUrl *string

	// The date and time that the signed URL expires, in ISO 8601 format.
	SignedUrlExpiresAt *time.Time
}

// Details of the operation to be performed by the job.
type ExportRevisionsToS3RequestDetails struct {

	// The unique identifier for the data set associated with this export job.
	//
	// This member is required.
	DataSetId *string

	// The destination for the revision.
	//
	// This member is required.
	RevisionDestinations []RevisionDestinationEntry

	// Encryption configuration for the export job.
	Encryption *ExportServerSideEncryption
}

// Details about the export revisions to Amazon S3 response.
type ExportRevisionsToS3ResponseDetails struct {

	// The unique identifier for the data set associated with this export job.
	//
	// This member is required.
	DataSetId *string

	// The destination in Amazon S3 where the revision is exported.
	//
	// This member is required.
	RevisionDestinations []RevisionDestinationEntry

	// Encryption configuration of the export job.
	Encryption *ExportServerSideEncryption
}

// Encryption configuration of the export job. Includes the encryption type as well
// as the AWS KMS key. The KMS key is only necessary if you chose the KMS
// encryption type.
type ExportServerSideEncryption struct {

	// The type of server side encryption used for encrypting the objects in Amazon S3.
	//
	// This member is required.
	Type ServerSideEncryptionTypes

	// The Amazon Resource Name (ARN) of the the AWS KMS key you want to use to encrypt
	// the Amazon S3 objects. This parameter is required if you choose aws:kms as an
	// encryption type.
	KmsKeyArn *string
}

type ImportAssetFromSignedUrlJobErrorDetails struct {

	// The name of the asset. When importing from Amazon S3, the S3 object key is used
	// as the asset name. When exporting to Amazon S3, the asset name is used as
	// default target S3 object key.
	//
	// This member is required.
	AssetName *string
}

// Details of the operation to be performed by the job.
type ImportAssetFromSignedUrlRequestDetails struct {

	// The name of the asset. When importing from Amazon S3, the S3 object key is used
	// as the asset name.
	//
	// This member is required.
	AssetName *string

	// The unique identifier for the data set associated with this import job.
	//
	// This member is required.
	DataSetId *string

	// The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the
	// file at that location.
	//
	// This member is required.
	Md5Hash *string

	// The unique identifier for the revision associated with this import request.
	//
	// This member is required.
	RevisionId *string
}

// The details in the response for an import request, including the signed URL and
// other information.
type ImportAssetFromSignedUrlResponseDetails struct {

	// The name for the asset associated with this import response.
	//
	// This member is required.
	AssetName *string

	// The unique identifier for the data set associated with this import job.
	//
	// This member is required.
	DataSetId *string

	// The unique identifier for the revision associated with this import response.
	//
	// This member is required.
	RevisionId *string

	// The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the
	// file at that location.
	Md5Hash *string

	// The signed URL.
	SignedUrl *string

	// The time and date at which the signed URL expires, in ISO 8601 format.
	SignedUrlExpiresAt *time.Time
}

// Details of the operation to be performed by the job.
type ImportAssetsFromS3RequestDetails struct {

	// Is a list of S3 bucket and object key pairs.
	//
	// This member is required.
	AssetSources []AssetSourceEntry

	// The unique identifier for the data set associated with this import job.
	//
	// This member is required.
	DataSetId *string

	// The unique identifier for the revision associated with this import request.
	//
	// This member is required.
	RevisionId *string
}

// Details from an import from Amazon S3 response.
type ImportAssetsFromS3ResponseDetails struct {

	// Is a list of Amazon S3 bucket and object key pairs.
	//
	// This member is required.
	AssetSources []AssetSourceEntry

	// The unique identifier for the data set associated with this import job.
	//
	// This member is required.
	DataSetId *string

	// The unique identifier for the revision associated with this import response.
	//
	// This member is required.
	RevisionId *string
}

// AWS Data Exchange Jobs are asynchronous import or export operations used to
// create or copy assets. A data set owner can both import and export as they see
// fit. Someone with an entitlement to a data set can only export. Jobs are deleted
// 90 days after they are created.
type JobEntry struct {

	// The ARN for the job.
	//
	// This member is required.
	Arn *string

	// The date and time that the job was created, in ISO 8601 format.
	//
	// This member is required.
	CreatedAt *time.Time

	// Details of the operation to be performed by the job, such as export destination
	// details or import source details.
	//
	// This member is required.
	Details *ResponseDetails

	// The unique identifier for the job.
	//
	// This member is required.
	Id *string

	// The state of the job.
	//
	// This member is required.
	State State

	// The job type.
	//
	// This member is required.
	Type Type

	// The date and time that the job was last updated, in ISO 8601 format.
	//
	// This member is required.
	UpdatedAt *time.Time

	// Errors for jobs.
	Errors []JobError
}

// An error that occurred with the job request.
type JobError struct {

	// The code for the job error.
	//
	// This member is required.
	Code Code

	// The message related to the job error.
	//
	// This member is required.
	Message *string

	Details *Details

	// The name of the limit that was reached.
	LimitName JobErrorLimitName

	// The value of the exceeded limit.
	LimitValue float64

	// The unique identifier for the resource related to the error.
	ResourceId *string

	// The type of resource related to the error.
	ResourceType JobErrorResourceTypes
}

type OriginDetails struct {

	// This member is required.
	ProductId *string
}

// The details for the request.
type RequestDetails struct {

	// Details about the export to signed URL request.
	ExportAssetToSignedUrl *ExportAssetToSignedUrlRequestDetails

	// Details about the export to Amazon S3 request.
	ExportAssetsToS3 *ExportAssetsToS3RequestDetails

	// Details about the export to Amazon S3 request.
	ExportRevisionsToS3 *ExportRevisionsToS3RequestDetails

	// Details about the import from signed URL request.
	ImportAssetFromSignedUrl *ImportAssetFromSignedUrlRequestDetails

	// Details about the import from Amazon S3 request.
	ImportAssetsFromS3 *ImportAssetsFromS3RequestDetails
}

// Details for the response.
type ResponseDetails struct {

	// Details for the export to signed URL response.
	ExportAssetToSignedUrl *ExportAssetToSignedUrlResponseDetails

	// Details for the export to Amazon S3 response.
	ExportAssetsToS3 *ExportAssetsToS3ResponseDetails

	// Details for the export revisions to Amazon S3 response.
	ExportRevisionsToS3 *ExportRevisionsToS3ResponseDetails

	// Details for the import from signed URL response.
	ImportAssetFromSignedUrl *ImportAssetFromSignedUrlResponseDetails

	// Details for the import from Amazon S3 response.
	ImportAssetsFromS3 *ImportAssetsFromS3ResponseDetails
}

// The destination where the assets in the revision will be exported.
type RevisionDestinationEntry struct {

	// The S3 bucket that is the destination for the assets in the revision.
	//
	// This member is required.
	Bucket *string

	// The unique identifier for the revision.
	//
	// This member is required.
	RevisionId *string

	// A string representing the pattern for generated names of the individual assets
	// in the revision. For more information about key patterns, see Key patterns when
	// exporting revisions
	// (https://docs.aws.amazon.com/data-exchange/latest/userguide/jobs.html#revision-export-keypatterns).
	KeyPattern *string
}

// A revision is a container for one or more assets.
type RevisionEntry struct {

	// The ARN for the revision.
	//
	// This member is required.
	Arn *string

	// The date and time that the revision was created, in ISO 8601 format.
	//
	// This member is required.
	CreatedAt *time.Time

	// The unique identifier for the data set associated with this revision.
	//
	// This member is required.
	DataSetId *string

	// The unique identifier for the revision.
	//
	// This member is required.
	Id *string

	// The date and time that the revision was last updated, in ISO 8601 format.
	//
	// This member is required.
	UpdatedAt *time.Time

	// An optional comment about the revision.
	Comment *string

	// To publish a revision to a data set in a product, the revision must first be
	// finalized. Finalizing a revision tells AWS Data Exchange that your changes to
	// the assets in the revision are complete. After it's in this read-only state, you
	// can publish the revision to your products. Finalized revisions can be published
	// through the AWS Data Exchange console or the AWS Marketplace Catalog API, using
	// the StartChangeSet AWS Marketplace Catalog API action. When using the API,
	// revisions are uniquely identified by their ARN.
	Finalized bool

	// The revision ID of the owned revision corresponding to the entitled revision
	// being viewed. This parameter is returned when a revision owner is viewing the
	// entitled copy of its owned revision.
	SourceId *string
}

// The S3 object that is the asset.
type S3SnapshotAsset struct {

	// The size of the S3 object that is the object.
	//
	// This member is required.
	Size float64
}