libZSservicesZSamazonka-dataexchangeZSamazonka-dataexchange
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DataExchange.Lens

Description

 
Synopsis

Operations

GetEventAction

getEventAction_eventActionId :: Lens' GetEventAction Text Source #

The unique identifier for the event action.

getEventActionResponse_createdAt :: Lens' GetEventActionResponse (Maybe UTCTime) Source #

The date and time that the event action was created, in ISO 8601 format.

getEventActionResponse_id :: Lens' GetEventActionResponse (Maybe Text) Source #

The unique identifier for the event action.

getEventActionResponse_updatedAt :: Lens' GetEventActionResponse (Maybe UTCTime) Source #

The date and time that the event action was last updated, in ISO 8601 format.

CreateRevision

createRevision_comment :: Lens' CreateRevision (Maybe Text) Source #

An optional comment about the revision.

createRevision_tags :: Lens' CreateRevision (Maybe (HashMap Text Text)) Source #

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.

createRevision_dataSetId :: Lens' CreateRevision Text Source #

The unique identifier for a data set.

createRevisionResponse_createdAt :: Lens' CreateRevisionResponse (Maybe UTCTime) Source #

The date and time that the revision was created, in ISO 8601 format.

createRevisionResponse_sourceId :: Lens' CreateRevisionResponse (Maybe Text) Source #

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.

createRevisionResponse_finalized :: Lens' CreateRevisionResponse (Maybe Bool) Source #

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.

createRevisionResponse_dataSetId :: Lens' CreateRevisionResponse (Maybe Text) Source #

The unique identifier for the data set associated with this revision.

createRevisionResponse_id :: Lens' CreateRevisionResponse (Maybe Text) Source #

The unique identifier for the revision.

createRevisionResponse_updatedAt :: Lens' CreateRevisionResponse (Maybe UTCTime) Source #

The date and time that the revision was last updated, in ISO 8601 format.

createRevisionResponse_comment :: Lens' CreateRevisionResponse (Maybe Text) Source #

An optional comment about the revision.

ListRevisionAssets

listRevisionAssets_nextToken :: Lens' ListRevisionAssets (Maybe Text) Source #

The token value retrieved from a previous call to access the next page of results.

listRevisionAssets_maxResults :: Lens' ListRevisionAssets (Maybe Natural) Source #

The maximum number of results returned by a single call.

listRevisionAssets_revisionId :: Lens' ListRevisionAssets Text Source #

The unique identifier for a revision.

listRevisionAssets_dataSetId :: Lens' ListRevisionAssets Text Source #

The unique identifier for a data set.

listRevisionAssetsResponse_nextToken :: Lens' ListRevisionAssetsResponse (Maybe Text) Source #

The token value retrieved from a previous call to access the next page of results.

DeleteRevision

deleteRevision_revisionId :: Lens' DeleteRevision Text Source #

The unique identifier for a revision.

deleteRevision_dataSetId :: Lens' DeleteRevision Text Source #

The unique identifier for a data set.

UpdateRevision

updateRevision_finalized :: Lens' UpdateRevision (Maybe Bool) Source #

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.

updateRevision_comment :: Lens' UpdateRevision (Maybe Text) Source #

An optional comment about the revision.

updateRevision_revisionId :: Lens' UpdateRevision Text Source #

The unique identifier for a revision.

updateRevision_dataSetId :: Lens' UpdateRevision Text Source #

The unique identifier for a data set.

updateRevisionResponse_createdAt :: Lens' UpdateRevisionResponse (Maybe UTCTime) Source #

The date and time that the revision was created, in ISO 8601 format.

updateRevisionResponse_sourceId :: Lens' UpdateRevisionResponse (Maybe Text) Source #

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.

updateRevisionResponse_finalized :: Lens' UpdateRevisionResponse (Maybe Bool) Source #

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.

updateRevisionResponse_dataSetId :: Lens' UpdateRevisionResponse (Maybe Text) Source #

The unique identifier for the data set associated with this revision.

updateRevisionResponse_id :: Lens' UpdateRevisionResponse (Maybe Text) Source #

