This is the API reference for AWS Data Exchange.
", "operations" : { "CancelJob" : "This operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.
", "CreateDataSet" : "This operation creates a data set.
", "CreateEventAction" : "This operation creates an event action.
", "CreateJob" : "This operation creates a job.
", "CreateRevision" : "This operation creates a revision for a data set.
", "DeleteAsset" : "This operation deletes an asset.
", "DeleteDataSet" : "This operation deletes a data set.
", "DeleteEventAction" : "This operation deletes the event action.
", "DeleteRevision" : "This operation deletes a revision.
", "GetAsset" : "This operation returns information about an asset.
", "GetDataSet" : "This operation returns information about a data set.
", "GetEventAction" : "This operation retrieves information about an event action.
", "GetJob" : "This operation returns information about a job.
", "GetRevision" : "This operation returns information about a revision.
", "ListDataSetRevisions" : "This operation lists a data set's revisions sorted by CreatedAt in descending order.
", "ListDataSets" : "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.
", "ListEventActions" : "This operation lists your event actions.
", "ListJobs" : "This operation lists your jobs sorted by CreatedAt in descending order.
", "ListRevisionAssets" : "This operation lists a revision's assets sorted alphabetically in descending order.
", "ListTagsForResource" : "This operation lists the tags on the resource.
", "RevokeRevision" : "This operation revokes subscribers' access to a revision.
", "SendApiAsset" : "This operation invokes an API Gateway API asset. The request is proxied to the provider’s API Gateway API.
", "StartJob" : "This operation starts a job.
", "TagResource" : "This operation tags a resource.
", "UntagResource" : "This operation removes one or more tags from a resource.
", "UpdateAsset" : "This operation updates an asset.
", "UpdateDataSet" : "This operation updates a data set.
", "UpdateEventAction" : "This operation updates the event action.
", "UpdateRevision" : "This operation updates a revision.
" }, "shapes" : { "AccessDeniedException" : { "base" : "Access to the resource is denied.
", "refs" : { } }, "Action" : { "base" : "What occurs after a certain event.
", "refs" : { "CreateEventActionRequest$Action" : "What occurs after a certain event.
", "EventAction$Action" : "What occurs after a certain event.
", "EventActionEntry$Action" : "What occurs after a certain event.
", "UpdateEventActionRequest$Action" : "What occurs after a certain event.
" } }, "ApiDescription" : { "base" : "The description of the API.
", "refs" : { "ApiGatewayApiAsset$ApiDescription" : "The API description of the API asset.
", "ImportAssetFromApiGatewayApiRequestDetails$ApiDescription" : "The API description. Markdown supported.
", "ImportAssetFromApiGatewayApiResponseDetails$ApiDescription" : "The API description.
" } }, "ApiGatewayApiAsset" : { "base" : "The API Gateway API that is the asset.
", "refs" : { "AssetDetails$ApiGatewayApiAsset" : "Information about the API Gateway API asset.
" } }, "Arn" : { "base" : "An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.
", "refs" : { "Asset$Arn" : "The ARN for the asset.
", "AssetEntry$Arn" : "The ARN for the asset.
", "DataSet$Arn" : "The ARN for the data set.
", "DataSetEntry$Arn" : "The ARN for the data set.
", "EventAction$Arn" : "The ARN for the event action.
", "EventActionEntry$Arn" : "The Amazon Resource Name (ARN) for the event action.
", "Job$Arn" : "The ARN for the job.
", "JobEntry$Arn" : "The ARN for the job.
", "Revision$Arn" : "The ARN for the revision.
", "RevisionEntry$Arn" : "The ARN for the revision.
", "TaggedDataSet$Arn" : "The ARN for the data set.
", "TaggedRevision$Arn" : "The ARN for the revision.
" } }, "Asset" : { "base" : "An asset in AWS Data Exchange is a piece of data (S3 object) or a means of fulfilling data (Amazon Redshift datashare or Amazon API Gateway API). The asset can be a structured data file, an image file, or some other data file that can be stored as an S3 object, an Amazon API Gateway API, or an Amazon Redshift datashare. When you create an import job for your files, API Gateway APIs, or Amazon Redshift datashares, you create an asset in AWS Data Exchange.
", "refs" : { } }, "AssetDestinationEntry" : { "base" : "The destination for the asset.
", "refs" : { "ListOfAssetDestinationEntry$member" : null } }, "AssetDetails" : { "base" : "Information about the asset.
", "refs" : { "Asset$AssetDetails" : "Information about the asset.
", "AssetEntry$AssetDetails" : "Information about the asset.
" } }, "AssetEntry" : { "base" : "An asset in AWS Data Exchange is a piece of data (S3 object) or a means of fulfilling data (Amazon Redshift datashare or Amazon API Gateway API). The asset can be a structured data file, an image file, or some other data file that can be stored as an S3 object, an Amazon API Gateway API, or an Amazon Redshift datashare. When you create an import job for your files, API Gateway APIs, or Amazon Redshift datashares, you create an asset in AWS Data Exchange.
", "refs" : { "ListOfAssetEntry$member" : null } }, "AssetName" : { "base" : "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. 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.
", "refs" : { "Asset$Name" : "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. 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.
", "AssetEntry$Name" : "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. 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.
", "ImportAssetFromSignedUrlJobErrorDetails$AssetName" : "Information about the job error.
", "ImportAssetFromSignedUrlRequestDetails$AssetName" : "The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name.
", "ImportAssetFromSignedUrlResponseDetails$AssetName" : "The name for the asset associated with this import job.
", "UpdateAssetRequest$Name" : "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. 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.
" } }, "AssetSourceEntry" : { "base" : "The source of the assets.
", "refs" : { "ListOfAssetSourceEntry$member" : null } }, "AssetType" : { "base" : "The type of asset that is added to a data set.
", "refs" : { "Asset$AssetType" : "The type of asset that is added to a data set.
", "AssetEntry$AssetType" : "The type of asset that is added to a data set.
", "CreateDataSetRequest$AssetType" : "The type of asset that is added to a data set.
", "DataSet$AssetType" : "The type of asset that is added to a data set.
", "DataSetEntry$AssetType" : "The type of asset that is added to a data set.
", "TaggedDataSet$AssetType" : "The type of asset that is added to a data set.
" } }, "AutoExportRevisionDestinationEntry" : { "base" : "A revision destination is the Amazon S3 bucket folder destination to where the export will be sent.
", "refs" : { "AutoExportRevisionToS3RequestDetails$RevisionDestination" : "A revision destination is the Amazon S3 bucket folder destination to where the export will be sent.
" } }, "AutoExportRevisionToS3RequestDetails" : { "base" : "Details of the operation to be performed by the job.
", "refs" : { "Action$ExportRevisionToS3" : "Details for the export revision to Amazon S3 action.
" } }, "Body" : { "base" : "The API request body should be exactly what you to send to the provider's asset. There is no need to wrap it or to send JSON.
", "refs" : { } }, "Code" : { "base" : null, "refs" : { "JobError$Code" : "The code for the job error." } }, "ConflictException" : { "base" : "The request couldn't be completed because it conflicted with the current state of the resource.
", "refs" : { } }, "CreateDataSetRequest" : { "base" : "A request to create a data set that contains one or more revisions.
", "refs" : { } }, "CreateEventActionRequest" : { "base" : "A request to create an event action.
", "refs" : { } }, "CreateJobRequest" : { "base" : "The CreateJob request. AWS Data Exchange Jobs are asynchronous import or export operations used to create or copy assets. A data set owner can both import and export assets. A subscriber with an entitlement to a data set can only export. Jobs are deleted 90 days after they are created. Created jobs must be started with the StartJob operation.
", "refs" : { } }, "CreateRevisionRequest" : { "base" : "Creates a revision for a data set. When they're created, revisions are not published to products, and therefore are not available to subscribers. To publish a revision to a data set in a product, the revision must first be finalized.
", "refs" : { } }, "DataSet" : { "base" : "A data set is an AWS resource with one or more revisions.
", "refs" : { } }, "DataSetEntry" : { "base" : "A data set is an AWS resource with one or more revisions.
", "refs" : { "ListOfDataSetEntry$member" : null } }, "Description" : { "base" : "A description of a resource.
", "refs" : { "CreateDataSetRequest$Description" : "A description for the data set. This value can be up to 16,348 characters long.
", "DataSet$Description" : "The description for the data set.
", "DataSetEntry$Description" : "The description for the data set.
", "TaggedDataSet$Description" : "The description for the data set.
", "UpdateDataSetRequest$Description" : "The description for the data set.
" } }, "Details" : { "base" : "Information about the job error.
", "refs" : { "JobError$Details" : "The details about the job error.
" } }, "Event" : { "base" : "What occurs to start an action.
", "refs" : { "CreateEventActionRequest$Event" : "What occurs to start an action.
", "EventAction$Event" : "What occurs to start an action.
", "EventActionEntry$Event" : "What occurs to start an action.
" } }, "EventAction" : { "base" : "An event action is an object that defines the relationship between a specific event and an automated action that will be taken on behalf of the customer.
", "refs" : { } }, "EventActionEntry" : { "base" : "An event action is an object that defines the relationship between a specific event and an automated action that will be taken on behalf of the customer.
", "refs" : { "ListOfEventActionEntry$member" : null } }, "ExceptionCause" : { "base" : null, "refs" : { "ValidationException$ExceptionCause" : "The message that informs you about what the exception was.
" } }, "ExportAssetToSignedUrlRequestDetails" : { "base" : "Details of the operation to be performed by the job.
", "refs" : { "RequestDetails$ExportAssetToSignedUrl" : "Details about the export to signed URL request.
" } }, "ExportAssetToSignedUrlResponseDetails" : { "base" : "The details of the export to signed URL response.
", "refs" : { "ResponseDetails$ExportAssetToSignedUrl" : "Details for the export to signed URL response.
" } }, "ExportAssetsToS3RequestDetails" : { "base" : "Details of the operation to be performed by the job.
", "refs" : { "RequestDetails$ExportAssetsToS3" : "Details about the export to Amazon S3 request.
" } }, "ExportAssetsToS3ResponseDetails" : { "base" : "Details about the export to Amazon S3 response.
", "refs" : { "ResponseDetails$ExportAssetsToS3" : "Details for the export to Amazon S3 response.
" } }, "ExportRevisionsToS3RequestDetails" : { "base" : "Details of the operation to be performed by the job.
", "refs" : { "RequestDetails$ExportRevisionsToS3" : "Details about the export to Amazon S3 request.
" } }, "ExportRevisionsToS3ResponseDetails" : { "base" : "Details about the export revisions to Amazon S3 response.
", "refs" : { "ResponseDetails$ExportRevisionsToS3" : "Details for the export revisions to Amazon S3 response.
" } }, "ExportServerSideEncryption" : { "base" : "Encryption configuration of the export job. Includes the encryption type in addition to the AWS KMS key. The KMS key is only necessary if you chose the KMS encryption. type.
", "refs" : { "AutoExportRevisionToS3RequestDetails$Encryption" : "Encryption configuration for the auto export job.
", "ExportAssetsToS3RequestDetails$Encryption" : "Encryption configuration for the export job.
", "ExportAssetsToS3ResponseDetails$Encryption" : "Encryption configuration of the export job.
", "ExportRevisionsToS3RequestDetails$Encryption" : "Encryption configuration for the export job.
", "ExportRevisionsToS3ResponseDetails$Encryption" : "Encryption configuration of the export job.
" } }, "Id" : { "base" : "A unique identifier.
", "refs" : { "Asset$DataSetId" : "The unique identifier for the data set associated with this asset.
", "Asset$Id" : "The unique identifier for the asset.
", "Asset$RevisionId" : "The unique identifier for the revision associated with this asset.
", "Asset$SourceId" : "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.
", "AssetDestinationEntry$AssetId" : "The unique identifier for the asset.
", "AssetEntry$DataSetId" : "The unique identifier for the data set associated with this asset.
", "AssetEntry$Id" : "The unique identifier for the asset.
", "AssetEntry$RevisionId" : "The unique identifier for the revision associated with this asset.
", "AssetEntry$SourceId" : "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.
", "DataSet$Id" : "The unique identifier for the data set.
", "DataSet$SourceId" : "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$Id" : "The unique identifier for the data set.
", "DataSetEntry$SourceId" : "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.
", "EventAction$Id" : "The unique identifier for the event action.
", "EventActionEntry$Id" : "The unique identifier for the event action.
", "ExportAssetToSignedUrlRequestDetails$AssetId" : "The unique identifier for the asset that is exported to a signed URL.
", "ExportAssetToSignedUrlRequestDetails$DataSetId" : "The unique identifier for the data set associated with this export job.
", "ExportAssetToSignedUrlRequestDetails$RevisionId" : "The unique identifier for the revision associated with this export request.
", "ExportAssetToSignedUrlResponseDetails$AssetId" : "The unique identifier for the asset associated with this export job.
", "ExportAssetToSignedUrlResponseDetails$DataSetId" : "The unique identifier for the data set associated with this export job.
", "ExportAssetToSignedUrlResponseDetails$RevisionId" : "The unique identifier for the revision associated with this export response.
", "ExportAssetsToS3RequestDetails$DataSetId" : "The unique identifier for the data set associated with this export job.
", "ExportAssetsToS3RequestDetails$RevisionId" : "The unique identifier for the revision associated with this export request.
", "ExportAssetsToS3ResponseDetails$DataSetId" : "The unique identifier for the data set associated with this export job.
", "ExportAssetsToS3ResponseDetails$RevisionId" : "The unique identifier for the revision associated with this export response.
", "ExportRevisionsToS3RequestDetails$DataSetId" : "The unique identifier for the data set associated with this export job.
", "ExportRevisionsToS3ResponseDetails$DataSetId" : "The unique identifier for the data set associated with this export job.
", "ImportAssetFromApiGatewayApiRequestDetails$DataSetId" : "The data set ID.
", "ImportAssetFromApiGatewayApiRequestDetails$RevisionId" : "The revision ID.
", "ImportAssetFromApiGatewayApiResponseDetails$DataSetId" : "The data set ID.
", "ImportAssetFromApiGatewayApiResponseDetails$RevisionId" : "The revision ID.
", "ImportAssetFromSignedUrlRequestDetails$DataSetId" : "The unique identifier for the data set associated with this import job.
", "ImportAssetFromSignedUrlRequestDetails$RevisionId" : "The unique identifier for the revision associated with this import request.
", "ImportAssetFromSignedUrlResponseDetails$DataSetId" : "The unique identifier for the data set associated with this import job.
", "ImportAssetFromSignedUrlResponseDetails$RevisionId" : "The unique identifier for the revision associated with this import response.
", "ImportAssetsFromRedshiftDataSharesRequestDetails$DataSetId" : "The unique identifier for the data set associated with this import job.", "ImportAssetsFromRedshiftDataSharesRequestDetails$RevisionId" : "The unique identifier for the revision associated with this import job.", "ImportAssetsFromRedshiftDataSharesResponseDetails$DataSetId" : "The unique identifier for the data set associated with this import job.", "ImportAssetsFromRedshiftDataSharesResponseDetails$RevisionId" : "The unique identifier for the revision associated with this import job.", "ImportAssetsFromS3RequestDetails$DataSetId" : "The unique identifier for the data set associated with this import job.
", "ImportAssetsFromS3RequestDetails$RevisionId" : "The unique identifier for the revision associated with this import request.
", "ImportAssetsFromS3ResponseDetails$DataSetId" : "The unique identifier for the data set associated with this import job.
", "ImportAssetsFromS3ResponseDetails$RevisionId" : "The unique identifier for the revision associated with this import response.
", "Job$Id" : "The unique identifier for the job.
", "JobEntry$Id" : "The unique identifier for the job.
", "Revision$DataSetId" : "The unique identifier for the data set associated with this revision.
", "Revision$Id" : "The unique identifier for the revision.
", "Revision$SourceId" : "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.
", "RevisionDestinationEntry$RevisionId" : "The unique identifier for the revision.
", "RevisionEntry$DataSetId" : "The unique identifier for the data set associated with this revision.
", "RevisionEntry$Id" : "The unique identifier for the revision.
", "RevisionEntry$SourceId" : "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.
", "RevisionPublished$DataSetId" : "The data set ID of the published revision.
", "TaggedDataSet$Id" : "The unique identifier for the data set.
", "TaggedDataSet$SourceId" : "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.
", "TaggedRevision$DataSetId" : "The unique identifier for the data set associated with this revision.
", "TaggedRevision$Id" : "The unique identifier for the revision.
", "TaggedRevision$SourceId" : "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.
" } }, "ImportAssetFromApiGatewayApiRequestDetails" : { "base" : "The request details.
", "refs" : { "RequestDetails$ImportAssetFromApiGatewayApi" : "Information about the import asset from API Gateway API request.
" } }, "ImportAssetFromApiGatewayApiResponseDetails" : { "base" : "The response details.
", "refs" : { "ResponseDetails$ImportAssetFromApiGatewayApi" : "The response details.
" } }, "ImportAssetFromSignedUrlJobErrorDetails" : { "base" : "Information about the job error.
", "refs" : { "Details$ImportAssetFromSignedUrlJobErrorDetails" : "Information about the job error.
" } }, "ImportAssetFromSignedUrlRequestDetails" : { "base" : "Details of the operation to be performed by the job.
", "refs" : { "RequestDetails$ImportAssetFromSignedUrl" : "Details about the import from signed URL request.
" } }, "ImportAssetFromSignedUrlResponseDetails" : { "base" : "The details in the response for an import request, including the signed URL and other information.
", "refs" : { "ResponseDetails$ImportAssetFromSignedUrl" : "Details for the import from signed URL response.
" } }, "ImportAssetsFromRedshiftDataSharesRequestDetails" : { "base" : "Details from an import from Amazon Redshift datashare request.", "refs" : { "RequestDetails$ImportAssetsFromRedshiftDataShares" : "Details from an import from Amazon Redshift datashare request.
" } }, "ImportAssetsFromRedshiftDataSharesResponseDetails" : { "base" : "Details from an import from Amazon Redshift datashare response.", "refs" : { "ResponseDetails$ImportAssetsFromRedshiftDataShares" : "Details from an import from Amazon Redshift datashare response.
" } }, "ImportAssetsFromS3RequestDetails" : { "base" : "Details of the operation to be performed by the job.
", "refs" : { "RequestDetails$ImportAssetsFromS3" : "Details about the import from Amazon S3 request.
" } }, "ImportAssetsFromS3ResponseDetails" : { "base" : "Details from an import from Amazon S3 response.
", "refs" : { "ResponseDetails$ImportAssetsFromS3" : "Details for the import from Amazon S3 response.
" } }, "InternalServerException" : { "base" : "An exception occurred with the service.", "refs" : { } }, "Job" : { "base" : "AWS Data Exchange jobs are asynchronous import or export operations used to create or copy assets. Jobs are deleted 90 days after they are created.
", "refs" : { } }, "JobEntry" : { "base" : "AWS Data Exchange Jobs are asynchronous import or export operations used to create or copy assets. A data set owner can both import and export as they see fit. Someone with an entitlement to a data set can only export. Jobs are deleted 90 days after they are created.", "refs" : { "ListOfJobEntry$member" : null } }, "JobError" : { "base" : "An error that occurred with the job request.", "refs" : { "ListOfJobError$member" : null } }, "JobErrorLimitName" : { "base" : "The name of the limit that was reached.", "refs" : { "JobError$LimitName" : "The name of the limit that was reached.
" } }, "JobErrorResourceTypes" : { "base" : "The types of resource which the job error can apply to.", "refs" : { "JobError$ResourceType" : "The type of resource related to the error." } }, "LimitName" : { "base" : null, "refs" : { "ServiceQuotaExceededException$LimitName" : "The name of the quota that was exceeded.
" } }, "ListOfAssetDestinationEntry" : { "base" : "The destination where the assets will be exported.
", "refs" : { "ExportAssetsToS3RequestDetails$AssetDestinations" : "The destination for the asset.
", "ExportAssetsToS3ResponseDetails$AssetDestinations" : "The destination in Amazon S3 where the asset is exported.
" } }, "ListOfAssetSourceEntry" : { "base" : "The list of sources for the assets.
", "refs" : { "Details$ImportAssetsFromS3JobErrorDetails" : "Information about the job error.
", "ImportAssetsFromS3RequestDetails$AssetSources" : "Is a list of S3 bucket and object key pairs.
", "ImportAssetsFromS3ResponseDetails$AssetSources" : "Is a list of Amazon S3 bucket and object key pairs.
" } }, "ListOfAssets" : { "base" : "The asset objects listed by the request.
", "refs" : { } }, "ListOfDataSets" : { "base" : "The data set objects listed by the request.
", "refs" : { } }, "ListOfEventActions" : { "base" : "The event entry objects listed by the request.
", "refs" : { } }, "ListOfJobs" : { "base" : "The token value retrieved from a previous call to access the next page of results.
", "refs" : { } }, "ListOfRedshiftDataShareAssetSourceEntry" : { "base" : "A list of Amazon Redshift datashare asset sources.", "refs" : { "ImportAssetsFromRedshiftDataSharesRequestDetails$AssetSources" : "A list of Amazon Redshift datashare assets.", "ImportAssetsFromRedshiftDataSharesResponseDetails$AssetSources" : "A list of Amazon Redshift datashare asset sources." } }, "ListOfRevisionDestinationEntry" : { "base" : "The destination where the assets in the revision will be exported.
", "refs" : { "ExportRevisionsToS3RequestDetails$RevisionDestinations" : "The destination for the revision.
", "ExportRevisionsToS3ResponseDetails$RevisionDestinations" : "The destination in Amazon S3 where the revision is exported.
" } }, "ListOfRevisions" : { "base" : "The revision objects listed by the request.
", "refs" : { } }, "Name" : { "base" : "The name of the model.", "refs" : { "CreateDataSetRequest$Name" : "The name of the data set.
", "DataSet$Name" : "The name of the data set.
", "DataSetEntry$Name" : "The name of the data set.
", "TaggedDataSet$Name" : "The name of the data set.
", "UpdateDataSetRequest$Name" : "The name of the data set.
" } }, "NextToken" : { "base" : "The token value retrieved from a previous call to access the next page of results.
", "refs" : { "ListOfAssets$NextToken" : "The token value retrieved from a previous call to access the next page of results.
", "ListOfDataSets$NextToken" : "The token value retrieved from a previous call to access the next page of results.
", "ListOfEventActions$NextToken" : "The token value retrieved from a previous call to access the next page of results.
", "ListOfJobs$NextToken" : "The token value retrieved from a previous call to access the next page of results.
", "ListOfRevisions$NextToken" : "The token value retrieved from a previous call to access the next page of results.
" } }, "Origin" : { "base" : "A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers). When an owned data set is published in a product, AWS Data Exchange creates a copy of the data set. Subscribers can access that copy of the data set as an entitled data set.
", "refs" : { "DataSet$Origin" : "A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).
", "DataSetEntry$Origin" : "A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).
", "TaggedDataSet$Origin" : "A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).
" } }, "OriginDetails" : { "base" : "Information about the origin of the data set.
", "refs" : { "DataSet$OriginDetails" : "If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.
", "DataSetEntry$OriginDetails" : "If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.
", "TaggedDataSet$OriginDetails" : "If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.
" } }, "ProtocolType" : { "base" : null, "refs" : { "ApiGatewayApiAsset$ProtocolType" : "The protocol type of the API asset.
", "ImportAssetFromApiGatewayApiRequestDetails$ProtocolType" : "The protocol type.
", "ImportAssetFromApiGatewayApiResponseDetails$ProtocolType" : "The protocol type.
" } }, "RedshiftDataShareAsset" : { "base" : "The Amazon Redshift datashare asset.", "refs" : { "AssetDetails$RedshiftDataShareAsset" : "The Amazon Redshift datashare that is the asset.
" } }, "RedshiftDataShareAssetSourceEntry" : { "base" : "The source of the Amazon Redshift datashare asset.
", "refs" : { "ListOfRedshiftDataShareAssetSourceEntry$member" : null } }, "RequestDetails" : { "base" : "The details for the request.
", "refs" : { "CreateJobRequest$Details" : "The details for the CreateJob request.
" } }, "ResourceNotFoundException" : { "base" : "The resource couldn't be found.
", "refs" : { } }, "ResourceType" : { "base" : null, "refs" : { "ConflictException$ResourceType" : "The type of the resource with the conflict.
", "ResourceNotFoundException$ResourceType" : "The type of resource that couldn't be found.
" } }, "ResponseDetails" : { "base" : "Details for the response.
", "refs" : { "Job$Details" : "Details about the job.
", "JobEntry$Details" : "Details of the operation to be performed by the job, such as export destination details or import source details.
" } }, "Revision" : { "base" : "A revision is a container for one or more assets.
", "refs" : { } }, "RevisionDestinationEntry" : { "base" : "The destination where the assets in the revision will be exported.
", "refs" : { "ListOfRevisionDestinationEntry$member" : null } }, "RevisionEntry" : { "base" : "A revision is a container for one or more assets.
", "refs" : { "ListOfRevisionEntry$member" : null } }, "RevisionPublished" : { "base" : "Information about the published revision.
", "refs" : { "Event$RevisionPublished" : "What occurs to start the revision publish action.
" } }, "RevokeRevisionRequest" : { "base" : "The request sent to revoke the revision.
", "refs" : { } }, "S3SnapshotAsset" : { "base" : "The S3 object that is the asset.
", "refs" : { "AssetDetails$S3SnapshotAsset" : "The S3 object that is the asset.
" } }, "SendApiAssetResponse" : { "base" : "The details of the send API asset response.
", "refs" : { } }, "ServerSideEncryptionTypes" : { "base" : "The types of encryption supported in export jobs to Amazon S3.
", "refs" : { "ExportServerSideEncryption$Type" : "The type of server side encryption used for encrypting the objects in Amazon S3.
" } }, "ServiceLimitExceededException" : { "base" : "The request has exceeded the quotas imposed by the service.
", "refs" : { } }, "ServiceQuotaExceededException" : { "base" : "The request has exceeded the quotas imposed by the service.
", "refs" : { } }, "State" : { "base" : null, "refs" : { "Job$State" : "The state of the job.
", "JobEntry$State" : "The state of the job.
" } }, "TaggedDataSet" : { "base" : "A data set is an AWS resource with one or more revisions.
", "refs" : { } }, "TaggedRevision" : { "base" : "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.
", "refs" : { } }, "TagsModel" : { "base" : "You can assign metadata to your AWS Data Exchange resources in the form of tags. Each tag is a label that consists of a customer-defined key and an optional value that can make it easier to manage, search for, and filter resources.", "refs" : { } }, "ThrottlingException" : { "base" : "The limit on the number of requests per second was exceeded.
", "refs" : { } }, "Timestamp" : { "base" : "Dates and times in AWS Data Exchange are recorded in ISO 8601 format.
", "refs" : { "ApiGatewayApiAsset$ApiSpecificationDownloadUrlExpiresAt" : "The date and time that the upload URL expires, in ISO 8601 format.
", "Asset$CreatedAt" : "The date and time that the asset was created, in ISO 8601 format.
", "Asset$UpdatedAt" : "The date and time that the asset was last updated, in ISO 8601 format.
", "AssetEntry$CreatedAt" : "The date and time that the asset was created, in ISO 8601 format.
", "AssetEntry$UpdatedAt" : "The date and time that the asset was last updated, in ISO 8601 format.
", "DataSet$CreatedAt" : "The date and time that the data set was created, in ISO 8601 format.
", "DataSet$UpdatedAt" : "The date and time that the data set was last updated, in ISO 8601 format.
", "DataSetEntry$CreatedAt" : "The date and time that the data set was created, in ISO 8601 format.
", "DataSetEntry$UpdatedAt" : "The date and time that the data set was last updated, in ISO 8601 format.
", "EventAction$CreatedAt" : "The date and time that the event action was created, in ISO 8601 format.
", "EventAction$UpdatedAt" : "The date and time that the event action was last updated, in ISO 8601 format.
", "EventActionEntry$CreatedAt" : "The date and time that the event action was created, in ISO 8601 format.
", "EventActionEntry$UpdatedAt" : "The date and time that the event action was last updated, in ISO 8601 format.
", "ExportAssetToSignedUrlResponseDetails$SignedUrlExpiresAt" : "The date and time that the signed URL expires, in ISO 8601 format.
", "ImportAssetFromApiGatewayApiResponseDetails$ApiSpecificationUploadUrlExpiresAt" : "The date and time that the upload URL expires, in ISO 8601 format.
", "ImportAssetFromSignedUrlResponseDetails$SignedUrlExpiresAt" : "The time and date at which the signed URL expires, in ISO 8601 format.
", "Job$CreatedAt" : "The date and time that the job was created, in ISO 8601 format.
", "Job$UpdatedAt" : "The date and time that the job was last updated, in ISO 8601 format.
", "JobEntry$CreatedAt" : "The date and time that the job was created, in ISO 8601 format.
", "JobEntry$UpdatedAt" : "The date and time that the job was last updated, in ISO 8601 format.
", "Revision$CreatedAt" : "The date and time that the revision was created, in ISO 8601 format.
", "Revision$RevokedAt" : "The date and time that the revision was revoked, in ISO 8601 format.
", "Revision$UpdatedAt" : "The date and time that the revision was last updated, in ISO 8601 format.
", "RevisionEntry$CreatedAt" : "The date and time that the revision was created, in ISO 8601 format.
", "RevisionEntry$RevokedAt" : "The date and time that the revision was revoked, in ISO 8601 format.
", "RevisionEntry$UpdatedAt" : "The date and time that the revision was last updated, in ISO 8601 format.
", "TaggedDataSet$CreatedAt" : "The date and time that the data set was created, in ISO 8601 format.
", "TaggedDataSet$UpdatedAt" : "The date and time that the data set was last updated, in ISO 8601 format.
", "TaggedRevision$CreatedAt" : "The date and time that the revision was created, in ISO 8601 format.
", "TaggedRevision$RevokedAt" : "The date and time that the revision was revoked, in ISO 8601 format.
", "TaggedRevision$UpdatedAt" : "The date and time that the revision was last updated, in ISO 8601 format.
" } }, "Type" : { "base" : null, "refs" : { "CreateJobRequest$Type" : "The type of job to be created.
", "Job$Type" : "The job type.
", "JobEntry$Type" : "The job type.
" } }, "UpdateAssetRequest" : { "base" : "The request to update an asset.
", "refs" : { } }, "UpdateDataSetRequest" : { "base" : "The request to update a data set.
", "refs" : { } }, "UpdateEventActionRequest" : { "base" : "The request to update an event action.
", "refs" : { } }, "UpdateRevisionRequest" : { "base" : "The request to update a revision.
", "refs" : { } }, "ValidationException" : { "base" : "The request was invalid.
", "refs" : { } }, "__boolean" : { "base" : null, "refs" : { "Revision$Finalized" : "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.
", "Revision$Revoked" : "A status indicating that subscribers' access to the revision was revoked.
", "RevisionEntry$Finalized" : "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$Revoked" : "A status indicating that subscribers' access to the revision was revoked.
", "TaggedRevision$Finalized" : "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.
", "TaggedRevision$Revoked" : "A status indicating that subscribers' access to the revision was revoked.
", "UpdateRevisionRequest$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.
" } }, "__double" : { "base" : null, "refs" : { "JobError$LimitValue" : "The value of the exceeded limit.", "ServiceQuotaExceededException$LimitValue" : "The maximum value for the service-specific limit.
" } }, "__doubleMin0" : { "base" : null, "refs" : { "S3SnapshotAsset$Size" : "The size of the S3 object that is the object.
" } }, "ListOfAssetEntry" : { "base" : null, "refs" : { "ListOfAssets$Assets" : "The asset objects listed by the request.
" } }, "ListOfDataSetEntry" : { "base" : null, "refs" : { "ListOfDataSets$DataSets" : "The data set objects listed by the request.
" } }, "ListOfEventActionEntry" : { "base" : null, "refs" : { "ListOfEventActions$EventActions" : "The event action objects listed by the request.
" } }, "ListOfJobEntry" : { "base" : null, "refs" : { "ListOfJobs$Jobs" : "The jobs listed by the request.
" } }, "ListOfJobError" : { "base" : null, "refs" : { "Job$Errors" : "The errors associated with jobs.
", "JobEntry$Errors" : "Errors for jobs.
" } }, "ListOfRevisionEntry" : { "base" : null, "refs" : { "ListOfRevisions$Revisions" : "The asset objects listed by the request.
" } }, "MapOf__string" : { "base" : null, "refs" : { "CreateDataSetRequest$Tags" : "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.
", "CreateRevisionRequest$Tags" : "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.
", "SendApiAssetResponse$ResponseHeaders" : "The response headers from the underlying API tracked by the API asset.
", "TaggedDataSet$Tags" : "The tags for the data set.
", "TaggedRevision$Tags" : "The tags for the revision.
", "TagsModel$Tags" : "A label that consists of a customer-defined key and an optional value." } }, "__string" : { "base" : null, "refs" : { "AccessDeniedException$Message" : "Access to the resource is denied.
", "ApiGatewayApiAsset$ApiEndpoint" : "The API endpoint of the API asset.
", "ApiGatewayApiAsset$ApiId" : "The unique identifier of the API asset.
", "ApiGatewayApiAsset$ApiKey" : "The API key of the API asset.
", "ApiGatewayApiAsset$ApiName" : "The API name of the API asset.
", "ApiGatewayApiAsset$ApiSpecificationDownloadUrl" : "The download URL of the API specification of the API asset.
", "ApiGatewayApiAsset$Stage" : "The stage of the API asset.
", "AssetDestinationEntry$Bucket" : "The S3 bucket that is the destination for the asset.
", "AssetDestinationEntry$Key" : "The name of the object in Amazon S3 for the asset.
", "AssetSourceEntry$Bucket" : "The S3 bucket that's part of the source of the asset.
", "AssetSourceEntry$Key" : "The name of the object in Amazon S3 for the asset.
", "AutoExportRevisionDestinationEntry$Bucket" : "The S3 bucket that is the destination for the event action.
", "AutoExportRevisionDestinationEntry$KeyPattern" : "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.
", "Body$Body" : "The request body.
", "ConflictException$Message" : "The request couldn't be completed because it conflicted with the current state of the resource.
", "ConflictException$ResourceId" : "The unique identifier for the resource with the conflict.
", "ExportAssetToSignedUrlResponseDetails$SignedUrl" : "The signed URL for the export request.
", "ExportRevisionsToS3ResponseDetails$EventActionArn" : "The Amazon Resource Name (ARN) of the event action.
", "ExportServerSideEncryption$KmsKeyArn" : "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.
", "ImportAssetFromApiGatewayApiRequestDetails$ApiId" : "The API Gateway API ID.
", "ImportAssetFromApiGatewayApiRequestDetails$ApiKey" : "The API Gateway API key.
", "ImportAssetFromApiGatewayApiRequestDetails$ApiName" : "The API name.
", "ImportAssetFromApiGatewayApiRequestDetails$Stage" : "The API stage.
", "ImportAssetFromApiGatewayApiResponseDetails$ApiId" : "The API ID.
", "ImportAssetFromApiGatewayApiResponseDetails$ApiKey" : "The API key.
", "ImportAssetFromApiGatewayApiResponseDetails$ApiName" : "The API name.
", "ImportAssetFromApiGatewayApiResponseDetails$ApiSpecificationUploadUrl" : "The upload URL of the API specification.
", "ImportAssetFromApiGatewayApiResponseDetails$Stage" : "The API stage.
", "ImportAssetFromSignedUrlResponseDetails$SignedUrl" : "The signed URL.
", "InternalServerException$Message" : "The message identifying the service exception that occurred.", "JobError$Message" : "The message related to the job error.", "JobError$ResourceId" : "The unique identifier for the resource related to the error.", "OriginDetails$ProductId" : "The product ID of the origin of the data set.
", "RedshiftDataShareAsset$Arn" : "The Amazon Resource Name (ARN) of the datashare asset.", "RedshiftDataShareAssetSourceEntry$DataShareArn" : "The Amazon Resource Name (ARN) of the datashare asset.", "ResourceNotFoundException$Message" : "The resource couldn't be found.
", "ResourceNotFoundException$ResourceId" : "The unique identifier for the resource that couldn't be found.
", "RevisionDestinationEntry$Bucket" : "The S3 bucket that is the destination for the assets in the revision.
", "RevisionDestinationEntry$KeyPattern" : "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.
", "SendApiAssetResponse$Body" : "The response body from the underlying API tracked by the API asset.
", "ServiceQuotaExceededException$Message" : "The request has exceeded the quotas imposed by the service.
", "ThrottlingException$Message" : "The limit on the number of requests per second was exceeded.
", "ValidationException$Message" : "The message that informs you about what was invalid about the request.
", "MapOf__string$member" : null } }, "__stringMin0Max16384" : { "base" : null, "refs" : { "CreateRevisionRequest$Comment" : "An optional comment about the revision.
", "Revision$Comment" : "An optional comment about the revision.
", "RevisionEntry$Comment" : "An optional comment about the revision.
", "TaggedRevision$Comment" : "An optional comment about the revision.
", "UpdateRevisionRequest$Comment" : "An optional comment about the revision.
" } }, "__stringMin10Max512" : { "base" : null, "refs" : { "Revision$RevocationComment" : "A required comment to inform subscribers of the reason their access to the revision was revoked.
", "RevisionEntry$RevocationComment" : "A required comment to inform subscribers of the reason their access to the revision was revoked.
", "RevokeRevisionRequest$RevocationComment" : "A required comment to inform subscribers of the reason their access to the revision was revoked.
", "TaggedRevision$RevocationComment" : "A required comment to inform subscribers of the reason their access to the revision was revoked.
" } }, "__stringMin24Max24PatternAZaZ094AZaZ092AZaZ093" : { "base" : null, "refs" : { "ImportAssetFromApiGatewayApiRequestDetails$ApiSpecificationMd5Hash" : "The Base64-encoded MD5 hash of the OpenAPI 3.0 JSON API specification file. It is used to ensure the integrity of the file.
", "ImportAssetFromApiGatewayApiResponseDetails$ApiSpecificationMd5Hash" : "The Base64-encoded Md5 hash for the API asset, used to ensure the integrity of the API at that location.
", "ImportAssetFromSignedUrlRequestDetails$Md5Hash" : "The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.
", "ImportAssetFromSignedUrlResponseDetails$Md5Hash" : "The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.
" } } } }