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 Simple Storage Service (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, Redshift datashare, API Gateway API, AWS Lake Formation data permission, or Amazon S3 data access. 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
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- func WithSigV4SigningName(name string) func(*Options)
- func WithSigV4SigningRegion(region string) func(*Options)
- type AuthResolverParameters
- type AuthSchemeResolver
- 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) CreateEventAction(ctx context.Context, params *CreateEventActionInput, optFns ...func(*Options)) (*CreateEventActionOutput, 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) DeleteEventAction(ctx context.Context, params *DeleteEventActionInput, optFns ...func(*Options)) (*DeleteEventActionOutput, 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) GetEventAction(ctx context.Context, params *GetEventActionInput, optFns ...func(*Options)) (*GetEventActionOutput, 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) ListEventActions(ctx context.Context, params *ListEventActionsInput, optFns ...func(*Options)) (*ListEventActionsOutput, 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) Options() Options
- func (c *Client) RevokeRevision(ctx context.Context, params *RevokeRevisionInput, optFns ...func(*Options)) (*RevokeRevisionOutput, error)
- func (c *Client) SendApiAsset(ctx context.Context, params *SendApiAssetInput, optFns ...func(*Options)) (*SendApiAssetOutput, error)
- func (c *Client) SendDataSetNotification(ctx context.Context, params *SendDataSetNotificationInput, ...) (*SendDataSetNotificationOutput, 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) UpdateEventAction(ctx context.Context, params *UpdateEventActionInput, optFns ...func(*Options)) (*UpdateEventActionOutput, error)
- func (c *Client) UpdateRevision(ctx context.Context, params *UpdateRevisionInput, optFns ...func(*Options)) (*UpdateRevisionOutput, error)
- type CreateDataSetInput
- type CreateDataSetOutput
- type CreateEventActionInput
- type CreateEventActionOutput
- type CreateJobInput
- type CreateJobOutput
- type CreateRevisionInput
- type CreateRevisionOutput
- type DeleteAssetInput
- type DeleteAssetOutput
- type DeleteDataSetInput
- type DeleteDataSetOutput
- type DeleteEventActionInput
- type DeleteEventActionOutput
- type DeleteRevisionInput
- type DeleteRevisionOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type GetAssetInput
- type GetAssetOutput
- type GetDataSetInput
- type GetDataSetOutput
- type GetEventActionInput
- type GetEventActionOutput
- type GetJobInput
- type GetJobOutput
- type GetRevisionInput
- type GetRevisionOutput
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type ListDataSetRevisionsAPIClient
- type ListDataSetRevisionsInput
- type ListDataSetRevisionsOutput
- type ListDataSetRevisionsPaginator
- type ListDataSetRevisionsPaginatorOptions
- type ListDataSetsAPIClient
- type ListDataSetsInput
- type ListDataSetsOutput
- type ListDataSetsPaginator
- type ListDataSetsPaginatorOptions
- type ListEventActionsAPIClient
- type ListEventActionsInput
- type ListEventActionsOutput
- type ListEventActionsPaginator
- type ListEventActionsPaginatorOptions
- 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 RevokeRevisionInput
- type RevokeRevisionOutput
- type SendApiAssetInput
- type SendApiAssetOutput
- type SendDataSetNotificationInput
- type SendDataSetNotificationOutput
- type StartJobInput
- type StartJobOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateAssetInput
- type UpdateAssetOutput
- type UpdateDataSetInput
- type UpdateDataSetOutput
- type UpdateEventActionInput
- type UpdateEventActionOutput
- 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
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver
deprecated
func WithEndpointResolver(v EndpointResolver) func(*Options)
Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.
To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.
func WithEndpointResolverV2 ¶
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
func WithSigV4SigningName ¶
WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.
func WithSigV4SigningRegion ¶
WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.
Types ¶
type AuthResolverParameters ¶
type AuthResolverParameters struct { // The name of the operation being invoked. Operation string // The region in which the operation is being invoked. Region string }
AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.
type AuthSchemeResolver ¶
type AuthSchemeResolver interface {
ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}
AuthSchemeResolver returns a set of possible authentication options for an operation.
type CancelJobInput ¶
type CancelJobInput struct { // The unique identifier for a job. // // This member is required. JobId *string // contains filtered or unexported fields }
type CancelJobOutput ¶
type CancelJobOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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) CreateEventAction ¶
func (c *Client) CreateEventAction(ctx context.Context, params *CreateEventActionInput, optFns ...func(*Options)) (*CreateEventActionOutput, error)
This operation creates an event action.
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) DeleteEventAction ¶
func (c *Client) DeleteEventAction(ctx context.Context, params *DeleteEventActionInput, optFns ...func(*Options)) (*DeleteEventActionOutput, error)
This operation deletes the event action.
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) GetEventAction ¶
func (c *Client) GetEventAction(ctx context.Context, params *GetEventActionInput, optFns ...func(*Options)) (*GetEventActionOutput, error)
This operation retrieves information about an event action.
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) ListEventActions ¶
func (c *Client) ListEventActions(ctx context.Context, params *ListEventActionsInput, optFns ...func(*Options)) (*ListEventActionsOutput, error)
This operation lists your event actions.
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) Options ¶
Options returns a copy of the client configuration.
Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.
func (*Client) RevokeRevision ¶
func (c *Client) RevokeRevision(ctx context.Context, params *RevokeRevisionInput, optFns ...func(*Options)) (*RevokeRevisionOutput, error)
This operation revokes subscribers' access to a revision.
func (*Client) SendApiAsset ¶
func (c *Client) SendApiAsset(ctx context.Context, params *SendApiAssetInput, optFns ...func(*Options)) (*SendApiAssetOutput, error)
This operation invokes an API Gateway API asset. The request is proxied to the provider’s API Gateway API.
func (*Client) SendDataSetNotification ¶
func (c *Client) SendDataSetNotification(ctx context.Context, params *SendDataSetNotificationInput, optFns ...func(*Options)) (*SendDataSetNotificationOutput, error)
The type of event associated with the data set.
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) UpdateEventAction ¶
func (c *Client) UpdateEventAction(ctx context.Context, params *UpdateEventActionInput, optFns ...func(*Options)) (*UpdateEventActionOutput, error)
This operation updates the event action.
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 asset that is added to a data set. // // 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 // contains filtered or unexported fields }
type CreateDataSetOutput ¶
type CreateDataSetOutput struct { // The ARN for the data set. Arn *string // The type of asset that is added to a data set. 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 // contains filtered or unexported fields }
type CreateEventActionInput ¶
type CreateEventActionOutput ¶
type CreateEventActionOutput struct { // What occurs after a certain event. Action *types.Action // The ARN for the event action. Arn *string // The date and time that the event action was created, in ISO 8601 format. CreatedAt *time.Time // What occurs to start an action. Event *types.Event // The unique identifier for the event action. Id *string // The date and time that the event action was last updated, in ISO 8601 format. UpdatedAt *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 the data set 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 // A required comment to inform subscribers of the reason their access to the // revision was revoked. RevocationComment *string // A status indicating that subscribers' access to the revision was revoked. Revoked bool // The date and time that the revision was revoked, in ISO 8601 format. RevokedAt *time.Time // 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 // contains filtered or unexported fields }
type DeleteAssetInput ¶
type DeleteAssetInput 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 unique identifier for a revision. // // This member is required. RevisionId *string // contains filtered or unexported fields }
type DeleteAssetOutput ¶
type DeleteAssetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteDataSetInput ¶
type DeleteDataSetInput struct { // The unique identifier for a data set. // // This member is required. DataSetId *string // contains filtered or unexported fields }
type DeleteDataSetOutput ¶
type DeleteDataSetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteEventActionInput ¶
type DeleteEventActionInput struct { // The unique identifier for the event action. // // This member is required. EventActionId *string // contains filtered or unexported fields }
type DeleteEventActionOutput ¶
type DeleteEventActionOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteRevisionInput ¶
type DeleteRevisionOutput ¶
type DeleteRevisionOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointParameters ¶
type EndpointParameters struct { // The AWS region used to dispatch the request. // // Parameter is // required. // // AWS::Region Region *string // When true, use the dual-stack endpoint. If the configured endpoint does not // support dual-stack, dispatching the request MAY return an error. // // Defaults to // false if no value is provided. // // AWS::UseDualStack UseDualStack *bool // When true, send this request to the FIPS-compliant regional endpoint. If the // configured endpoint does not have a FIPS compliant endpoint, dispatching the // request will return an error. // // Defaults to false if no value is // provided. // // AWS::UseFIPS UseFIPS *bool // Override the endpoint used to send this request // // Parameter is // required. // // SDK::Endpoint Endpoint *string }
EndpointParameters provides the parameters that influence how endpoints are resolved.
func (EndpointParameters) ValidateRequired ¶
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶
func (p EndpointParameters) WithDefaults() EndpointParameters
WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
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 ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type EndpointResolverV2 ¶
type EndpointResolverV2 interface { // ResolveEndpoint attempts to resolve the endpoint with the provided options, // returning the endpoint if found. Otherwise an error is returned. ResolveEndpoint(ctx context.Context, params EndpointParameters) ( smithyendpoints.Endpoint, error, ) }
EndpointResolverV2 provides the interface for resolving service endpoints.
func NewDefaultEndpointResolverV2 ¶
func NewDefaultEndpointResolverV2() EndpointResolverV2
type GetAssetInput ¶
type GetAssetInput 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 unique identifier for a revision. // // This member is required. RevisionId *string // contains filtered or unexported fields }
type GetAssetOutput ¶
type GetAssetOutput struct { // The ARN for the asset. Arn *string // Details about the asset. AssetDetails *types.AssetDetails // The type of asset that is added to a data set. 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 Amazon S3 object key // is used as the asset name. When exporting to Amazon S3, the asset name is used // as default target Amazon S3 object key. When importing from Amazon API Gateway // API, the API name is used as the asset name. When importing from Amazon // Redshift, the datashare name is used as the asset name. When importing from AWS // Lake Formation, the static values of "Database(s) included in the LF-tag policy" // or "Table(s) included in the LF-tag policy" are used as the asset name. 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 // contains filtered or unexported fields }
type GetDataSetInput ¶
type GetDataSetInput struct { // The unique identifier for a data set. // // This member is required. DataSetId *string // contains filtered or unexported fields }
type GetDataSetOutput ¶
type GetDataSetOutput struct { // The ARN for the data set. Arn *string // The type of asset that is added to a data set. 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 // contains filtered or unexported fields }
type GetEventActionInput ¶
type GetEventActionInput struct { // The unique identifier for the event action. // // This member is required. EventActionId *string // contains filtered or unexported fields }
type GetEventActionOutput ¶
type GetEventActionOutput struct { // What occurs after a certain event. Action *types.Action // The ARN for the event action. Arn *string // The date and time that the event action was created, in ISO 8601 format. CreatedAt *time.Time // What occurs to start an action. Event *types.Event // The unique identifier for the event action. Id *string // The date and time that the event action was last updated, in ISO 8601 format. UpdatedAt *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetJobInput ¶
type GetJobInput struct { // The unique identifier for a job. // // This member is required. JobId *string // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 the data set 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 // A required comment to inform subscribers of the reason their access to the // revision was revoked. RevocationComment *string // A status indicating that subscribers' access to the revision was revoked. Revoked bool // The date and time that the revision was revoked, in ISO 8601 format. RevokedAt *time.Time // 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 // contains filtered or unexported fields }
type HTTPSignerV4 ¶
type IdempotencyTokenProvider ¶
IdempotencyTokenProvider interface for providing idempotency token
type ListDataSetRevisionsAPIClient ¶
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type ListDataSetRevisionsPaginator ¶
type ListDataSetRevisionsPaginator struct {
// contains filtered or unexported fields
}
ListDataSetRevisionsPaginator is a paginator for ListDataSetRevisions
func NewListDataSetRevisionsPaginator ¶
func NewListDataSetRevisionsPaginator(client ListDataSetRevisionsAPIClient, params *ListDataSetRevisionsInput, optFns ...func(*ListDataSetRevisionsPaginatorOptions)) *ListDataSetRevisionsPaginator
NewListDataSetRevisionsPaginator returns a new ListDataSetRevisionsPaginator
func (*ListDataSetRevisionsPaginator) HasMorePages ¶
func (p *ListDataSetRevisionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListDataSetRevisionsPaginator) NextPage ¶
func (p *ListDataSetRevisionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDataSetRevisionsOutput, error)
NextPage retrieves the next ListDataSetRevisions page.
type ListDataSetRevisionsPaginatorOptions ¶
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 ¶
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type ListDataSetsPaginator ¶
type ListDataSetsPaginator struct {
// contains filtered or unexported fields
}
ListDataSetsPaginator is a paginator for ListDataSets
func NewListDataSetsPaginator ¶
func NewListDataSetsPaginator(client ListDataSetsAPIClient, params *ListDataSetsInput, optFns ...func(*ListDataSetsPaginatorOptions)) *ListDataSetsPaginator
NewListDataSetsPaginator returns a new ListDataSetsPaginator
func (*ListDataSetsPaginator) HasMorePages ¶
func (p *ListDataSetsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListDataSetsPaginator) NextPage ¶
func (p *ListDataSetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDataSetsOutput, error)
NextPage retrieves the next ListDataSets page.
type ListDataSetsPaginatorOptions ¶
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 ListEventActionsAPIClient ¶
type ListEventActionsAPIClient interface {
ListEventActions(context.Context, *ListEventActionsInput, ...func(*Options)) (*ListEventActionsOutput, error)
}
ListEventActionsAPIClient is a client that implements the ListEventActions operation.
type ListEventActionsInput ¶
type ListEventActionsInput struct { // The unique identifier for the event source. EventSourceId *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 // contains filtered or unexported fields }
type ListEventActionsOutput ¶
type ListEventActionsOutput struct { // The event action objects listed by the request. EventActions []types.EventActionEntry // 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 // contains filtered or unexported fields }
type ListEventActionsPaginator ¶
type ListEventActionsPaginator struct {
// contains filtered or unexported fields
}
ListEventActionsPaginator is a paginator for ListEventActions
func NewListEventActionsPaginator ¶
func NewListEventActionsPaginator(client ListEventActionsAPIClient, params *ListEventActionsInput, optFns ...func(*ListEventActionsPaginatorOptions)) *ListEventActionsPaginator
NewListEventActionsPaginator returns a new ListEventActionsPaginator
func (*ListEventActionsPaginator) HasMorePages ¶
func (p *ListEventActionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListEventActionsPaginator) NextPage ¶
func (p *ListEventActionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEventActionsOutput, error)
NextPage retrieves the next ListEventActions page.
type ListEventActionsPaginatorOptions ¶
type ListEventActionsPaginatorOptions 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 }
ListEventActionsPaginatorOptions is the paginator options for ListEventActions
type ListJobsAPIClient ¶
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type ListJobsPaginator ¶
type ListJobsPaginator struct {
// contains filtered or unexported fields
}
ListJobsPaginator is a paginator for ListJobs
func NewListJobsPaginator ¶
func NewListJobsPaginator(client ListJobsAPIClient, params *ListJobsInput, optFns ...func(*ListJobsPaginatorOptions)) *ListJobsPaginator
NewListJobsPaginator returns a new ListJobsPaginator
func (*ListJobsPaginator) HasMorePages ¶
func (p *ListJobsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListJobsPaginator) NextPage ¶
func (p *ListJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListJobsOutput, error)
NextPage retrieves the next ListJobs page.
type ListJobsPaginatorOptions ¶
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 ¶
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type ListRevisionAssetsPaginator ¶
type ListRevisionAssetsPaginator struct {
// contains filtered or unexported fields
}
ListRevisionAssetsPaginator is a paginator for ListRevisionAssets
func NewListRevisionAssetsPaginator ¶
func NewListRevisionAssetsPaginator(client ListRevisionAssetsAPIClient, params *ListRevisionAssetsInput, optFns ...func(*ListRevisionAssetsPaginatorOptions)) *ListRevisionAssetsPaginator
NewListRevisionAssetsPaginator returns a new ListRevisionAssetsPaginator
func (*ListRevisionAssetsPaginator) HasMorePages ¶
func (p *ListRevisionAssetsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListRevisionAssetsPaginator) NextPage ¶
func (p *ListRevisionAssetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRevisionAssetsOutput, error)
NextPage retrieves the next ListRevisionAssets page.
type ListRevisionAssetsPaginatorOptions ¶
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 // The optional application specific identifier appended to the User-Agent header. AppID string // This endpoint will be given as input to an EndpointResolverV2. It is used for // providing a custom base endpoint that is subject to modifications by the // processing EndpointResolverV2. BaseEndpoint *string // 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 configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. // // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and // BaseEndpoint. // // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be // used over the deprecated EndpointResolver. EndpointResolverV2 EndpointResolverV2 // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // Provides idempotency tokens values that will be automatically populated into // idempotent API operations. IdempotencyTokenProvider IdempotencyTokenProvider // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. // // If specified in an operation call's functional options with a value that is // different than the constructed client's Options, the Client's Retryer will be // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. // // When creating a new API Clients this member will only be used if the Retryer // Options member is nil. This value will be ignored if Retryer is not nil. // // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // The auth scheme resolver which determines how to authenticate for each // operation. AuthSchemeResolver AuthSchemeResolver // The list of auth schemes supported by the client. AuthSchemes []smithyhttp.AuthScheme // contains filtered or unexported fields }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
func (Options) GetIdentityResolver ¶
func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver
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 RevokeRevisionInput ¶
type RevokeRevisionInput 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 // A required comment to inform subscribers of the reason their access to the // revision was revoked. // // This member is required. RevocationComment *string // contains filtered or unexported fields }
type RevokeRevisionOutput ¶
type RevokeRevisionOutput 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 the data set 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 // A required comment to inform subscribers of the reason their access to the // revision was revoked. RevocationComment *string // A status indicating that subscribers' access to the revision was revoked. Revoked bool // The date and time that the revision was revoked, in ISO 8601 format. RevokedAt *time.Time // 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 // contains filtered or unexported fields }
type SendApiAssetInput ¶
type SendApiAssetInput struct { // Asset ID value for the API request. // // This member is required. AssetId *string // Data set ID value for the API request. // // This member is required. DataSetId *string // Revision ID value for the API request. // // This member is required. RevisionId *string // The request body. Body *string // HTTP method value for the API request. Alternatively, you can use the // appropriate verb in your request. Method *string // URI path value for the API request. Alternatively, you can set the URI path // directly by invoking /v1/{pathValue}. Path *string // Attach query string parameters to the end of the URI (for example, // /v1/examplePath?exampleParam=exampleValue). QueryStringParameters map[string]string // Any header value prefixed with x-amzn-dataexchange-header- will have that // stripped before sending the Asset API request. Use this when you want to // override a header that AWS Data Exchange uses. Alternatively, you can use the // header without a prefix to the HTTP request. RequestHeaders map[string]string // contains filtered or unexported fields }
type SendApiAssetOutput ¶
type SendApiAssetOutput struct { // The response body from the underlying API tracked by the API asset. Body *string // The response headers from the underlying API tracked by the API asset. // // Map keys will be normalized to lower-case. ResponseHeaders map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type SendDataSetNotificationInput ¶
type SendDataSetNotificationInput struct { // Affected data set of the notification. // // This member is required. DataSetId *string // The type of the notification. Describing the kind of event the notification is // alerting you to. // // This member is required. Type types.NotificationType // Idempotency key for the notification, this key allows us to deduplicate // notifications that are sent in quick succession erroneously. ClientToken *string // Free-form text field for providers to add information about their notifications. Comment *string // Extra details specific to this notification type. Details *types.NotificationDetails // Affected scope of this notification such as the underlying resources affected // by the notification event. Scope *types.ScopeDetails // contains filtered or unexported fields }
type SendDataSetNotificationOutput ¶
type SendDataSetNotificationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StartJobInput ¶
type StartJobInput struct { // The unique identifier for a job. // // This member is required. JobId *string // contains filtered or unexported fields }
type StartJobOutput ¶
type StartJobOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UntagResourceInput ¶
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 Amazon S3 object key // is used as the asset name. When exporting to Amazon S3, the asset name is used // as default target Amazon S3 object key. When importing from Amazon API Gateway // API, the API name is used as the asset name. When importing from Amazon // Redshift, the datashare name is used as the asset name. When importing from AWS // Lake Formation, the static values of "Database(s) included in the LF-tag policy" // or "Table(s) included in LF-tag policy" are used as the name. // // This member is required. Name *string // The unique identifier for a revision. // // This member is required. RevisionId *string // contains filtered or unexported fields }
type UpdateAssetOutput ¶
type UpdateAssetOutput struct { // The ARN for the asset. Arn *string // Details about the asset. AssetDetails *types.AssetDetails // The type of asset that is added to a data set. 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 Amazon S3 object key // is used as the asset name. When exporting to Amazon S3, the asset name is used // as default target Amazon S3 object key. When importing from Amazon API Gateway // API, the API name is used as the asset name. When importing from Amazon // Redshift, the datashare name is used as the asset name. When importing from AWS // Lake Formation, the static values of "Database(s) included in the LF-tag // policy"- or "Table(s) included in LF-tag policy" are used as the asset name. 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 // contains filtered or unexported fields }
type UpdateDataSetInput ¶
type UpdateDataSetOutput ¶
type UpdateDataSetOutput struct { // The ARN for the data set. Arn *string // The type of asset that is added to a data set. 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 // contains filtered or unexported fields }
type UpdateEventActionInput ¶
type UpdateEventActionOutput ¶
type UpdateEventActionOutput struct { // What occurs after a certain event. Action *types.Action // The ARN for the event action. Arn *string // The date and time that the event action was created, in ISO 8601 format. CreatedAt *time.Time // What occurs to start an action. Event *types.Event // The unique identifier for the event action. Id *string // The date and time that the event action was last updated, in ISO 8601 format. UpdatedAt *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 the data set 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 // A required comment to inform subscribers of the reason their access to the // revision was revoked. RevocationComment *string // A status indicating that subscribers' access to the revision was revoked. Revoked bool // The date and time that the revision was revoked, in ISO 8601 format. RevokedAt *time.Time // 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 // contains filtered or unexported fields }
Source Files
¶
- api_client.go
- api_op_CancelJob.go
- api_op_CreateDataSet.go
- api_op_CreateEventAction.go
- api_op_CreateJob.go
- api_op_CreateRevision.go
- api_op_DeleteAsset.go
- api_op_DeleteDataSet.go
- api_op_DeleteEventAction.go
- api_op_DeleteRevision.go
- api_op_GetAsset.go
- api_op_GetDataSet.go
- api_op_GetEventAction.go
- api_op_GetJob.go
- api_op_GetRevision.go
- api_op_ListDataSetRevisions.go
- api_op_ListDataSets.go
- api_op_ListEventActions.go
- api_op_ListJobs.go
- api_op_ListRevisionAssets.go
- api_op_ListTagsForResource.go
- api_op_RevokeRevision.go
- api_op_SendApiAsset.go
- api_op_SendDataSetNotification.go
- api_op_StartJob.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateAsset.go
- api_op_UpdateDataSet.go
- api_op_UpdateEventAction.go
- api_op_UpdateRevision.go
- auth.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- options.go
- serializers.go
- validators.go