The unique identifier for the revision.

updateRevisionResponse_updatedAt :: Lens' UpdateRevisionResponse (Maybe UTCTime) Source #

The date and time that the revision was last updated, in ISO 8601 format.

updateRevisionResponse_comment :: Lens' UpdateRevisionResponse (Maybe Text) Source #

An optional comment about the revision.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

A label that consists of a customer-defined key and an optional value.

GetRevision

getRevision_revisionId :: Lens' GetRevision Text Source #

The unique identifier for a revision.

getRevision_dataSetId :: Lens' GetRevision Text Source #

The unique identifier for a data set.

getRevisionResponse_createdAt :: Lens' GetRevisionResponse (Maybe UTCTime) Source #

The date and time that the revision was created, in ISO 8601 format.

getRevisionResponse_sourceId :: Lens' GetRevisionResponse (Maybe Text) Source #

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.

getRevisionResponse_finalized :: Lens' GetRevisionResponse (Maybe Bool) Source #

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.

getRevisionResponse_dataSetId :: Lens' GetRevisionResponse (Maybe Text) Source #

The unique identifier for the data set associated with this revision.

getRevisionResponse_id :: Lens' GetRevisionResponse (Maybe Text) Source #

The unique identifier for the revision.

getRevisionResponse_updatedAt :: Lens' GetRevisionResponse (Maybe UTCTime) Source #

The date and time that the revision was last updated, in ISO 8601 format.

getRevisionResponse_comment :: Lens' GetRevisionResponse (Maybe Text) Source #

An optional comment about the revision.

DeleteDataSet

deleteDataSet_dataSetId :: Lens' DeleteDataSet Text Source #

The unique identifier for a data set.

UpdateDataSet

updateDataSet_name :: Lens' UpdateDataSet (Maybe Text) Source #

The name of the data set.

updateDataSet_description :: Lens' UpdateDataSet (Maybe Text) Source #

The description for the data set.

updateDataSet_dataSetId :: Lens' UpdateDataSet Text Source #

The unique identifier for a data set.

updateDataSetResponse_origin :: Lens' UpdateDataSetResponse (Maybe Origin) Source #

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

updateDataSetResponse_createdAt :: Lens' UpdateDataSetResponse (Maybe UTCTime) Source #

The date and time that the data set was created, in ISO 8601 format.

updateDataSetResponse_sourceId :: Lens' UpdateDataSetResponse (Maybe Text) Source #

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.

updateDataSetResponse_originDetails :: Lens' UpdateDataSetResponse (Maybe OriginDetails) Source #

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

updateDataSetResponse_id :: Lens' UpdateDataSetResponse (Maybe Text) Source #

The unique identifier for the data set.

updateDataSetResponse_assetType :: Lens' UpdateDataSetResponse (Maybe AssetType) Source #

The type of asset that is added to a data set.

updateDataSetResponse_updatedAt :: Lens' UpdateDataSetResponse (Maybe UTCTime) Source #

The date and time that the data set was last updated, in ISO 8601 format.

CreateJob

createJob_type :: Lens' CreateJob Type Source #

The type of job to be created.

createJob_details :: Lens' CreateJob RequestDetails Source #

The details for the CreateJob request.

createJobResponse_createdAt :: Lens' CreateJobResponse (Maybe UTCTime) Source #

The date and time that the job was created, in ISO 8601 format.

createJobResponse_id :: Lens' CreateJobResponse (Maybe Text) Source #

The unique identifier for the job.

createJobResponse_updatedAt :: Lens' CreateJobResponse (Maybe UTCTime) Source #

The date and time that the job was last updated, in ISO 8601 format.

createJobResponse_errors :: Lens' CreateJobResponse (Maybe [JobError]) Source #

The errors associated with jobs.

createJobResponse_httpStatus :: Lens' CreateJobResponse Int Source #

The response's http status code.

ListEventActions

listEventActions_eventSourceId :: Lens' ListEventActions (Maybe Text) Source #

The unique identifier for the event source.

listEventActions_nextToken :: Lens' ListEventActions (Maybe Text) Source #

