{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"AddColumnToDataSetRequestContent":{"description":"A request to add a column to a data set.","properties":{"column":{"$ref":"#/components/schemas/Column"}},"required":["column"],"type":"object"},"AddColumnToDataSetResponseContent":{"description":"A response containing the updated data set containing the new column.","properties":{"dataSet":{"$ref":"#/components/schemas/DataSet"}},"type":"object"},"BadRequestExceptionResponseContent":{"description":"Bad Request.","properties":{"code":{"description":"The error code associated with the exception.","type":"string"},"details":{"description":"The error code associated with the exception.","type":"string"},"errors":{"description":"The error message(s) associated with the exception.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"requestId":{"description":"The request ID associated with the exception.","type":"string"}},"type":"object"},"Column":{"description":"The definition of a column in a data set.","properties":{"columnType":{"$ref":"#/components/schemas/ColumnType"},"consentType":{"$ref":"#/components/schemas/ConsentType"},"dataType":{"$ref":"#/components/schemas/DataType"},"description":{"description":"Optional. The human-readable description of the purpose of this column.","type":"string"},"externalUserIdType":{"$ref":"#/components/schemas/UserIdType"},"isCountryCode":{"description":"Optional. If this column is countryCode or not. Default is false.","type":"boolean"},"isMainEventTime":{"description":"Optional. If this column is contains the main event time of the record. Default is false.","type":"boolean"},"isMainUserId":{"description":"Optional. If this column is the resolved user id. Default is false.","type":"boolean"},"isMainUserIdType":{"description":"Optional. If this column should contain the resolved user id type. Default is false.","type":"boolean"},"name":{"description":"The name of this column.","type":"string"},"nullable":{"description":"Optional. If data in this column can be null or not. Default is true.","type":"boolean"},"requiresOneWayHashing":{"description":"Optional. If this column requires one way hashing or not. Default is false.","type":"boolean"}},"required":["columnType","dataType","name"],"type":"object"},"ColumnType":{"description":"The type of a data set column. There are two types of columns, the column which is a quantity or value rather than a dimension is METRIC. These columns are generally used in queries to perform aggregations. Typical examples are impressions and clicks. Whereas, columns which are characteristic rather than a quantity and are generally used as group by keys to perform aggregations, typical examples are ad_id or campaign_id.","enum":["DIMENSION","METRIC"],"type":"string"},"ComparatorOperator":{"description":"Optional. If a createdAt is provided, a comparator should be provided.","enum":["EQ","GT","GTE","LT","LTE"],"type":"string"},"CompressionFormat":{"description":"[UPDATE: As of 01/01/2025, `ZIP` is deprecated]. The compression format of data in S3 bucket.","enum":["BZIP","GZIP","NONE","SNAPPY","ZIP"],"type":"string"},"ConsentType":{"description":"The type of consent. If you have more than one ConsentType, you may define additional columns with the appropriate ConsentType. Each ConsentType may only be used once per DataSet.","enum":["AMZN_AD_STORAGE","AMZN_USER_DATA","GPP","TCF"],"type":"string"},"CreateDataSetRequestContent":{"description":"A request to create a new data set.","properties":{"dataSet":{"$ref":"#/components/schemas/DataSet"}},"required":["dataSet"],"type":"object"},"CreateDataSetResponseContent":{"description":"A response containing the identifiers of the created data set.","properties":{"dataSetId":{"description":"The data set ID of the data set created.","type":"string"},"instanceId":{"description":"The instance ID of the instance.","type":"string"}},"type":"object"},"CreateUploadRequestContent":{"description":"A request to create a new upload to a data set.","properties":{"compressionFormat":{"$ref":"#/components/schemas/CompressionFormat"},"countryCode":{"description":"Optional. A field that specifies a country. Values corresponds to ISO-3166 codes for country definitions. Required to resolve provided identities.","pattern":"^[A-Z]{2}$","type":"string"},"dataSource":{"$ref":"#/components/schemas/CustomerDataSource"},"fileFormat":{"$ref":"#/components/schemas/FileFormat"},"updateStrategy":{"$ref":"#/components/schemas/UpdateStrategy"}},"required":["compressionFormat","dataSource","fileFormat","updateStrategy"],"type":"object"},"CreateUploadResponseContent":{"description":"A response containing information about the upload.","properties":{"status":{"$ref":"#/components/schemas/Status"},"uploadId":{"description":"The ID of the upload request.","type":"string"},"warnings":{"description":"A list of warnings associated with the upload creation.","items":{"$ref":"#/components/schemas/Warning"},"type":"array"}},"type":"object"},"CreateUserDeletionRequestRequestContent":{"description":"A request to delete some user identities from previously uploaded data.","properties":{"targetIdentities":{"description":"Identities to be deleted. Max number of identities to delete is 1,000 per request.","items":{"$ref":"#/components/schemas/Identity"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["targetIdentities"],"type":"object"},"CreateUserDeletionRequestResponseContent":{"description":"A response containing information about the deletion request.","properties":{"userDeletionRequestId":{"description":"The request ID of the user deletion request.","type":"string"}},"required":["userDeletionRequestId"],"type":"object"},"CsvDataFormat":{"description":"Represents a CSV data format, and the values needed to ingest the source CSV file.","properties":{"commentCharacter":{"description":"Optional. String representing the comment character for a CSV file. Default is none.","type":"string"},"fieldDelimiter":{"description":"Optional. String representing the field delimiter for a CSV file. Default is `,`.","type":"string"},"quoteCharacter":{"description":"Optional. String representing the quote character for a CSV file. Default is `\"`.","type":"string"},"quoteEscapeCharacter":{"description":"Optional. String representing the quote escape character for a CSV file. Default is `\\`.","type":"string"},"recordDelimiter":{"description":"Optional. String representing the record delimiter for a CSV file. Default is `\\n`.","type":"string"}},"type":"object"},"CustomerDataSource":{"description":"Describes the source of the data. Exactly one of `sourceManifestS3Key`, `sourceFileS3Key`, or `sourceS3Prefix` must be provided.","properties":{"sourceFileS3Key":{"description":"S3 key of the single object to upload.","type":"string"},"sourceManifestS3Key":{"description":"S3 key of the manifest containing the object(s) to upload.","type":"string"},"sourceS3Bucket":{"description":"S3 bucket that is the source of the upload.","maxLength":63,"minLength":3,"type":"string"},"sourceS3Prefix":{"description":"S3 key prefix containing the object(s) to upload.","type":"string"}},"required":["sourceS3Bucket"],"type":"object"},"DataSet":{"description":"The definition of a data set.","properties":{"columns":{"description":"A list of data set columns.","items":{"$ref":"#/components/schemas/Column"},"maxItems":100,"minItems":0,"type":"array"},"countryCode":{"description":"Optional. A field that specifies a country. Values corresponds to ISO-3166 codes for country definitions. Required to resolve provided identities.","pattern":"^[A-Z]{2}$","type":"string"},"customerEncryptionKeyArn":{"description":"Optional. If the data being uploaded is encrypted with a customer-managed encryption key, the ARN of said encryption key.","type":"string"},"dataSetId":{"description":"The unique identifier of the data set. Used to query the data set. Cannot contain spaces.","type":"string"},"description":{"description":"Optional. The human-readable description of the data set.","type":"string"},"period":{"$ref":"#/components/schemas/TimePartitionGranularity"},"warnings":{"description":"A list of warnings associated with the data set.","items":{"$ref":"#/components/schemas/Warning"},"type":"array"}},"required":["columns","dataSetId"],"type":"object"},"DataType":{"description":"The data type for the data stored in this column.","enum":["DATE","DECIMAL","INTEGER","LONG","STRING","TIMESTAMP"],"type":"string"},"DeleteColumnFromDataSetResponseContent":{"description":"A response containing the updated data set without the deleted column.","properties":{"dataSet":{"$ref":"#/components/schemas/DataSet"}},"type":"object"},"DeleteDataSetResponseContent":{"description":"A response containing identifiers of the deleted data set.","properties":{"dataSetId":{"description":"The data set ID of the deleted data set.","type":"string"},"instanceId":{"description":"The instance ID of the instance.","type":"string"}},"type":"object"},"ExternalIdentity":{"description":"Representation of an External Identity to be removed. Contains the type of the ID, and the String value of the ID.","properties":{"type":{"$ref":"#/components/schemas/ExternalIdentityType"},"value":{"type":"string"}},"required":["type","value"],"type":"object"},"ExternalIdentityType":{"description":"The external ID types that we support.","enum":["EXPERIAN","IDFA","KANTAR","LIVERAMP","MAID","MERKLE","NEUSTAR","REALID","SAMBATV"],"type":"string"},"FileFormat":{"description":"The format in which data to be uploaded is stored. Exactly one of `csvDataFormat`, `jsonDataFormat`, or `parquetDataFormat` must be provided.","oneOf":[{"properties":{"csvDataFormat":{"$ref":"#/components/schemas/CsvDataFormat"}},"required":["csvDataFormat"],"title":"csvDataFormat","type":"object"},{"properties":{"jsonDataFormat":{"$ref":"#/components/schemas/JsonDataFormat"}},"required":["jsonDataFormat"],"title":"jsonDataFormat","type":"object"},{"properties":{"parquetDataFormat":{"$ref":"#/components/schemas/ParquetDataFormat"}},"required":["parquetDataFormat"],"title":"parquetDataFormat","type":"object"}]},"ForbiddenRequestExceptionResponseContent":{"description":"Forbidden. The request failed because the user does not have access to the specified resource.","properties":{"code":{"description":"The error code associated with the exception.","type":"string"},"details":{"description":"The error code associated with the exception.","type":"string"},"errors":{"description":"The error message(s) associated with the exception.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"requestId":{"description":"The request ID associated with the exception.","type":"string"}},"type":"object"},"GatewayTimeoutExceptionResponseContent":{"description":"Internal server timeout waiting on upstream service. Retry later. Contact support if this response persists.","properties":{"code":{"description":"The error code associated with the exception.","type":"string"},"details":{"description":"The error code associated with the exception.","type":"string"},"errors":{"description":"The error message(s) associated with the exception.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"requestId":{"description":"The request ID associated with the exception.","type":"string"}},"type":"object"},"GetDataSetResponseContent":{"description":"A response containing the definition of the data set.","properties":{"dataSet":{"$ref":"#/components/schemas/DataSet"}},"type":"object"},"GetUploadResponseContent":{"description":"A response containing information about the upload.","properties":{"upload":{"$ref":"#/components/schemas/Upload"}},"type":"object"},"GetUserDeletionRequestResponseContent":{"description":"A response containing information about the user deletion request.","properties":{"identityDeletion":{"$ref":"#/components/schemas/UserDeletion"}},"type":"object"},"HashedIdentity":{"additionalProperties":{"type":"string"},"description":"One or more pairs of a Hashed PII type and corresponding hashed value, representing a single individual to be deleted.","type":"object"},"HashedPiiType":{"description":"The type of hashed PII.","enum":["ADDRESS","CITY","COUNTRY_CODE","EMAIL","FIRST_NAME","IP","LAST_NAME","PHONE","STATE","ZIP"],"type":"string"},"Identity":{"description":"The user identity to be deleted. Either an ExternalId or a collection of Hashed PII values representing a single user.","oneOf":[{"properties":{"externalIdentity":{"$ref":"#/components/schemas/ExternalIdentity"}},"required":["externalIdentity"],"title":"externalIdentity","type":"object"},{"properties":{"hashedIdentity":{"$ref":"#/components/schemas/HashedIdentity"}},"required":["hashedIdentity"],"title":"hashedIdentity","type":"object"},{"properties":{"plaintextIdentity":{"$ref":"#/components/schemas/PlaintextIdentity"}},"required":["plaintextIdentity"],"title":"plaintextIdentity","type":"object"}]},"InternalServerExceptionResponseContent":{"description":"Internal server error. Retry later. Contact support if this response persists.","properties":{"code":{"description":"The error code associated with the exception.","type":"string"},"details":{"description":"The error code associated with the exception.","type":"string"},"errors":{"description":"The error message(s) associated with the exception.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"requestId":{"description":"The request ID associated with the exception.","type":"string"}},"type":"object"},"JsonDataFormat":{"description":"Represents a JSON data format, and the values needed to ingest the source JSON file.","enum":["DOCUMENT","LINES"],"type":"string"},"ListDataSetsResponseContent":{"description":"A response containing a list of data sets for the specified instance.","properties":{"dataSets":{"description":"The list of data sets returned by the request.","items":{"$ref":"#/components/schemas/DataSet"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"description":"Optional. Token to use in subsequent request to retrieve next page of results. Null if all results have been returned.","type":"string"}},"type":"object"},"ListUploadsResponseContent":{"description":"A response containing a list of uploads for the specified instance.","properties":{"nextToken":{"description":"Optional. Token to use in subsequent request to retrieve next page of results. Null if all results have been returned.","type":"string"},"uploads":{"description":"The list of uploads for the specified instance.","items":{"$ref":"#/components/schemas/Upload"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"ListUserDeletionRequestsResponseContent":{"description":"A response containing a list of user deletion requests.","properties":{"nextToken":{"description":"Optional. Token to use in subsequent request to retrieve next page of results. Null if all results have been returned.","type":"string"},"userDeletions":{"description":"List of identity deletions.","items":{"$ref":"#/components/schemas/UserDeletion"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"MetricsMap":{"additionalProperties":{"description":"The numerical value of the metric.","format":"double","type":"number"},"description":"A map containing metrics about an upload, where the key is the name of the metric and the value is a double representing the numerical value of said metric.","type":"object"},"ParquetDataFormat":{"description":"Represents a Parquet data format, and the values needed to ingest the source Parquet file.","enum":["PARQUET_DATA_FORMAT"],"type":"string"},"PlaintextIdentity":{"additionalProperties":{"type":"string"},"description":"One or more pairs of a Plaintext PII type and corresponding plaintext value, representing a single individual to be deleted.","type":"object"},"PlaintextPiiType":{"description":"The type of raw (plaintext) PII.","enum":["IP"],"type":"string"},"ResourceNotFoundExceptionResponseContent":{"description":"The requested resource was not found.","properties":{"code":{"description":"The error code associated with the exception.","type":"string"},"details":{"description":"The error code associated with the exception.","type":"string"},"errors":{"description":"The error message(s) associated with the exception.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"requestId":{"description":"The request ID associated with the exception.","type":"string"}},"type":"object"},"Status":{"description":"The status of the upload.","enum":["FAILED","IN_PROGRESS","SUBMITTED","SUCCESS"],"type":"string"},"TimePartitionGranularity":{"description":"For FACT data sets only. Time partition granularity denotes the granularity of partition performed during the upload. For ex: P1D is a day partitioned data set, i.e. during upload data will be partitioned on event time by day.","enum":["P1D","P1M","PT1H"],"type":"string"},"TooManyRequestsExceptionResponseContent":{"description":"Too Many Requests. The request was rate-limited. Retry later.","properties":{"code":{"description":"The error code associated with the exception.","type":"string"},"details":{"description":"The error code associated with the exception.","type":"string"},"errors":{"description":"The error message(s) associated with the exception.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"requestId":{"description":"The request ID associated with the exception.","type":"string"}},"type":"object"},"UnauthorizedRequestExceptionResponseContent":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","properties":{"code":{"description":"The error code associated with the exception.","type":"string"},"details":{"description":"The error code associated with the exception.","type":"string"},"errors":{"description":"The error message(s) associated with the exception.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"requestId":{"description":"The request ID associated with the exception.","type":"string"}},"type":"object"},"UpdateColumnInDataSetRequestContent":{"description":"A request to update a column in a data set.","properties":{"updateDescription":{"description":"Optional. An updated column description.","maxLength":255,"minLength":0,"type":"string"},"updatedColumnName":{"description":"Optional. An updated column name.","type":"string"}},"type":"object"},"UpdateColumnInDataSetResponseContent":{"description":"A response containing the updated data set containing the updated column.","properties":{"dataSet":{"$ref":"#/components/schemas/DataSet"}},"type":"object"},"UpdateDataSetRequestContent":{"description":"A request to update a data set definition.","properties":{"countryCode":{"description":"Optional. A field that specifies a country. Values corresponds to ISO-3166 codes for country definitions. Required to resolve provided identities.","pattern":"^[A-Z]{2}$","type":"string"},"description":{"description":"Optional. An updated description of the data set defintion.","maxLength":255,"minLength":0,"type":"string"}},"type":"object"},"UpdateDataSetResponseContent":{"description":"A response containing the updated data set definition.","properties":{"dataSet":{"$ref":"#/components/schemas/DataSet"}},"type":"object"},"UpdateStrategy":{"description":"Represents the update strategy to be used when updating the data set.","enum":["ADDITIVE","FULL_REPLACE","OVERLAP_KEEP","OVERLAP_REPLACE"],"type":"string"},"Upload":{"description":"The available metadata about a previously submitted upload.","properties":{"countryCode":{"description":"Optional. A field that specifies a country. Values corresponds to ISO-3166 codes for country definitions. Required to resolve provided identities.","type":"string"},"createdAt":{"description":"A timestamp representing the time the upload was created.","type":"string"},"dataSetId":{"description":"The data set ID of the upload.","type":"string"},"dataSource":{"$ref":"#/components/schemas/CustomerDataSource"},"instanceId":{"description":"The instance ID of the upload.","type":"string"},"message":{"description":"A message specifying details of the upload. This is usually an error message describing a failure.","type":"string"},"metrics":{"$ref":"#/components/schemas/MetricsMap"},"status":{"$ref":"#/components/schemas/Status"},"updatedAt":{"description":"A timestamp representing the last time the upload was updated.","type":"string"},"uploadId":{"description":"The unique identifier for an upload.","type":"string"},"warnings":{"description":"A list of warnings associated with the upload.","items":{"$ref":"#/components/schemas/Warning"},"type":"array"}},"type":"object"},"UserDeletion":{"description":"The available metadata about a previously submitted user deletion request.","properties":{"creationDateTime":{"description":"A timestamp representing the time the user deletion request was created. This field is in UTC and is formatted as yyyy-MM-dd\u0027T\u0027HH:mm:ss\u0027Z\u0027.","format":"date-time","type":"string"},"identityCount":{"description":"The number of identities requested for user deletion.","type":"number"},"status":{"$ref":"#/components/schemas/UserDeletionStatus"},"userDeletionRequestId":{"description":"The request ID of the user deletion request.","type":"string"}},"type":"object"},"UserDeletionStatus":{"enum":["PENDING","SUCCEEDED"],"type":"string"},"UserIdType":{"description":"Specifies the type of an identity. An identity column may represent either a single hashed PII attribute, or an external identity in one of the supported identity spaces.","oneOf":[{"properties":{"externalIdentity":{"$ref":"#/components/schemas/ExternalIdentityType"}},"required":["externalIdentity"],"title":"externalIdentity","type":"object"},{"properties":{"hashedPii":{"$ref":"#/components/schemas/HashedPiiType"}},"required":["hashedPii"],"title":"hashedPii","type":"object"},{"properties":{"plaintextPii":{"$ref":"#/components/schemas/PlaintextPiiType"}},"required":["plaintextPii"],"title":"plaintextPii","type":"object"}]},"Warning":{"description":"A customer-facing warning.","properties":{"message":{"description":"The warning message.","type":"string"}},"required":["message"],"type":"object"}},"securitySchemes":{}},"info":{"description":"AMC Advertiser Data Upload allows advertisers to upload customizable data sets to an AMC instance. Advertiser uploaded data sets can include any combination of columns defined by the advertiser.","title":"Advertiser Data Upload","version":"3.0"},"openapi":"3.0.1","paths":{"/amc/advertiserData/{instanceId}/dataSets":{"post":{"description":"Creates a new data set. You must create a data set before you can upload data to it.\n\n**Requires one of these permissions**:\n[]","operationId":"CreateDataSet","parameters":[{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"description":"The instance identifier.","type":"string"}},{"description":"The global ads account/DSP advertiser account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The global ads account/DSP advertiser account ID.","type":"string"}},{"description":"The Amazon Marketing Cloud Account ID.","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"description":"The Amazon Marketing Cloud Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The Marketplace ID.","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"description":"The Marketplace ID.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-name","schema":{"description":"Reserved.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-version","schema":{"description":"Reserved.","type":"string"}}],"requestBody":{"content":{"application/vnd.amcadvertiserdataset.v1+json":{"schema":{"$ref":"#/components/schemas/CreateDataSetRequestContent"}}},"required":true},"responses":{"200":{"content":{"application/vnd.amcadvertiserdataset.v1+json":{"schema":{"$ref":"#/components/schemas/CreateDataSetResponseContent"}}},"description":"CreateDataSet 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedRequestExceptionResponseContent"}}},"description":"UnauthorizedRequestException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenRequestExceptionResponseContent"}}},"description":"ForbiddenRequestException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsExceptionResponseContent"}}},"description":"TooManyRequestsException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutExceptionResponseContent"}}},"description":"GatewayTimeoutException 504 response"}},"tags":["Data Set"]}},"/amc/advertiserData/{instanceId}/dataSets/list":{"post":{"description":"Gets a paginated list of data sets for a specified instance.\n\n**Requires one of these permissions**:\n[]","operationId":"ListDataSets","parameters":[{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"description":"The instance identifier.","type":"string"}},{"description":"Optional. Token to retrieve subsequent page of results.","in":"query","name":"nextToken","schema":{"description":"Optional. Token to retrieve subsequent page of results.","type":"string"}},{"description":"Optional. Limits the number of items to return in the response. Max value is 100. Defaults to 100.","in":"query","name":"maxResults","schema":{"description":"Optional. Limits the number of items to return in the response. Max value is 100. Defaults to 100.","maximum":100,"minimum":1,"type":"number"}},{"description":"The global ads account/DSP advertiser account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The global ads account/DSP advertiser account ID.","type":"string"}},{"description":"The Amazon Marketing Cloud Account ID.","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"description":"The Amazon Marketing Cloud Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The Marketplace ID.","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"description":"The Marketplace ID.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-name","schema":{"description":"Reserved.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-version","schema":{"description":"Reserved.","type":"string"}}],"responses":{"200":{"content":{"application/vnd.amcadvertiserdataset.v1+json":{"schema":{"$ref":"#/components/schemas/ListDataSetsResponseContent"}}},"description":"ListDataSets 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedRequestExceptionResponseContent"}}},"description":"UnauthorizedRequestException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenRequestExceptionResponseContent"}}},"description":"ForbiddenRequestException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsExceptionResponseContent"}}},"description":"TooManyRequestsException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutExceptionResponseContent"}}},"description":"GatewayTimeoutException 504 response"}},"tags":["Data Set"]}},"/amc/advertiserData/{instanceId}/dataSets/{dataSetId}":{"delete":{"description":"Deletes the specified data set. WARNING: This is an irreversible action. All data associated with the data set will be deleted and will no longer be available for querying.\n\n**Requires one of these permissions**:\n[]","operationId":"DeleteDataSet","parameters":[{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"description":"The instance identifier.","type":"string"}},{"description":"The requested data set identifier.","in":"path","name":"dataSetId","required":true,"schema":{"description":"The requested data set identifier.","pattern":"^(?!list$).*$","type":"string"}},{"description":"The global ads account/DSP advertiser account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The global ads account/DSP advertiser account ID.","type":"string"}},{"description":"The Amazon Marketing Cloud Account ID.","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"description":"The Amazon Marketing Cloud Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The Marketplace ID.","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"description":"The Marketplace ID.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-name","schema":{"description":"Reserved.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-version","schema":{"description":"Reserved.","type":"string"}}],"responses":{"200":{"content":{"application/vnd.amcadvertiserdataset.v1+json":{"schema":{"$ref":"#/components/schemas/DeleteDataSetResponseContent"}}},"description":"DeleteDataSet 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedRequestExceptionResponseContent"}}},"description":"UnauthorizedRequestException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenRequestExceptionResponseContent"}}},"description":"ForbiddenRequestException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsExceptionResponseContent"}}},"description":"TooManyRequestsException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutExceptionResponseContent"}}},"description":"GatewayTimeoutException 504 response"}},"tags":["Data Set"]},"get":{"description":"Gets the specified data set defintion.\n\n**Requires one of these permissions**:\n[]","operationId":"GetDataSet","parameters":[{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"description":"The instance identifier.","type":"string"}},{"description":"The requested data set identifier.","in":"path","name":"dataSetId","required":true,"schema":{"description":"The requested data set identifier.","pattern":"^(?!list$).*$","type":"string"}},{"description":"The global ads account/DSP advertiser account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The global ads account/DSP advertiser account ID.","type":"string"}},{"description":"The Amazon Marketing Cloud Account ID.","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"description":"The Amazon Marketing Cloud Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The Marketplace ID.","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"description":"The Marketplace ID.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-name","schema":{"description":"Reserved.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-version","schema":{"description":"Reserved.","type":"string"}}],"responses":{"200":{"content":{"application/vnd.amcadvertiserdataset.v1+json":{"schema":{"$ref":"#/components/schemas/GetDataSetResponseContent"}}},"description":"GetDataSet 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedRequestExceptionResponseContent"}}},"description":"UnauthorizedRequestException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenRequestExceptionResponseContent"}}},"description":"ForbiddenRequestException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsExceptionResponseContent"}}},"description":"TooManyRequestsException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutExceptionResponseContent"}}},"description":"GatewayTimeoutException 504 response"}},"tags":["Data Set"]},"put":{"description":"Updates the specified data set definition.\n\n**Requires one of these permissions**:\n[]","operationId":"UpdateDataSet","parameters":[{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"description":"The instance identifier.","type":"string"}},{"description":"The requested data set identifier.","in":"path","name":"dataSetId","required":true,"schema":{"description":"The requested data set identifier.","pattern":"^(?!list$).*$","type":"string"}},{"description":"The global ads account/DSP advertiser account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The global ads account/DSP advertiser account ID.","type":"string"}},{"description":"The Amazon Marketing Cloud Account ID.","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"description":"The Amazon Marketing Cloud Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The Marketplace ID.","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"description":"The Marketplace ID.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-name","schema":{"description":"Reserved.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-version","schema":{"description":"Reserved.","type":"string"}}],"requestBody":{"content":{"application/vnd.amcadvertiserdataset.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateDataSetRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.amcadvertiserdataset.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateDataSetResponseContent"}}},"description":"UpdateDataSet 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedRequestExceptionResponseContent"}}},"description":"UnauthorizedRequestException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenRequestExceptionResponseContent"}}},"description":"ForbiddenRequestException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsExceptionResponseContent"}}},"description":"TooManyRequestsException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutExceptionResponseContent"}}},"description":"GatewayTimeoutException 504 response"}},"tags":["Data Set"]}},"/amc/advertiserData/{instanceId}/dataSets/{dataSetId}/columns":{"post":{"description":"Creates a new column and adds it to the specified data set.\n\n**Requires one of these permissions**:\n[]","operationId":"AddColumnToDataSet","parameters":[{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"description":"The instance identifier.","type":"string"}},{"description":"The requested data set identifier.","in":"path","name":"dataSetId","required":true,"schema":{"description":"The requested data set identifier.","pattern":"^(?!list$).*$","type":"string"}},{"description":"The global ads account/DSP advertiser account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The global ads account/DSP advertiser account ID.","type":"string"}},{"description":"The Amazon Marketing Cloud Account ID.","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"description":"The Amazon Marketing Cloud Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The Marketplace ID.","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"description":"The Marketplace ID.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-name","schema":{"description":"Reserved.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-version","schema":{"description":"Reserved.","type":"string"}}],"requestBody":{"content":{"application/vnd.amcadvertiserdatasetcolumn.v1+json":{"schema":{"$ref":"#/components/schemas/AddColumnToDataSetRequestContent"}}},"required":true},"responses":{"200":{"content":{"application/vnd.amcadvertiserdatasetcolumn.v1+json":{"schema":{"$ref":"#/components/schemas/AddColumnToDataSetResponseContent"}}},"description":"AddColumnToDataSet 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedRequestExceptionResponseContent"}}},"description":"UnauthorizedRequestException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenRequestExceptionResponseContent"}}},"description":"ForbiddenRequestException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsExceptionResponseContent"}}},"description":"TooManyRequestsException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutExceptionResponseContent"}}},"description":"GatewayTimeoutException 504 response"}},"tags":["Data Set Column"]}},"/amc/advertiserData/{instanceId}/dataSets/{dataSetId}/columns/{columnName}":{"delete":{"description":"Deletes a column from the specified data set.\n\n**Requires one of these permissions**:\n[]","operationId":"DeleteColumnFromDataSet","parameters":[{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"description":"The instance identifier.","type":"string"}},{"description":"The requested data set identifier.","in":"path","name":"dataSetId","required":true,"schema":{"description":"The requested data set identifier.","pattern":"^(?!list$).*$","type":"string"}},{"description":"The requested data set column identifier.","in":"path","name":"columnName","required":true,"schema":{"description":"The requested data set column identifier.","type":"string"}},{"description":"The global ads account/DSP advertiser account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The global ads account/DSP advertiser account ID.","type":"string"}},{"description":"The Amazon Marketing Cloud Account ID.","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"description":"The Amazon Marketing Cloud Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The Marketplace ID.","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"description":"The Marketplace ID.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-name","schema":{"description":"Reserved.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-version","schema":{"description":"Reserved.","type":"string"}}],"responses":{"200":{"content":{"application/vnd.amcadvertiserdatasetcolumn.v1+json":{"schema":{"$ref":"#/components/schemas/DeleteColumnFromDataSetResponseContent"}}},"description":"DeleteColumnFromDataSet 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedRequestExceptionResponseContent"}}},"description":"UnauthorizedRequestException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenRequestExceptionResponseContent"}}},"description":"ForbiddenRequestException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsExceptionResponseContent"}}},"description":"TooManyRequestsException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutExceptionResponseContent"}}},"description":"GatewayTimeoutException 504 response"}},"tags":["Data Set Column"]},"put":{"description":"Updates a column in the specified data set.\n\n**Requires one of these permissions**:\n[]","operationId":"UpdateColumnInDataSet","parameters":[{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"description":"The instance identifier.","type":"string"}},{"description":"The requested data set identifier.","in":"path","name":"dataSetId","required":true,"schema":{"description":"The requested data set identifier.","pattern":"^(?!list$).*$","type":"string"}},{"description":"The requested data set column identifier.","in":"path","name":"columnName","required":true,"schema":{"description":"The requested data set column identifier.","type":"string"}},{"description":"The global ads account/DSP advertiser account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The global ads account/DSP advertiser account ID.","type":"string"}},{"description":"The Amazon Marketing Cloud Account ID.","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"description":"The Amazon Marketing Cloud Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The Marketplace ID.","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"description":"The Marketplace ID.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-name","schema":{"description":"Reserved.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-version","schema":{"description":"Reserved.","type":"string"}}],"requestBody":{"content":{"application/vnd.amcadvertiserdatasetcolumn.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateColumnInDataSetRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.amcadvertiserdatasetcolumn.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateColumnInDataSetResponseContent"}}},"description":"UpdateColumnInDataSet 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedRequestExceptionResponseContent"}}},"description":"UnauthorizedRequestException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenRequestExceptionResponseContent"}}},"description":"ForbiddenRequestException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsExceptionResponseContent"}}},"description":"TooManyRequestsException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutExceptionResponseContent"}}},"description":"GatewayTimeoutException 504 response"}},"tags":["Data Set Column"]}},"/amc/advertiserData/{instanceId}/uploads/list":{"post":{"description":"Gets a paginated list of previously submitted uploads for a specified instance.\n\n**Requires one of these permissions**:\n[]","operationId":"ListUploads","parameters":[{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"description":"The instance identifier.","type":"string"}},{"description":"Optional. Token to retrieve subsequent page of results.","in":"query","name":"nextToken","schema":{"description":"Optional. Token to retrieve subsequent page of results.","type":"string"}},{"description":"Optional. Timestamp to filter the uploads on.","in":"query","name":"createdAt","schema":{"description":"Optional. Timestamp to filter the uploads on.","type":"string"}},{"description":"Optional. If a createdAt is provided, a comparator should be provided.","in":"query","name":"createdAtComparator","schema":{"$ref":"#/components/schemas/ComparatorOperator"}},{"description":"Optional. The ID of the data set whose uploads to list.","in":"query","name":"dataSetId","schema":{"description":"Optional. The ID of the data set whose uploads to list.","type":"string"}},{"description":"Optional. Limits the number of items to return in the response. Max value is 100. Defaults to 100.","in":"query","name":"maxResults","schema":{"description":"Optional. Limits the number of items to return in the response. Max value is 100. Defaults to 100.","maximum":100,"minimum":1,"type":"number"}},{"description":"Optional. Status of upload to filter on.","in":"query","name":"status","schema":{"$ref":"#/components/schemas/Status"}},{"description":"The global ads account/DSP advertiser account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The global ads account/DSP advertiser account ID.","type":"string"}},{"description":"The Amazon Marketing Cloud Account ID.","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"description":"The Amazon Marketing Cloud Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The Marketplace ID.","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"description":"The Marketplace ID.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-name","schema":{"description":"Reserved.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-version","schema":{"description":"Reserved.","type":"string"}}],"responses":{"200":{"content":{"application/vnd.amcadvertiserdataupload.v1+json":{"schema":{"$ref":"#/components/schemas/ListUploadsResponseContent"}}},"description":"ListUploads 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedRequestExceptionResponseContent"}}},"description":"UnauthorizedRequestException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenRequestExceptionResponseContent"}}},"description":"ForbiddenRequestException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsExceptionResponseContent"}}},"description":"TooManyRequestsException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutExceptionResponseContent"}}},"description":"GatewayTimeoutException 504 response"}},"tags":["Upload"]}},"/amc/advertiserData/{instanceId}/uploads/{dataSetId}":{"post":{"description":"Creates a asynchronous job to upload data to an Amazon Marketing Cloud instance. The request body is used as the definition for the upload. It has a defined set of properties and takes a previously defined data set and imports data into it.\n\n**Requires one of these permissions**:\n[]","operationId":"CreateUpload","parameters":[{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"description":"The instance identifier.","type":"string"}},{"description":"The requested data set identifier.","in":"path","name":"dataSetId","required":true,"schema":{"description":"The requested data set identifier.","pattern":"^(?!list$).*$","type":"string"}},{"description":"The global ads account/DSP advertiser account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The global ads account/DSP advertiser account ID.","type":"string"}},{"description":"The Amazon Marketing Cloud Account ID.","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"description":"The Amazon Marketing Cloud Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The Marketplace ID.","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"description":"The Marketplace ID.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-name","schema":{"description":"Reserved.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-version","schema":{"description":"Reserved.","type":"string"}}],"requestBody":{"content":{"application/vnd.amcadvertiserdataupload.v1+json":{"schema":{"$ref":"#/components/schemas/CreateUploadRequestContent"}}},"required":true},"responses":{"200":{"content":{"application/vnd.amcadvertiserdataupload.v1+json":{"schema":{"$ref":"#/components/schemas/CreateUploadResponseContent"}}},"description":"CreateUpload 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedRequestExceptionResponseContent"}}},"description":"UnauthorizedRequestException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenRequestExceptionResponseContent"}}},"description":"ForbiddenRequestException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsExceptionResponseContent"}}},"description":"TooManyRequestsException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutExceptionResponseContent"}}},"description":"GatewayTimeoutException 504 response"}},"tags":["Upload"]}},"/amc/advertiserData/{instanceId}/uploads/{dataSetId}/{uploadId}":{"get":{"description":"Gets the details of a previously submitted upload.\n\n**Requires one of these permissions**:\n[]","operationId":"GetUpload","parameters":[{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"description":"The instance identifier.","type":"string"}},{"description":"The requested data set identifier.","in":"path","name":"dataSetId","required":true,"schema":{"description":"The requested data set identifier.","pattern":"^(?!list$).*$","type":"string"}},{"description":"The upload identifier.","in":"path","name":"uploadId","required":true,"schema":{"description":"The upload identifier.","type":"string"}},{"description":"The global ads account/DSP advertiser account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The global ads account/DSP advertiser account ID.","type":"string"}},{"description":"The Amazon Marketing Cloud Account ID.","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"description":"The Amazon Marketing Cloud Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The Marketplace ID.","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"description":"The Marketplace ID.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-name","schema":{"description":"Reserved.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-version","schema":{"description":"Reserved.","type":"string"}}],"responses":{"200":{"content":{"application/vnd.amcadvertiserdataupload.v1+json":{"schema":{"$ref":"#/components/schemas/GetUploadResponseContent"}}},"description":"GetUpload 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedRequestExceptionResponseContent"}}},"description":"UnauthorizedRequestException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenRequestExceptionResponseContent"}}},"description":"ForbiddenRequestException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsExceptionResponseContent"}}},"description":"TooManyRequestsException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutExceptionResponseContent"}}},"description":"GatewayTimeoutException 504 response"}},"tags":["Upload"]}},"/amc/advertiserData/{instanceId}/userDeletionRequest":{"post":{"description":"Creates a request for user deletion given an input set of user identities. Initiates a deletion of these identities from all previously uploaded data. This process is asynchronous, and the returned request ID will not immediately be populated.\n\n**Requires one of these permissions**:\n[]","operationId":"CreateUserDeletionRequest","parameters":[{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"description":"The instance identifier.","type":"string"}},{"description":"The global ads account/DSP advertiser account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The global ads account/DSP advertiser account ID.","type":"string"}},{"description":"The Amazon Marketing Cloud Account ID.","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"description":"The Amazon Marketing Cloud Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The Marketplace ID.","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"description":"The Marketplace ID.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-name","schema":{"description":"Reserved.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-version","schema":{"description":"Reserved.","type":"string"}}],"requestBody":{"content":{"application/vnd.amcadvertiseruserdeletionrequest.v1+json":{"schema":{"$ref":"#/components/schemas/CreateUserDeletionRequestRequestContent"}}},"required":true},"responses":{"200":{"content":{"application/vnd.amcadvertiseruserdeletionrequest.v1+json":{"schema":{"$ref":"#/components/schemas/CreateUserDeletionRequestResponseContent"}}},"description":"CreateUserDeletionRequest 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedRequestExceptionResponseContent"}}},"description":"UnauthorizedRequestException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenRequestExceptionResponseContent"}}},"description":"ForbiddenRequestException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsExceptionResponseContent"}}},"description":"TooManyRequestsException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutExceptionResponseContent"}}},"description":"GatewayTimeoutException 504 response"}},"tags":["User Deletion Request"]}},"/amc/advertiserData/{instanceId}/userDeletionRequest/list":{"post":{"description":"Gets a paginated list of all user deletion requests for a specified instance.\n\n**Requires one of these permissions**:\n[]","operationId":"ListUserDeletionRequests","parameters":[{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"description":"The instance identifier.","type":"string"}},{"description":"Optional. Token to retrieve subsequent page of results.","in":"query","name":"nextToken","schema":{"description":"Optional. Token to retrieve subsequent page of results.","type":"string"}},{"description":"Optional. Limits the number of items to return in the response. Max value is 100. Defaults to 100.","in":"query","name":"maxResults","schema":{"description":"Optional. Limits the number of items to return in the response. Max value is 100. Defaults to 100.","maximum":100,"minimum":0,"type":"number"}},{"description":"The global ads account/DSP advertiser account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The global ads account/DSP advertiser account ID.","type":"string"}},{"description":"The Amazon Marketing Cloud Account ID.","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"description":"The Amazon Marketing Cloud Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The Marketplace ID.","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"description":"The Marketplace ID.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-name","schema":{"description":"Reserved.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-version","schema":{"description":"Reserved.","type":"string"}}],"responses":{"200":{"content":{"application/vnd.amcadvertiseruserdeletionrequest.v1+json":{"schema":{"$ref":"#/components/schemas/ListUserDeletionRequestsResponseContent"}}},"description":"ListUserDeletionRequests 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedRequestExceptionResponseContent"}}},"description":"UnauthorizedRequestException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenRequestExceptionResponseContent"}}},"description":"ForbiddenRequestException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsExceptionResponseContent"}}},"description":"TooManyRequestsException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutExceptionResponseContent"}}},"description":"GatewayTimeoutException 504 response"}},"tags":["User Deletion Request"]}},"/amc/advertiserData/{instanceId}/userDeletionRequest/{userDeletionRequestId}":{"get":{"description":"Gets available metadata about a previously initiated user deletion.\n\n**Requires one of these permissions**:\n[]","operationId":"GetUserDeletionRequest","parameters":[{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"description":"The instance identifier.","type":"string"}},{"description":"The request ID for the user deletion request.","in":"path","name":"userDeletionRequestId","required":true,"schema":{"description":"The request ID for the user deletion request.","type":"string"}},{"description":"The global ads account/DSP advertiser account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The global ads account/DSP advertiser account ID.","type":"string"}},{"description":"The Amazon Marketing Cloud Account ID.","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"description":"The Amazon Marketing Cloud Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The Marketplace ID.","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"description":"The Marketplace ID.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-name","schema":{"description":"Reserved.","type":"string"}},{"description":"Reserved.","in":"header","name":"x-amzn-service-version","schema":{"description":"Reserved.","type":"string"}}],"responses":{"200":{"content":{"application/vnd.amcadvertiseruserdeletionrequest.v1+json":{"schema":{"$ref":"#/components/schemas/GetUserDeletionRequestResponseContent"}}},"description":"GetUserDeletionRequest 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedRequestExceptionResponseContent"}}},"description":"UnauthorizedRequestException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenRequestExceptionResponseContent"}}},"description":"ForbiddenRequestException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsExceptionResponseContent"}}},"description":"TooManyRequestsException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutExceptionResponseContent"}}},"description":"GatewayTimeoutException 504 response"}},"tags":["User Deletion Request"]}}}}