Documentation ¶
Index ¶
- type AccessDeniedException
- type AssetDestinationEntry
- type AssetDetails
- type AssetEntry
- type AssetSourceEntry
- type AssetType
- type Code
- type ConflictException
- type DataSetEntry
- type Details
- type ExportAssetToSignedUrlRequestDetails
- type ExportAssetToSignedUrlResponseDetails
- type ExportAssetsToS3RequestDetails
- type ExportAssetsToS3ResponseDetails
- type ExportServerSideEncryption
- type ImportAssetFromSignedUrlJobErrorDetails
- type ImportAssetFromSignedUrlRequestDetails
- type ImportAssetFromSignedUrlResponseDetails
- type ImportAssetsFromS3RequestDetails
- type ImportAssetsFromS3ResponseDetails
- type InternalServerException
- type JobEntry
- type JobError
- type JobErrorLimitName
- type JobErrorResourceTypes
- type LimitName
- type Origin
- type OriginDetails
- type RequestDetails
- type ResourceNotFoundException
- type ResourceType
- type ResponseDetails
- type RevisionEntry
- type S3SnapshotAsset
- type ServerSideEncryptionTypes
- type ServiceLimitExceededException
- type State
- type ThrottlingException
- type Type
- type ValidationException
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessDeniedException ¶
type AccessDeniedException struct {
Message *string
}
Access to the resource is denied.
func (*AccessDeniedException) Error ¶
func (e *AccessDeniedException) Error() string
func (*AccessDeniedException) ErrorCode ¶
func (e *AccessDeniedException) ErrorCode() string
func (*AccessDeniedException) ErrorFault ¶
func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault
func (*AccessDeniedException) ErrorMessage ¶
func (e *AccessDeniedException) ErrorMessage() string
type AssetDestinationEntry ¶
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 }
The destination for the asset.
type AssetDetails ¶
type AssetDetails struct { // The S3 object that is the asset. S3SnapshotAsset *S3SnapshotAsset }
type AssetEntry ¶
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 }
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 AssetSourceEntry ¶
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 }
The source of the assets.
type AssetType ¶
type AssetType string
const (
AssetTypeS3Snapshot AssetType = "S3_SNAPSHOT"
)
Enum values for AssetType
type Code ¶
type Code string
const ( CodeAccessDeniedException Code = "ACCESS_DENIED_EXCEPTION" CodeInternalServerException Code = "INTERNAL_SERVER_EXCEPTION" CodeMalwareDetected Code = "MALWARE_DETECTED" CodeResourceNotFoundException Code = "RESOURCE_NOT_FOUND_EXCEPTION" CodeServiceQuotaExceededException Code = "SERVICE_QUOTA_EXCEEDED_EXCEPTION" CodeValidationException Code = "VALIDATION_EXCEPTION" CodeMalwareScanEncryptedFile Code = "MALWARE_SCAN_ENCRYPTED_FILE" )
Enum values for Code
type ConflictException ¶
type ConflictException struct { Message *string ResourceId *string ResourceType ResourceType }
The request couldn't be completed because it conflicted with the current state of the resource.
func (*ConflictException) Error ¶
func (e *ConflictException) Error() string
func (*ConflictException) ErrorCode ¶
func (e *ConflictException) ErrorCode() string
func (*ConflictException) ErrorFault ¶
func (e *ConflictException) ErrorFault() smithy.ErrorFault
func (*ConflictException) ErrorMessage ¶
func (e *ConflictException) ErrorMessage() string
type DataSetEntry ¶
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 }
A data set is an AWS resource with one or more revisions.
type Details ¶
type Details struct { ImportAssetFromSignedUrlJobErrorDetails *ImportAssetFromSignedUrlJobErrorDetails // The list of sources for the assets. ImportAssetsFromS3JobErrorDetails []AssetSourceEntry }
type ExportAssetToSignedUrlRequestDetails ¶
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 }
Details of the operation to be performed by the job.
type ExportAssetToSignedUrlResponseDetails ¶
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 }
The details of the export to signed URL response.
type ExportAssetsToS3RequestDetails ¶
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 of the operation to be performed by the job.
type ExportAssetsToS3ResponseDetails ¶
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 about the export to Amazon S3 response.
type ExportServerSideEncryption ¶
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 }
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 ImportAssetFromSignedUrlJobErrorDetails ¶
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 }
type ImportAssetFromSignedUrlRequestDetails ¶
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 }
Details of the operation to be performed by the job.
type ImportAssetFromSignedUrlResponseDetails ¶
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 }
The details in the response for an import request, including the signed URL and other information.
type ImportAssetsFromS3RequestDetails ¶
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 of the operation to be performed by the job.
type ImportAssetsFromS3ResponseDetails ¶
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 }
Details from an import from Amazon S3 response.
type InternalServerException ¶
type InternalServerException struct {
Message *string
}
An exception occurred with the service.
func (*InternalServerException) Error ¶
func (e *InternalServerException) Error() string
func (*InternalServerException) ErrorCode ¶
func (e *InternalServerException) ErrorCode() string
func (*InternalServerException) ErrorFault ¶
func (e *InternalServerException) ErrorFault() smithy.ErrorFault
func (*InternalServerException) ErrorMessage ¶
func (e *InternalServerException) ErrorMessage() string
type JobEntry ¶
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 }
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 JobError ¶
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 }
An error that occurred with the job request.
type JobErrorLimitName ¶
type JobErrorLimitName string
const ( JobErrorLimitNameAssetsPerRevision JobErrorLimitName = "Assets per revision" JobErrorLimitNameAssetSizeInGb JobErrorLimitName = "Asset size in GB" )
Enum values for JobErrorLimitName
func (JobErrorLimitName) Values ¶ added in v0.29.0
func (JobErrorLimitName) Values() []JobErrorLimitName
Values returns all known values for JobErrorLimitName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type JobErrorResourceTypes ¶
type JobErrorResourceTypes string
const ( JobErrorResourceTypesRevision JobErrorResourceTypes = "REVISION" JobErrorResourceTypesAsset JobErrorResourceTypes = "ASSET" )
Enum values for JobErrorResourceTypes
func (JobErrorResourceTypes) Values ¶ added in v0.29.0
func (JobErrorResourceTypes) Values() []JobErrorResourceTypes
Values returns all known values for JobErrorResourceTypes. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type LimitName ¶
type LimitName string
const ( LimitNameProductsPerAccount LimitName = "Products per account" LimitNameDataSetsPerAccount LimitName = "Data sets per account" LimitNameDataSetsPerProduct LimitName = "Data sets per product" LimitNameRevisionsPerDataSet LimitName = "Revisions per data set" LimitNameAssetsPerRevision LimitName = "Assets per revision" LimitNameAssetsPerImportJobFromAmazonS3 LimitName = "Assets per import job from Amazon S3" LimitNameAssetPerExportJobFromAmazonS3 LimitName = "Asset per export job from Amazon S3" LimitNameAssetSizeInGb LimitName = "Asset size in GB" LimitNameConcurrentInProgressJobsToImportAssetsFromAmazonS3 LimitName = "Concurrent in progress jobs to import assets from Amazon S3" LimitNameConcurrentInProgressJobsToImportAssetsFromASignedUrl LimitName = "Concurrent in progress jobs to import assets from a signed URL" LimitNameConcurrentInProgressJobsToExportAssetsToAmazonS3 LimitName = "Concurrent in progress jobs to export assets to Amazon S3" LimitNameConcurrentInProgressJobsToExportAssetsToASignedUrl LimitName = "Concurrent in progress jobs to export assets to a signed URL" )
Enum values for LimitName
type OriginDetails ¶
type OriginDetails struct { // This member is required. ProductId *string }
type RequestDetails ¶
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 import from signed URL request. ImportAssetFromSignedUrl *ImportAssetFromSignedUrlRequestDetails // Details about the import from Amazon S3 request. ImportAssetsFromS3 *ImportAssetsFromS3RequestDetails }
The details for the request.
type ResourceNotFoundException ¶
type ResourceNotFoundException struct { Message *string ResourceId *string ResourceType ResourceType }
The resource couldn't be found.
func (*ResourceNotFoundException) Error ¶
func (e *ResourceNotFoundException) Error() string
func (*ResourceNotFoundException) ErrorCode ¶
func (e *ResourceNotFoundException) ErrorCode() string
func (*ResourceNotFoundException) ErrorFault ¶
func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
func (*ResourceNotFoundException) ErrorMessage ¶
func (e *ResourceNotFoundException) ErrorMessage() string
type ResourceType ¶
type ResourceType string
const ( ResourceTypeDataSet ResourceType = "DATA_SET" ResourceTypeRevision ResourceType = "REVISION" ResourceTypeAsset ResourceType = "ASSET" ResourceTypeJob ResourceType = "JOB" )
Enum values for ResourceType
func (ResourceType) Values ¶ added in v0.29.0
func (ResourceType) Values() []ResourceType
Values returns all known values for ResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type ResponseDetails ¶
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 import from signed URL response. ImportAssetFromSignedUrl *ImportAssetFromSignedUrlResponseDetails // Details for the import from Amazon S3 response. ImportAssetsFromS3 *ImportAssetsFromS3ResponseDetails }
Details for the response.
type RevisionEntry ¶
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 }
A revision is a container for one or more assets.
type S3SnapshotAsset ¶
type S3SnapshotAsset struct { // The size of the S3 object that is the object. // // This member is required. Size float64 }
The S3 object that is the asset.
type ServerSideEncryptionTypes ¶
type ServerSideEncryptionTypes string
const ( ServerSideEncryptionTypesAwsKms ServerSideEncryptionTypes = "aws:kms" ServerSideEncryptionTypesAes256 ServerSideEncryptionTypes = "AES256" )
Enum values for ServerSideEncryptionTypes
func (ServerSideEncryptionTypes) Values ¶ added in v0.29.0
func (ServerSideEncryptionTypes) Values() []ServerSideEncryptionTypes
Values returns all known values for ServerSideEncryptionTypes. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type ServiceLimitExceededException ¶
type ServiceLimitExceededException struct { Message *string LimitName LimitName LimitValue float64 }
The request has exceeded the quotas imposed by the service.
func (*ServiceLimitExceededException) Error ¶
func (e *ServiceLimitExceededException) Error() string
func (*ServiceLimitExceededException) ErrorCode ¶
func (e *ServiceLimitExceededException) ErrorCode() string
func (*ServiceLimitExceededException) ErrorFault ¶
func (e *ServiceLimitExceededException) ErrorFault() smithy.ErrorFault
func (*ServiceLimitExceededException) ErrorMessage ¶
func (e *ServiceLimitExceededException) ErrorMessage() string
type State ¶
type State string
type ThrottlingException ¶
type ThrottlingException struct {
Message *string
}
The limit on the number of requests per second was exceeded.
func (*ThrottlingException) Error ¶
func (e *ThrottlingException) Error() string
func (*ThrottlingException) ErrorCode ¶
func (e *ThrottlingException) ErrorCode() string
func (*ThrottlingException) ErrorFault ¶
func (e *ThrottlingException) ErrorFault() smithy.ErrorFault
func (*ThrottlingException) ErrorMessage ¶
func (e *ThrottlingException) ErrorMessage() string
type Type ¶
type Type string
type ValidationException ¶
type ValidationException struct {
Message *string
}
The request was invalid.
func (*ValidationException) Error ¶
func (e *ValidationException) Error() string
func (*ValidationException) ErrorCode ¶
func (e *ValidationException) ErrorCode() string
func (*ValidationException) ErrorFault ¶
func (e *ValidationException) ErrorFault() smithy.ErrorFault
func (*ValidationException) ErrorMessage ¶
func (e *ValidationException) ErrorMessage() string