The token value retrieved from a previous call to access the next page of results.

listEventActions_maxResults :: Lens' ListEventActions (Maybe Natural) Source #

The maximum number of results returned by a single call.

listEventActionsResponse_nextToken :: Lens' ListEventActionsResponse (Maybe Text) Source #

The token value retrieved from a previous call to access the next page of results.

GetAsset

getAsset_revisionId :: Lens' GetAsset Text Source #

The unique identifier for a revision.

getAsset_assetId :: Lens' GetAsset Text Source #

The unique identifier for an asset.

getAsset_dataSetId :: Lens' GetAsset Text Source #

The unique identifier for a data set.

getAssetResponse_createdAt :: Lens' GetAssetResponse (Maybe UTCTime) Source #

The date and time that the asset was created, in ISO 8601 format.

getAssetResponse_sourceId :: Lens' GetAssetResponse (Maybe Text) Source #

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.

getAssetResponse_dataSetId :: Lens' GetAssetResponse (Maybe Text) Source #

The unique identifier for the data set associated with this asset.

getAssetResponse_name :: Lens' GetAssetResponse (Maybe Text) Source #

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.

getAssetResponse_id :: Lens' GetAssetResponse (Maybe Text) Source #

The unique identifier for the asset.

getAssetResponse_assetType :: Lens' GetAssetResponse (Maybe AssetType) Source #

The type of asset that is added to a data set.

getAssetResponse_updatedAt :: Lens' GetAssetResponse (Maybe UTCTime) Source #

The date and time that the asset was last updated, in ISO 8601 format.

getAssetResponse_revisionId :: Lens' GetAssetResponse (Maybe Text) Source #

The unique identifier for the revision associated with this asset.

getAssetResponse_httpStatus :: Lens' GetAssetResponse Int Source #

The response's http status code.

ListJobs

listJobs_nextToken :: Lens' ListJobs (Maybe Text) Source #

The token value retrieved from a previous call to access the next page of results.

listJobs_dataSetId :: Lens' ListJobs (Maybe Text) Source #

The unique identifier for a data set.

listJobs_maxResults :: Lens' ListJobs (Maybe Natural) Source #

The maximum number of results returned by a single call.

listJobs_revisionId :: Lens' ListJobs (Maybe Text) Source #

The unique identifier for a revision.

listJobsResponse_nextToken :: Lens' ListJobsResponse (Maybe Text) Source #

The token value retrieved from a previous call to access the next page of results.

listJobsResponse_jobs :: Lens' ListJobsResponse (Maybe [JobEntry]) Source #

The jobs listed by the request.

listJobsResponse_httpStatus :: Lens' ListJobsResponse Int Source #

The response's http status code.

CreateDataSet

createDataSet_tags :: Lens' CreateDataSet (Maybe (HashMap Text Text)) Source #

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.

createDataSet_assetType :: Lens' CreateDataSet AssetType Source #

The type of asset that is added to a data set.

createDataSet_description :: Lens' CreateDataSet Text Source #

A description for the data set. This value can be up to 16,348 characters long.

createDataSet_name :: Lens' CreateDataSet Text Source #

The name of the data set.

createDataSetResponse_origin :: Lens' CreateDataSetResponse (Maybe Origin) Source #

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

createDataSetResponse_createdAt :: Lens' CreateDataSetResponse (Maybe UTCTime) Source #

The date and time that the data set was created, in ISO 8601 format.

createDataSetResponse_sourceId :: Lens' CreateDataSetResponse (Maybe Text) Source #

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.

createDataSetResponse_originDetails :: Lens' CreateDataSetResponse (Maybe OriginDetails) Source #

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

createDataSetResponse_id :: Lens' CreateDataSetResponse (Maybe Text) Source #

The unique identifier for the data set.

createDataSetResponse_assetType :: Lens' CreateDataSetResponse (Maybe AssetType) Source #

The type of asset that is added to a data set.

createDataSetResponse_updatedAt :: Lens' CreateDataSetResponse (Maybe UTCTime) Source #

