Documentation ¶
Overview ¶
Package dataexchange provides the API client, operations, and parameter types for AWS Data Exchange.
AWS Data Exchange is a service that makes it easy for AWS customers to exchange data in the cloud. You can use the AWS Data Exchange APIs to create, update, manage, and access file-based data set in the AWS Cloud.As a subscriber, you can view and access the data sets that you have an entitlement to through a subscription. You can use the APIS to download or copy your entitled data sets to Amazon S3 for use across a variety of AWS analytics and machine learning services.As a provider, you can create and manage your data sets that you would like to publish to a product. Being able to package and provide your data sets into products requires a few steps to determine eligibility. For more information, visit the AWS Data Exchange User Guide.A data set is a collection of data that can be changed or updated over time. Data sets can be updated using revisions, which represent a new version or incremental change to a data set. A revision contains one or more assets. An asset in AWS Data Exchange is a piece of data that can be stored as an Amazon S3 object. The asset can be a structured data file, an image file, or some other data file. Jobs are asynchronous import or export operations used to create or copy assets.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- type CancelJobInput
- type CancelJobOutput
- type Client
- func (c *Client) CancelJob(ctx context.Context, params *CancelJobInput, optFns ...func(*Options)) (*CancelJobOutput, error)
- func (c *Client) CreateDataSet(ctx context.Context, params *CreateDataSetInput, optFns ...func(*Options)) (*CreateDataSetOutput, error)
- func (c *Client) CreateJob(ctx context.Context, params *CreateJobInput, optFns ...func(*Options)) (*CreateJobOutput, error)
- func (c *Client) CreateRevision(ctx context.Context, params *CreateRevisionInput, optFns ...func(*Options)) (*CreateRevisionOutput, error)
- func (c *Client) DeleteAsset(ctx context.Context, params *DeleteAssetInput, optFns ...func(*Options)) (*DeleteAssetOutput, error)
- func (c *Client) DeleteDataSet(ctx context.Context, params *DeleteDataSetInput, optFns ...func(*Options)) (*DeleteDataSetOutput, error)
- func (c *Client) DeleteRevision(ctx context.Context, params *DeleteRevisionInput, optFns ...func(*Options)) (*DeleteRevisionOutput, error)
- func (c *Client) GetAsset(ctx context.Context, params *GetAssetInput, optFns ...func(*Options)) (*GetAssetOutput, error)
- func (c *Client) GetDataSet(ctx context.Context, params *GetDataSetInput, optFns ...func(*Options)) (*GetDataSetOutput, error)
- func (c *Client) GetJob(ctx context.Context, params *GetJobInput, optFns ...func(*Options)) (*GetJobOutput, error)
- func (c *Client) GetRevision(ctx context.Context, params *GetRevisionInput, optFns ...func(*Options)) (*GetRevisionOutput, error)
- func (c *Client) ListDataSetRevisions(ctx context.Context, params *ListDataSetRevisionsInput, ...) (*ListDataSetRevisionsOutput, error)
- func (c *Client) ListDataSets(ctx context.Context, params *ListDataSetsInput, optFns ...func(*Options)) (*ListDataSetsOutput, error)
- func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ...func(*Options)) (*ListJobsOutput, error)
- func (c *Client) ListRevisionAssets(ctx context.Context, params *ListRevisionAssetsInput, optFns ...func(*Options)) (*ListRevisionAssetsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) StartJob(ctx context.Context, params *StartJobInput, optFns ...func(*Options)) (*StartJobOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateAsset(ctx context.Context, params *UpdateAssetInput, optFns ...func(*Options)) (*UpdateAssetOutput, error)
- func (c *Client) UpdateDataSet(ctx context.Context, params *UpdateDataSetInput, optFns ...func(*Options)) (*UpdateDataSetOutput, error)
- func (c *Client) UpdateRevision(ctx context.Context, params *UpdateRevisionInput, optFns ...func(*Options)) (*UpdateRevisionOutput, error)
- type CreateDataSetInput
- type CreateDataSetOutput
- type CreateJobInput
- type CreateJobOutput
- type CreateRevisionInput
- type CreateRevisionOutput
- type DeleteAssetInput
- type DeleteAssetOutput
- type DeleteDataSetInput
- type DeleteDataSetOutput
- type DeleteRevisionInput
- type DeleteRevisionOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type GetAssetInput
- type GetAssetOutput
- type GetDataSetInput
- type GetDataSetOutput
- type GetJobInput
- type GetJobOutput
- type GetRevisionInput
- type GetRevisionOutput
- type HTTPClient
- type HTTPSignerV4
- type ListDataSetRevisionsAPIClient
- type ListDataSetRevisionsInput
- type ListDataSetRevisionsOutput
- type ListDataSetRevisionsPaginator
- type ListDataSetRevisionsPaginatorOptions
- type ListDataSetsAPIClient
- type ListDataSetsInput
- type ListDataSetsOutput
- type ListDataSetsPaginator
- type ListDataSetsPaginatorOptions
- type ListJobsAPIClient
- type ListJobsInput
- type ListJobsOutput
- type ListJobsPaginator
- type ListJobsPaginatorOptions
- type ListRevisionAssetsAPIClient
- type ListRevisionAssetsInput
- type ListRevisionAssetsOutput
- type ListRevisionAssetsPaginator
- type ListRevisionAssetsPaginatorOptions
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- type ResolveEndpoint
- type StartJobInput
- type StartJobOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateAssetInput
- type UpdateAssetOutput
- type UpdateDataSetInput
- type UpdateDataSetOutput
- type UpdateRevisionInput
- type UpdateRevisionOutput
Constants ¶
const ServiceAPIVersion = "2017-07-25"
const ServiceID = "DataExchange"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
Types ¶
type CancelJobInput ¶
type CancelJobInput struct { // The unique identifier for a job. // // This member is required. JobId *string }
type CancelJobOutput ¶
type CancelJobOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS Data Exchange.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) CancelJob ¶
func (c *Client) CancelJob(ctx context.Context, params *CancelJobInput, optFns ...func(*Options)) (*CancelJobOutput, error)
This operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.
func (*Client) CreateDataSet ¶
func (c *Client) CreateDataSet(ctx context.Context, params *CreateDataSetInput, optFns ...func(*Options)) (*CreateDataSetOutput, error)
This operation creates a data set.
func (*Client) CreateJob ¶
func (c *Client) CreateJob(ctx context.Context, params *CreateJobInput, optFns ...func(*Options)) (*CreateJobOutput, error)
This operation creates a job.
func (*Client) CreateRevision ¶
func (c *Client) CreateRevision(ctx context.Context, params *CreateRevisionInput, optFns ...func(*Options)) (*CreateRevisionOutput, error)
This operation creates a revision for a data set.
func (*Client) DeleteAsset ¶
func (c *Client) DeleteAsset(ctx context.Context, params *DeleteAssetInput, optFns ...func(*Options)) (*DeleteAssetOutput, error)
This operation deletes an asset.
func (*Client) DeleteDataSet ¶
func (c *Client) DeleteDataSet(ctx context.Context, params *DeleteDataSetInput, optFns ...func(*Options)) (*DeleteDataSetOutput, error)
This operation deletes a data set.
func (*Client) DeleteRevision ¶
func (c *Client) DeleteRevision(ctx context.Context, params *DeleteRevisionInput, optFns ...func(*Options)) (*DeleteRevisionOutput, error)
This operation deletes a revision.
func (*Client) GetAsset ¶
func (c *Client) GetAsset(ctx context.Context, params *GetAssetInput, optFns ...func(*Options)) (*GetAssetOutput, error)
This operation returns information about an asset.
func (*Client) GetDataSet ¶
func (c *Client) GetDataSet(ctx context.Context, params *GetDataSetInput, optFns ...func(*Options)) (*GetDataSetOutput, error)
This operation returns information about a data set.
func (*Client) GetJob ¶
func (c *Client) GetJob(ctx context.Context, params *GetJobInput, optFns ...func(*Options)) (*GetJobOutput, error)
This operation returns information about a job.
func (*Client) GetRevision ¶
func (c *Client) GetRevision(ctx context.Context, params *GetRevisionInput, optFns ...func(*Options)) (*GetRevisionOutput, error)
This operation returns information about a revision.
func (*Client) ListDataSetRevisions ¶
func (c *Client) ListDataSetRevisions(ctx context.Context, params *ListDataSetRevisionsInput, optFns ...func(*Options)) (*ListDataSetRevisionsOutput, error)
This operation lists a data set's revisions sorted by CreatedAt in descending order.
func (*Client) ListDataSets ¶
func (c *Client) ListDataSets(ctx context.Context, params *ListDataSetsInput, optFns ...func(*Options)) (*ListDataSetsOutput, error)
This operation lists your data sets. When listing by origin OWNED, results are sorted by CreatedAt in descending order. When listing by origin ENTITLED, there is no order and the maxResults parameter is ignored.
func (*Client) ListJobs ¶
func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ...func(*Options)) (*ListJobsOutput, error)
This operation lists your jobs sorted by CreatedAt in descending order.
func (*Client) ListRevisionAssets ¶
func (c *Client) ListRevisionAssets(ctx context.Context, params *ListRevisionAssetsInput, optFns ...func(*Options)) (*ListRevisionAssetsOutput, error)
This operation lists a revision's assets sorted alphabetically in descending order.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
This operation lists the tags on the resource.
func (*Client) StartJob ¶
func (c *Client) StartJob(ctx context.Context, params *StartJobInput, optFns ...func(*Options)) (*StartJobOutput, error)
This operation starts a job.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
This operation tags a resource.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
This operation removes one or more tags from a resource.
func (*Client) UpdateAsset ¶
func (c *Client) UpdateAsset(ctx context.Context, params *UpdateAssetInput, optFns ...func(*Options)) (*UpdateAssetOutput, error)
This operation updates an asset.
func (*Client) UpdateDataSet ¶
func (c *Client) UpdateDataSet(ctx context.Context, params *UpdateDataSetInput, optFns ...func(*Options)) (*UpdateDataSetOutput, error)
This operation updates a data set.
func (*Client) UpdateRevision ¶
func (c *Client) UpdateRevision(ctx context.Context, params *UpdateRevisionInput, optFns ...func(*Options)) (*UpdateRevisionOutput, error)
This operation updates a revision.
type CreateDataSetInput ¶
type CreateDataSetInput struct { // The type of file your data is stored in. Currently, the supported asset type is // S3_SNAPSHOT. // // This member is required. AssetType types.AssetType // A description for the data set. This value can be up to 16,348 characters long. // // This member is required. Description *string // The name of the data set. // // This member is required. Name *string // A data set tag is an optional label that you can assign to a data set when you // create it. Each tag consists of a key and an optional value, both of which you // define. When you use tagging, you can also use tag-based access control in IAM // policies to control access to these data sets and revisions. Tags map[string]string }
The request body for CreateDataSet.
type CreateDataSetOutput ¶
type CreateDataSetOutput struct { // The ARN for the data set. Arn *string // The type of file your data is stored in. Currently, the supported asset type is // S3_SNAPSHOT. AssetType types.AssetType // The date and time that the data set was created, in ISO 8601 format. CreatedAt *time.Time // The description for the data set. Description *string // The unique identifier for the data set. Id *string // The name of the data set. Name *string // A property that defines the data set as OWNED by the account (for providers) or // ENTITLED to the account (for subscribers). Origin types.Origin // If the origin of this data set is ENTITLED, includes the details for the product // on AWS Marketplace. OriginDetails *types.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 // The tags for the data set. Tags map[string]string // The date and time that the data set was last updated, in ISO 8601 format. UpdatedAt *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateJobInput ¶
type CreateJobInput struct { // The details for the CreateJob request. // // This member is required. Details *types.RequestDetails // The type of job to be created. // // This member is required. Type types.Type }
The request body for CreateJob.
type CreateJobOutput ¶
type CreateJobOutput struct { // The ARN for the job. Arn *string // The date and time that the job was created, in ISO 8601 format. CreatedAt *time.Time // Details about the job. Details *types.ResponseDetails // The errors associated with jobs. Errors []types.JobError // The unique identifier for the job. Id *string // The state of the job. State types.State // The job type. Type types.Type // The date and time that the job was last updated, in ISO 8601 format. UpdatedAt *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateRevisionInput ¶
type CreateRevisionInput struct { // The unique identifier for a data set. // // This member is required. DataSetId *string // An optional comment about the revision. Comment *string // A revision tag is an optional label that you can assign to a revision when you // create it. Each tag consists of a key and an optional value, both of which you // define. When you use tagging, you can also use tag-based access control in IAM // policies to control access to these data sets and revisions. Tags map[string]string }
The request body for CreateRevision.
type CreateRevisionOutput ¶
type CreateRevisionOutput struct { // The ARN for the revision Arn *string // An optional comment about the revision. Comment *string // The date and time that the revision was created, in ISO 8601 format. CreatedAt *time.Time // The unique identifier for the data set associated with this revision. DataSetId *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 unique identifier for the revision. Id *string // 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 tags for the revision. Tags map[string]string // The date and time that the revision was last updated, in ISO 8601 format. UpdatedAt *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteAssetInput ¶
type DeleteAssetOutput ¶
type DeleteAssetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteDataSetInput ¶
type DeleteDataSetInput struct { // The unique identifier for a data set. // // This member is required. DataSetId *string }
type DeleteDataSetOutput ¶
type DeleteDataSetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteRevisionInput ¶
type DeleteRevisionOutput ¶
type DeleteRevisionOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func WithEndpointResolver ¶
func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶ added in v0.29.0
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type GetAssetInput ¶
type GetAssetOutput ¶
type GetAssetOutput struct { // The ARN for the asset. Arn *string // Information about the asset, including its size. AssetDetails *types.AssetDetails // The type of file your data is stored in. Currently, the supported asset type is // S3_SNAPSHOT. AssetType types.AssetType // The date and time that the asset was created, in ISO 8601 format. CreatedAt *time.Time // The unique identifier for the data set associated with this asset. DataSetId *string // The unique identifier for the asset. 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. Name *string // The unique identifier for the revision associated with this asset. RevisionId *string // 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 date and time that the asset was last updated, in ISO 8601 format. UpdatedAt *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetDataSetInput ¶
type GetDataSetInput struct { // The unique identifier for a data set. // // This member is required. DataSetId *string }
type GetDataSetOutput ¶
type GetDataSetOutput struct { // The ARN for the data set. Arn *string // The type of file your data is stored in. Currently, the supported asset type is // S3_SNAPSHOT. AssetType types.AssetType // The date and time that the data set was created, in ISO 8601 format. CreatedAt *time.Time // The description for the data set. Description *string // The unique identifier for the data set. Id *string // The name of the data set. Name *string // A property that defines the data set as OWNED by the account (for providers) or // ENTITLED to the account (for subscribers). Origin types.Origin // If the origin of this data set is ENTITLED, includes the details for the product // on AWS Marketplace. OriginDetails *types.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 // The tags for the data set. Tags map[string]string // The date and time that the data set was last updated, in ISO 8601 format. UpdatedAt *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetJobInput ¶
type GetJobInput struct { // The unique identifier for a job. // // This member is required. JobId *string }
type GetJobOutput ¶
type GetJobOutput struct { // The ARN for the job. Arn *string // The date and time that the job was created, in ISO 8601 format. CreatedAt *time.Time // Details about the job. Details *types.ResponseDetails // The errors associated with jobs. Errors []types.JobError // The unique identifier for the job. Id *string // The state of the job. State types.State // The job type. Type types.Type // The date and time that the job was last updated, in ISO 8601 format. UpdatedAt *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetRevisionInput ¶
type GetRevisionOutput ¶
type GetRevisionOutput struct { // The ARN for the revision Arn *string // An optional comment about the revision. Comment *string // The date and time that the revision was created, in ISO 8601 format. CreatedAt *time.Time // The unique identifier for the data set associated with this revision. DataSetId *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 unique identifier for the revision. Id *string // 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 tags for the revision. Tags map[string]string // The date and time that the revision was last updated, in ISO 8601 format. UpdatedAt *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HTTPSignerV4 ¶
type ListDataSetRevisionsAPIClient ¶ added in v0.30.0
type ListDataSetRevisionsAPIClient interface {
ListDataSetRevisions(context.Context, *ListDataSetRevisionsInput, ...func(*Options)) (*ListDataSetRevisionsOutput, error)
}
ListDataSetRevisionsAPIClient is a client that implements the ListDataSetRevisions operation.
type ListDataSetRevisionsInput ¶
type ListDataSetRevisionsInput struct { // The unique identifier for a data set. // // This member is required. DataSetId *string // The maximum number of results returned by a single call. MaxResults int32 // The token value retrieved from a previous call to access the next page of // results. NextToken *string }
type ListDataSetRevisionsOutput ¶
type ListDataSetRevisionsOutput struct { // The token value retrieved from a previous call to access the next page of // results. NextToken *string // The asset objects listed by the request. Revisions []types.RevisionEntry // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListDataSetRevisionsPaginator ¶ added in v0.30.0
type ListDataSetRevisionsPaginator struct {
// contains filtered or unexported fields
}
ListDataSetRevisionsPaginator is a paginator for ListDataSetRevisions
func NewListDataSetRevisionsPaginator ¶ added in v0.30.0
func NewListDataSetRevisionsPaginator(client ListDataSetRevisionsAPIClient, params *ListDataSetRevisionsInput, optFns ...func(*ListDataSetRevisionsPaginatorOptions)) *ListDataSetRevisionsPaginator
NewListDataSetRevisionsPaginator returns a new ListDataSetRevisionsPaginator
func (*ListDataSetRevisionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListDataSetRevisionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListDataSetRevisionsPaginator) NextPage ¶ added in v0.30.0
func (p *ListDataSetRevisionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDataSetRevisionsOutput, error)
NextPage retrieves the next ListDataSetRevisions page.
type ListDataSetRevisionsPaginatorOptions ¶ added in v0.30.0
type ListDataSetRevisionsPaginatorOptions struct { // The maximum number of results returned by a single call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListDataSetRevisionsPaginatorOptions is the paginator options for ListDataSetRevisions
type ListDataSetsAPIClient ¶ added in v0.30.0
type ListDataSetsAPIClient interface {
ListDataSets(context.Context, *ListDataSetsInput, ...func(*Options)) (*ListDataSetsOutput, error)
}
ListDataSetsAPIClient is a client that implements the ListDataSets operation.
type ListDataSetsInput ¶
type ListDataSetsInput struct { // The maximum number of results returned by a single call. MaxResults int32 // The token value retrieved from a previous call to access the next page of // results. NextToken *string // A property that defines the data set as OWNED by the account (for providers) or // ENTITLED to the account (for subscribers). Origin *string }
type ListDataSetsOutput ¶
type ListDataSetsOutput struct { // The data set objects listed by the request. DataSets []types.DataSetEntry // The token value retrieved from a previous call to access the next page of // results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListDataSetsPaginator ¶ added in v0.30.0
type ListDataSetsPaginator struct {
// contains filtered or unexported fields
}
ListDataSetsPaginator is a paginator for ListDataSets
func NewListDataSetsPaginator ¶ added in v0.30.0
func NewListDataSetsPaginator(client ListDataSetsAPIClient, params *ListDataSetsInput, optFns ...func(*ListDataSetsPaginatorOptions)) *ListDataSetsPaginator
NewListDataSetsPaginator returns a new ListDataSetsPaginator
func (*ListDataSetsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListDataSetsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListDataSetsPaginator) NextPage ¶ added in v0.30.0
func (p *ListDataSetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDataSetsOutput, error)
NextPage retrieves the next ListDataSets page.
type ListDataSetsPaginatorOptions ¶ added in v0.30.0
type ListDataSetsPaginatorOptions struct { // The maximum number of results returned by a single call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListDataSetsPaginatorOptions is the paginator options for ListDataSets
type ListJobsAPIClient ¶ added in v0.30.0
type ListJobsAPIClient interface {
ListJobs(context.Context, *ListJobsInput, ...func(*Options)) (*ListJobsOutput, error)
}
ListJobsAPIClient is a client that implements the ListJobs operation.
type ListJobsInput ¶
type ListJobsInput struct { // The unique identifier for a data set. DataSetId *string // The maximum number of results returned by a single call. MaxResults int32 // The token value retrieved from a previous call to access the next page of // results. NextToken *string // The unique identifier for a revision. RevisionId *string }
type ListJobsOutput ¶
type ListJobsOutput struct { // The jobs listed by the request. Jobs []types.JobEntry // The token value retrieved from a previous call to access the next page of // results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListJobsPaginator ¶ added in v0.30.0
type ListJobsPaginator struct {
// contains filtered or unexported fields
}
ListJobsPaginator is a paginator for ListJobs
func NewListJobsPaginator ¶ added in v0.30.0
func NewListJobsPaginator(client ListJobsAPIClient, params *ListJobsInput, optFns ...func(*ListJobsPaginatorOptions)) *ListJobsPaginator
NewListJobsPaginator returns a new ListJobsPaginator
func (*ListJobsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListJobsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListJobsPaginator) NextPage ¶ added in v0.30.0
func (p *ListJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListJobsOutput, error)
NextPage retrieves the next ListJobs page.
type ListJobsPaginatorOptions ¶ added in v0.30.0
type ListJobsPaginatorOptions struct { // The maximum number of results returned by a single call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListJobsPaginatorOptions is the paginator options for ListJobs
type ListRevisionAssetsAPIClient ¶ added in v0.30.0
type ListRevisionAssetsAPIClient interface {
ListRevisionAssets(context.Context, *ListRevisionAssetsInput, ...func(*Options)) (*ListRevisionAssetsOutput, error)
}
ListRevisionAssetsAPIClient is a client that implements the ListRevisionAssets operation.
type ListRevisionAssetsInput ¶
type ListRevisionAssetsInput struct { // The unique identifier for a data set. // // This member is required. DataSetId *string // The unique identifier for a revision. // // This member is required. RevisionId *string // The maximum number of results returned by a single call. MaxResults int32 // The token value retrieved from a previous call to access the next page of // results. NextToken *string }
type ListRevisionAssetsOutput ¶
type ListRevisionAssetsOutput struct { // The asset objects listed by the request. Assets []types.AssetEntry // The token value retrieved from a previous call to access the next page of // results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListRevisionAssetsPaginator ¶ added in v0.30.0
type ListRevisionAssetsPaginator struct {
// contains filtered or unexported fields
}
ListRevisionAssetsPaginator is a paginator for ListRevisionAssets
func NewListRevisionAssetsPaginator ¶ added in v0.30.0
func NewListRevisionAssetsPaginator(client ListRevisionAssetsAPIClient, params *ListRevisionAssetsInput, optFns ...func(*ListRevisionAssetsPaginatorOptions)) *ListRevisionAssetsPaginator
NewListRevisionAssetsPaginator returns a new ListRevisionAssetsPaginator
func (*ListRevisionAssetsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListRevisionAssetsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListRevisionAssetsPaginator) NextPage ¶ added in v0.30.0
func (p *ListRevisionAssetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRevisionAssetsOutput, error)
NextPage retrieves the next ListRevisionAssets page.
type ListRevisionAssetsPaginatorOptions ¶ added in v0.30.0
type ListRevisionAssetsPaginatorOptions struct { // The maximum number of results returned by a single call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListRevisionAssetsPaginatorOptions is the paginator options for ListRevisionAssets
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // An Amazon Resource Name (ARN) that uniquely identifies an AWS resource. // // This member is required. ResourceArn *string }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // A label that consists of a customer-defined key and an optional value. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Options ¶
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 // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The logger writer interface to write logging messages to. Logger logging.Logger // 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 ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type StartJobInput ¶
type StartJobInput struct { // The unique identifier for a job. // // This member is required. JobId *string }
type StartJobOutput ¶
type StartJobOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type TagResourceInput ¶
type TagResourceInput struct { // An Amazon Resource Name (ARN) that uniquely identifies an AWS resource. // // This member is required. ResourceArn *string // A label that consists of a customer-defined key and an optional value. // // This member is required. Tags map[string]string }
The request body for TagResource.
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UntagResourceInput ¶
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateAssetInput ¶
type UpdateAssetInput struct { // The unique identifier for an asset. // // This member is required. AssetId *string // The unique identifier for a data set. // // This member is required. DataSetId *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 a revision. // // This member is required. RevisionId *string }
The request body for UpdateAsset.
type UpdateAssetOutput ¶
type UpdateAssetOutput struct { // The ARN for the asset. Arn *string // Information about the asset, including its size. AssetDetails *types.AssetDetails // The type of file your data is stored in. Currently, the supported asset type is // S3_SNAPSHOT. AssetType types.AssetType // The date and time that the asset was created, in ISO 8601 format. CreatedAt *time.Time // The unique identifier for the data set associated with this asset. DataSetId *string // The unique identifier for the asset. 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. Name *string // The unique identifier for the revision associated with this asset. RevisionId *string // 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 date and time that the asset was last updated, in ISO 8601 format. UpdatedAt *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateDataSetInput ¶
type UpdateDataSetInput struct { // The unique identifier for a data set. // // This member is required. DataSetId *string // The description for the data set. Description *string // The name of the data set. Name *string }
The request body for UpdateDataSet.
type UpdateDataSetOutput ¶
type UpdateDataSetOutput struct { // The ARN for the data set. Arn *string // The type of file your data is stored in. Currently, the supported asset type is // S3_SNAPSHOT. AssetType types.AssetType // The date and time that the data set was created, in ISO 8601 format. CreatedAt *time.Time // The description for the data set. Description *string // The unique identifier for the data set. Id *string // The name of the data set. Name *string // A property that defines the data set as OWNED by the account (for providers) or // ENTITLED to the account (for subscribers). Origin types.Origin // If the origin of this data set is ENTITLED, includes the details for the product // on AWS Marketplace. OriginDetails *types.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 // The date and time that the data set was last updated, in ISO 8601 format. UpdatedAt *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateRevisionInput ¶
type UpdateRevisionInput struct { // The unique identifier for a data set. // // This member is required. DataSetId *string // The unique identifier for a revision. // // This member is required. RevisionId *string // An optional comment about the revision. Comment *string // 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 bool }
The request body for UpdateRevision.
type UpdateRevisionOutput ¶
type UpdateRevisionOutput struct { // The ARN for the revision. Arn *string // An optional comment about the revision. Comment *string // The date and time that the revision was created, in ISO 8601 format. CreatedAt *time.Time // The unique identifier for the data set associated with this revision. DataSetId *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 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 unique identifier for the revision. Id *string // 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 date and time that the revision was last updated, in ISO 8601 format. UpdatedAt *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Source Files ¶
- api_client.go
- api_op_CancelJob.go
- api_op_CreateDataSet.go
- api_op_CreateJob.go
- api_op_CreateRevision.go
- api_op_DeleteAsset.go
- api_op_DeleteDataSet.go
- api_op_DeleteRevision.go
- api_op_GetAsset.go
- api_op_GetDataSet.go
- api_op_GetJob.go
- api_op_GetRevision.go
- api_op_ListDataSetRevisions.go
- api_op_ListDataSets.go
- api_op_ListJobs.go
- api_op_ListRevisionAssets.go
- api_op_ListTagsForResource.go
- api_op_StartJob.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateAsset.go
- api_op_UpdateDataSet.go
- api_op_UpdateRevision.go
- deserializers.go
- doc.go
- endpoints.go
- serializers.go
- validators.go