The date and time that the data set was last updated, in ISO 8601 format.

DeleteAsset

deleteAsset_revisionId :: Lens' DeleteAsset Text Source #

The unique identifier for a revision.

deleteAsset_assetId :: Lens' DeleteAsset Text Source #

The unique identifier for an asset.

deleteAsset_dataSetId :: Lens' DeleteAsset Text Source #

The unique identifier for a data set.

UpdateAsset

updateAsset_revisionId :: Lens' UpdateAsset Text Source #

The unique identifier for a revision.

updateAsset_assetId :: Lens' UpdateAsset Text Source #

The unique identifier for an asset.

updateAsset_dataSetId :: Lens' UpdateAsset Text Source #

The unique identifier for a data set.

updateAsset_name :: Lens' UpdateAsset Text Source #

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.

updateAssetResponse_createdAt :: Lens' UpdateAssetResponse (Maybe UTCTime) Source #

The date and time that the asset was created, in ISO 8601 format.

updateAssetResponse_sourceId :: Lens' UpdateAssetResponse (Maybe Text) Source #

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.

updateAssetResponse_dataSetId :: Lens' UpdateAssetResponse (Maybe Text) Source #

The unique identifier for the data set associated with this asset.

updateAssetResponse_name :: Lens' UpdateAssetResponse (Maybe Text) Source #

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.

updateAssetResponse_id :: Lens' UpdateAssetResponse (Maybe Text) Source #

The unique identifier for the asset.

updateAssetResponse_assetType :: Lens' UpdateAssetResponse (Maybe AssetType) Source #

The type of asset that is added to a data set.

updateAssetResponse_updatedAt :: Lens' UpdateAssetResponse (Maybe UTCTime) Source #

The date and time that the asset was last updated, in ISO 8601 format.

updateAssetResponse_revisionId :: Lens' UpdateAssetResponse (Maybe Text) Source #

The unique identifier for the revision associated with this asset.

GetJob

getJob_jobId :: Lens' GetJob Text Source #

The unique identifier for a job.

getJobResponse_createdAt :: Lens' GetJobResponse (Maybe UTCTime) Source #

The date and time that the job was created, in ISO 8601 format.

getJobResponse_id :: Lens' GetJobResponse (Maybe Text) Source #

The unique identifier for the job.

getJobResponse_updatedAt :: Lens' GetJobResponse (Maybe UTCTime) Source #

The date and time that the job was last updated, in ISO 8601 format.

getJobResponse_errors :: Lens' GetJobResponse (Maybe [JobError]) Source #

The errors associated with jobs.

getJobResponse_httpStatus :: Lens' GetJobResponse Int Source #

The response's http status code.

GetDataSet

getDataSet_dataSetId :: Lens' GetDataSet Text Source #

The unique identifier for a data set.

getDataSetResponse_origin :: Lens' GetDataSetResponse (Maybe Origin) Source #

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

getDataSetResponse_createdAt :: Lens' GetDataSetResponse (Maybe UTCTime) Source #

The date and time that the data set was created, in ISO 8601 format.

getDataSetResponse_sourceId :: Lens' GetDataSetResponse (Maybe Text) Source #

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.

getDataSetResponse_originDetails :: Lens' GetDataSetResponse (Maybe OriginDetails) Source #

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

getDataSetResponse_id :: Lens' GetDataSetResponse (Maybe Text) Source #

The unique identifier for the data set.

getDataSetResponse_assetType :: Lens' GetDataSetResponse (Maybe AssetType) Source #

The type of asset that is added to a data set.

getDataSetResponse_updatedAt :: Lens' GetDataSetResponse (Maybe UTCTime) Source #

The date and time that the data set was last updated, in ISO 8601 format.

StartJob

startJob_jobId :: Lens' StartJob Text Source #

The unique identifier for a job.

startJobResponse_httpStatus :: Lens' StartJobResponse Int Source #

The response's http status code.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

A label that consists of a customer-defined key and an optional value.

ListDataSetRevisions

listDataSetRevisions_nextToken :: Lens' ListDataSetRevisions (Maybe Text) Source #

The token value retrieved from a previous call to access the next page of results.

listDataSetRevisions_maxResults :: Lens' ListDataSetRevisions (Maybe Natural) Source #

The maximum number of results returned by a single call.

listDataSetRevisions_dataSetId :: Lens' ListDataSetRevisions Text Source #

The unique identifier for a data set.

listDataSetRevisionsResponse_nextToken :: Lens' ListDataSetRevisionsResponse (Maybe Text) Source #

The token value retrieved from a previous call to access the next page of results.

DeleteEventAction

deleteEventAction_eventActionId :: Lens' DeleteEventAction Text Source #

The unique identifier for the event action.

UpdateEventAction

updateEventAction_action :: Lens' UpdateEventAction (Maybe Action) Source #

What occurs after a certain event.

updateEventAction_eventActionId :: Lens' UpdateEventAction Text Source #

The unique identifier for the event action.

updateEventActionResponse_createdAt :: Lens' UpdateEventActionResponse (Maybe UTCTime) Source #

The date and time that the event action was created, in ISO 8601 format.

updateEventActionResponse_id :: Lens' UpdateEventActionResponse (Maybe Text) Source #

The unique identifier for the event action.

updateEventActionResponse_updatedAt :: Lens' UpdateEventActionResponse (Maybe UTCTime) Source #

The date and time that the event action was last updated, in ISO 8601 format.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.

ListDataSets

listDataSets_origin :: Lens' ListDataSets (Maybe Text) Source #

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

listDataSets_nextToken :: Lens' ListDataSets (Maybe Text) Source #

The token value retrieved from a previous call to access the next page of results.

listDataSets_maxResults :: Lens' ListDataSets (Maybe Natural) Source #

The maximum number of results returned by a single call.

listDataSetsResponse_nextToken :: Lens' ListDataSetsResponse (Maybe Text) Source #

The token value retrieved from a previous call to access the next page of results.

listDataSetsResponse_dataSets :: Lens' ListDataSetsResponse (Maybe [DataSetEntry]) Source #

The data set objects listed by the request.

CreateEventAction

createEventAction_action :: Lens' CreateEventAction Action Source #

What occurs after a certain event.

createEventAction_event :: Lens' CreateEventAction Event Source #

What occurs to start an action.

createEventActionResponse_createdAt :: Lens' CreateEventActionResponse (Maybe UTCTime) Source #

The date and time that the event action was created, in ISO 8601 format.

createEventActionResponse_id :: Lens' CreateEventActionResponse (Maybe Text) Source #

The unique identifier for the event action.

createEventActionResponse_updatedAt :: Lens' CreateEventActionResponse (Maybe UTCTime) Source #

The date and time that the event action was last updated, in ISO 8601 format.

CancelJob

cancelJob_jobId :: Lens' CancelJob Text Source #

The unique identifier for a job.

Types

Action

action_exportRevisionToS3 :: Lens' Action (Maybe AutoExportRevisionToS3RequestDetails) Source #

Details for the export revision to Amazon S3 action.

AssetDestinationEntry

assetDestinationEntry_key :: Lens' AssetDestinationEntry (Maybe Text) Source #

The name of the object in Amazon S3 for the asset.

assetDestinationEntry_bucket :: Lens' AssetDestinationEntry Text Source #

The S3 bucket that is the destination for the asset.

assetDestinationEntry_assetId :: Lens' AssetDestinationEntry Text Source #

The unique identifier for the asset.

AssetDetails

assetDetails_redshiftDataShareAsset :: Lens' AssetDetails (Maybe RedshiftDataShareAsset) Source #

The Amazon Redshift datashare that is the asset.

AssetEntry

assetEntry_sourceId :: Lens' AssetEntry (Maybe Text) Source #

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.

assetEntry_assetType :: Lens' AssetEntry AssetType Source #

The type of asset that is added to a data set.

assetEntry_createdAt :: Lens' AssetEntry UTCTime Source #

The date and time that the asset was created, in ISO 8601 format.

assetEntry_dataSetId :: Lens' AssetEntry Text Source #

The unique identifier for the data set associated with this asset.

assetEntry_id :: Lens' AssetEntry Text Source #

The unique identifier for the asset.

assetEntry_arn :: Lens' AssetEntry Text Source #

The ARN for the asset.

assetEntry_updatedAt :: Lens' AssetEntry UTCTime Source #

The date and time that the asset was last updated, in ISO 8601 format.

assetEntry_revisionId :: Lens' AssetEntry Text Source #

The unique identifier for the revision associated with this asset.

assetEntry_name :: Lens' AssetEntry Text Source #

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.

AssetSourceEntry

assetSourceEntry_bucket :: Lens' AssetSourceEntry Text Source #

The S3 bucket that's part of the source of the asset.

assetSourceEntry_key :: Lens' AssetSourceEntry Text Source #

The name of the object in Amazon S3 for the asset.

AutoExportRevisionDestinationEntry

autoExportRevisionDestinationEntry_keyPattern :: Lens' AutoExportRevisionDestinationEntry (Maybe Text) Source #

A string representing the pattern for generated names of the individual assets in the revision. For more information about key patterns, see Key patterns when exporting revisions.

autoExportRevisionDestinationEntry_bucket :: Lens' AutoExportRevisionDestinationEntry Text Source #

The S3 bucket that is the destination for the event action.

AutoExportRevisionToS3RequestDetails

autoExportRevisionToS3RequestDetails_revisionDestination :: Lens' AutoExportRevisionToS3RequestDetails AutoExportRevisionDestinationEntry Source #

A revision destination is the Amazon S3 bucket folder destination to where the export will be sent.

DataSetEntry

dataSetEntry_sourceId :: Lens' DataSetEntry (Maybe Text) Source #

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.

dataSetEntry_originDetails :: Lens' DataSetEntry (Maybe OriginDetails) Source #

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

dataSetEntry_origin :: Lens' DataSetEntry Origin Source #

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

dataSetEntry_assetType :: Lens' DataSetEntry AssetType Source #

The type of asset that is added to a data set.

dataSetEntry_description :: Lens' DataSetEntry Text Source #

The description for the data set.

dataSetEntry_createdAt :: Lens' DataSetEntry UTCTime Source #

The date and time that the data set was created, in ISO 8601 format.

dataSetEntry_id :: Lens' DataSetEntry Text Source #

The unique identifier for the data set.

dataSetEntry_arn :: Lens' DataSetEntry Text Source #

The ARN for the data set.

dataSetEntry_updatedAt :: Lens' DataSetEntry UTCTime Source #

The date and time that the data set was last updated, in ISO 8601 format.

dataSetEntry_name :: Lens' DataSetEntry Text Source #

The name of the data set.

Details

Event

event_revisionPublished :: Lens' Event (Maybe RevisionPublished) Source #

What occurs to start the revision publish action.

EventActionEntry

eventActionEntry_action :: Lens' EventActionEntry Action Source #

What occurs after a certain event.

eventActionEntry_createdAt :: Lens' EventActionEntry UTCTime Source #

The date and time that the event action was created, in ISO 8601 format.

eventActionEntry_event :: Lens' EventActionEntry Event Source #

What occurs to start an action.

eventActionEntry_id :: Lens' EventActionEntry Text Source #

The unique identifier for the event action.

eventActionEntry_arn :: Lens' EventActionEntry Text Source #

The Amazon Resource Name (ARN) for the event action.

eventActionEntry_updatedAt :: Lens' EventActionEntry UTCTime Source #

The date and time that the event action was last updated, in ISO 8601 format.

ExportAssetToSignedUrlRequestDetails

exportAssetToSignedUrlRequestDetails_dataSetId :: Lens' ExportAssetToSignedUrlRequestDetails Text Source #

The unique identifier for the data set associated with this export job.

exportAssetToSignedUrlRequestDetails_assetId :: Lens' ExportAssetToSignedUrlRequestDetails Text Source #

The unique identifier for the asset that is exported to a signed URL.

exportAssetToSignedUrlRequestDetails_revisionId :: Lens' ExportAssetToSignedUrlRequestDetails Text Source #

The unique identifier for the revision associated with this export request.

ExportAssetToSignedUrlResponseDetails

exportAssetToSignedUrlResponseDetails_dataSetId :: Lens' ExportAssetToSignedUrlResponseDetails Text Source #

The unique identifier for the data set associated with this export job.

exportAssetToSignedUrlResponseDetails_assetId :: Lens' ExportAssetToSignedUrlResponseDetails Text Source #

The unique identifier for the asset associated with this export job.

exportAssetToSignedUrlResponseDetails_revisionId :: Lens' ExportAssetToSignedUrlResponseDetails Text Source #

The unique identifier for the revision associated with this export response.

ExportAssetsToS3RequestDetails

exportAssetsToS3RequestDetails_dataSetId :: Lens' ExportAssetsToS3RequestDetails Text Source #

The unique identifier for the data set associated with this export job.

exportAssetsToS3RequestDetails_revisionId :: Lens' ExportAssetsToS3RequestDetails Text Source #

The unique identifier for the revision associated with this export request.

ExportAssetsToS3ResponseDetails

exportAssetsToS3ResponseDetails_dataSetId :: Lens' ExportAssetsToS3ResponseDetails Text Source #

The unique identifier for the data set associated with this export job.

exportAssetsToS3ResponseDetails_revisionId :: Lens' ExportAssetsToS3ResponseDetails Text Source #

The unique identifier for the revision associated with this export response.

ExportRevisionsToS3RequestDetails

exportRevisionsToS3RequestDetails_dataSetId :: Lens' ExportRevisionsToS3RequestDetails Text Source #

The unique identifier for the data set associated with this export job.

ExportRevisionsToS3ResponseDetails

exportRevisionsToS3ResponseDetails_dataSetId :: Lens' ExportRevisionsToS3ResponseDetails Text Source #

The unique identifier for the data set associated with this export job.

ExportServerSideEncryption

exportServerSideEncryption_kmsKeyArn :: Lens' ExportServerSideEncryption (Maybe Text) Source #

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

exportServerSideEncryption_type :: Lens' ExportServerSideEncryption ServerSideEncryptionTypes Source #

The type of server side encryption used for encrypting the objects in Amazon S3.

ImportAssetFromSignedUrlJobErrorDetails

ImportAssetFromSignedUrlRequestDetails

importAssetFromSignedUrlRequestDetails_dataSetId :: Lens' ImportAssetFromSignedUrlRequestDetails Text Source #

The unique identifier for the data set associated with this import job.

importAssetFromSignedUrlRequestDetails_md5Hash :: Lens' ImportAssetFromSignedUrlRequestDetails Text Source #

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

importAssetFromSignedUrlRequestDetails_assetName :: Lens' ImportAssetFromSignedUrlRequestDetails Text Source #

The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name.

importAssetFromSignedUrlRequestDetails_revisionId :: Lens' ImportAssetFromSignedUrlRequestDetails Text Source #

The unique identifier for the revision associated with this import request.

ImportAssetFromSignedUrlResponseDetails

importAssetFromSignedUrlResponseDetails_signedUrlExpiresAt :: Lens' ImportAssetFromSignedUrlResponseDetails (Maybe UTCTime) Source #

The time and date at which the signed URL expires, in ISO 8601 format.

importAssetFromSignedUrlResponseDetails_md5Hash :: Lens' ImportAssetFromSignedUrlResponseDetails (Maybe Text) Source #

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

importAssetFromSignedUrlResponseDetails_dataSetId :: Lens' ImportAssetFromSignedUrlResponseDetails Text Source #

The unique identifier for the data set associated with this import job.

importAssetFromSignedUrlResponseDetails_revisionId :: Lens' ImportAssetFromSignedUrlResponseDetails Text Source #

The unique identifier for the revision associated with this import response.

ImportAssetsFromRedshiftDataSharesRequestDetails

ImportAssetsFromRedshiftDataSharesResponseDetails

ImportAssetsFromS3RequestDetails

importAssetsFromS3RequestDetails_dataSetId :: Lens' ImportAssetsFromS3RequestDetails Text Source #

The unique identifier for the data set associated with this import job.

importAssetsFromS3RequestDetails_revisionId :: Lens' ImportAssetsFromS3RequestDetails Text Source #

The unique identifier for the revision associated with this import request.

ImportAssetsFromS3ResponseDetails

importAssetsFromS3ResponseDetails_dataSetId :: Lens' ImportAssetsFromS3ResponseDetails Text Source #

The unique identifier for the data set associated with this import job.

importAssetsFromS3ResponseDetails_revisionId :: Lens' ImportAssetsFromS3ResponseDetails Text Source #

The unique identifier for the revision associated with this import response.

JobEntry

jobEntry_details :: Lens' JobEntry ResponseDetails Source #

Details of the operation to be performed by the job, such as export destination details or import source details.

jobEntry_state :: Lens' JobEntry State Source #

The state of the job.

jobEntry_createdAt :: Lens' JobEntry UTCTime Source #

The date and time that the job was created, in ISO 8601 format.

jobEntry_id :: Lens' JobEntry Text Source #

The unique identifier for the job.

jobEntry_arn :: Lens' JobEntry Text Source #

The ARN for the job.

jobEntry_updatedAt :: Lens' JobEntry UTCTime Source #

The date and time that the job was last updated, in ISO 8601 format.

JobError

jobError_resourceId :: Lens' JobError (Maybe Text) Source #

The unique identifier for the resource related to the error.

jobError_limitName :: Lens' JobError (Maybe JobErrorLimitName) Source #

The name of the limit that was reached.

jobError_resourceType :: Lens' JobError (Maybe JobErrorResourceTypes) Source #

The type of resource related to the error.

jobError_details :: Lens' JobError (Maybe Details) Source #

The details about the job error.

jobError_limitValue :: Lens' JobError (Maybe Double) Source #

The value of the exceeded limit.

jobError_message :: Lens' JobError Text Source #

The message related to the job error.

jobError_code :: Lens' JobError Code Source #

The code for the job error.

OriginDetails

originDetails_productId :: Lens' OriginDetails Text Source #

The product ID of the origin of the data set.

RedshiftDataShareAsset

redshiftDataShareAsset_arn :: Lens' RedshiftDataShareAsset Text Source #

The Amazon Resource Name (ARN) of the datashare asset.

RedshiftDataShareAssetSourceEntry

RequestDetails

ResponseDetails

RevisionDestinationEntry

revisionDestinationEntry_keyPattern :: Lens' RevisionDestinationEntry (Maybe Text) Source #

A string representing the pattern for generated names of the individual assets in the revision. For more information about key patterns, see Key patterns when exporting revisions.

revisionDestinationEntry_bucket :: Lens' RevisionDestinationEntry Text Source #

The S3 bucket that is the destination for the assets in the revision.

RevisionEntry

revisionEntry_sourceId :: Lens' RevisionEntry (Maybe Text) Source #

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.

revisionEntry_finalized :: Lens' RevisionEntry (Maybe Bool) Source #

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.

revisionEntry_comment :: Lens' RevisionEntry (Maybe Text) Source #

An optional comment about the revision.

revisionEntry_createdAt :: Lens' RevisionEntry UTCTime Source #

The date and time that the revision was created, in ISO 8601 format.

revisionEntry_dataSetId :: Lens' RevisionEntry Text Source #

The unique identifier for the data set associated with this revision.

revisionEntry_id :: Lens' RevisionEntry Text Source #

The unique identifier for the revision.

revisionEntry_arn :: Lens' RevisionEntry Text Source #

The ARN for the revision.

revisionEntry_updatedAt :: Lens' RevisionEntry UTCTime Source #

The date and time that the revision was last updated, in ISO 8601 format.

RevisionPublished

revisionPublished_dataSetId :: Lens' RevisionPublished Text Source #

The data set ID of the published revision.

S3SnapshotAsset

s3SnapshotAsset_size :: Lens' S3SnapshotAsset Double Source #

The size of the S3 object that is the object.