Amazon Ads API MCP

{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"AdvertiserType":{"description":"The advertiser type values","enum":["DISPLAY","SAS","SPONSORED_ADS"],"type":"string"},"AmcAdvertiserIdentifier":{"description":"Identifying properties of an advertiser.","properties":{"id":{"description":"Depending on the value for advertiserType, this contains the CFID of a DSP, entity Id for a Sponsored Ads, or advertiser Id for a SAS advertiser.","type":"string"},"marketplaceId":{"description":"For Sponsored Ads and SAS advertisers, this contains the corresponding marketplaceId. This will be null for DSP advertisers.","type":"string"},"type":{"$ref":"#/components/schemas/AdvertiserType"}},"required":["id","type"],"type":"object"},"CreateScheduleRequest":{"allOf":[{"$ref":"#/components/schemas/Schedule"},{"properties":{"marketplaceId":{"description":"The identifier of the marketplace associated with the account.","type":"string"}},"type":"object"}]},"CreateScheduleResponse":{"description":"Empty response object denoting successful creation of a schedule.","type":"object"},"CreateWorkflowExecutionRequest":{"properties":{"additionalAcrResultsReceivers":{"description":"AWS account IDs of additional customer-owned members which should receive the results of this execution through AWS Clean Rooms (ACR).","items":{"type":"string"},"type":"array"},"advertisers":{"description":"Optional - if specified, the execution will only read data for the provided advertisers. If not specified, the execution will read data for all advertisers queryable for the instance.","items":{"$ref":"#/components/schemas/AmcAdvertiserIdentifier"},"type":"array"},"disableAggregationControls":{"description":"Optional - if true privacy controls will NOT be applied to the workflow. \nQuery output can still be retrieved when privacy protection is skipped if only requireSyntheticData is true.","type":"boolean"},"dryRun":{"default":false,"description":"Optional - if true, the execution will be processed but not submitted to compute, at which point the execution will be marked as complete. This can be used to quickly validate workflow executions (e.","type":"boolean"},"maxCertifiedTime":{"description":"The maximum certified time that will be used for input data sets. This parameter can be used to execute a workflow against older versions of data. The use of this parameter is subject to the limitations that older versions of data may not be retained.","type":"string"},"maxDimensionTime":{"description":"The maximum time window end that that will be used for dimension data sets. This parameter can be used to execute a workflow against older versions of dimension data.","type":"string"},"parameterValues":{"additionalProperties":{"type":"string"},"description":"Values to use for the parameters specified in the workflow.","type":"object"},"requireSyntheticData":{"description":"Optional - if true the execution will only be allowed to use data sets that only contain synthetic data.","type":"boolean"},"skipPublish":{"description":"Optional - if true the workflow will be run without writing out results.","type":"boolean"},"timeWindowEnd":{"description":"Optional. Only used with a timeWindowType of EXPLICIT. The end of the time window for input data for the workflow execution.","type":"string"},"timeWindowStart":{"description":"Optional. Only used with a timeWindowType of `EXPLICIT`. The start of the time window for input data for the workflow execution.","type":"string"},"timeWindowTimeZone":{"description":"Optional. The time zone of the specified time window. This applies to both time window start and end if specified for time window type `EXPLICIT` and to the determination of day and month boundaries for other time window types. If not specified, the UTC time zone will be used.","type":"string"},"timeWindowType":{"description":"Optional. The type of time window to use to for specifying input data for the workflow execution. If not provided, the time window type of `MOST_RECENT_DAY` will be used.","enum":["ALL","CURRENT_MONTH","EXPLICIT","MOST_RECENT_DAY","MOST_RECENT_WEEK","PREVIOUS_MONTH"],"type":"string"},"workflow":{"$ref":"#/components/schemas/Workflow"},"workflowExecutionTimeoutSeconds":{"description":"Optional. If specified, limits the workflow query execution time to the specified number of seconds. The value is required to be at least 900 seconds (15 minutes). Unless configured otherwise, the maximum allowed timeout value is 86400 seconds (24 hours).","type":"integer"},"workflowId":{"description":"The ID of the workflow to execute, if executing an existing workflow.\nRequired if a sqlQuery is not provided. Cannot be populated at the same time as sqlQuery.","type":"string"}},"type":"object"},"CreateWorkflowExecutionResponse":{"properties":{"workflowExecution":{"$ref":"#/components/schemas/WorkflowExecution"}},"type":"object"},"CreateWorkflowResponse":{"description":"Empty response object denoting successful creation of a workflow.","type":"object"},"DataSource":{"description":"Defines a type of data that may be used as a source for queries in workflows or data views. A data source has a flat schema defined by one or more columns. A data source may only be referenced directly in a query by the input data of a select operation or the second input data of a join operation.","properties":{"columns":{"description":"List of data source columns.","items":{"description":"Defines a column in a data source.","properties":{"columnType":{"enum":["DIMENSION","METRIC"],"type":"string"},"description":{"type":"string"},"name":{"type":"string"}},"type":"object"},"maxItems":500,"minItems":0,"type":"array"},"dataSourceId":{"description":"The identifier of the data source.","type":"string"},"description":{"description":"The human-readable description of what the data source contains.","type":"string"},"outputChannels":{"description":"The possible channels for retrieving workflow execution output in this instance with information about whether or not it's possible to retrieve the output of workflow executions that read from this da...","items":{"$ref":"#/components/schemas/DataSourceOutputChannel","properties":{}},"type":"array"},"owner":{"description":"The owner of a data source. The following table lists available owners:\n|Type Name|Description|\n|-----------|-----------|\n|AMAZON|The data source is owned by Amazon.|\n|CUSTOMER|The data source is owned by an external entity.|","enum":["AMAZON","CUSTOMER"],"type":"string"},"provider":{"description":"The provider of the data source.","enum":["ADVERTISER_DATA_UPLOAD","AMAZON"],"type":"string"},"tags":{"description":"List of human-readable tags associated with a data source.","items":{"description":"Defines a tag associated with a data source.","properties":{"description":{"type":"string"},"subtext":{"type":"string"},"title":{"type":"string"},"type":{"enum":["DEPRECATED","NEW","RENAMED"],"type":"string"}},"type":"object"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"DataSourceOutputChannel":{"description":"Contains information about a channel for retrieving workflow execution output in an instance and information about whether or not the output of executions that read from this data source can be retrieved through this channel and if not, why.","properties":{"channel":{"$ref":"#/components/schemas/OutputChannel","description":"The channel for receiving output."},"outputAvailable":{"description":"True if output would be available through this channel for a workflow execution that read from this data source, barring execution-level restrictions.","type":"boolean"},"outputUnavailableReason":{"description":"If output cannot be retrieved through this channel (i.e. `outputAvailable` is false), contains a description of why not. Otherwise, is null.","type":"string"}},"required":["channel","outputAvailable"],"type":"object"},"DeleteScheduleResponse":{"description":"Empty response object denoting successful deletion of a schedule.","type":"object"},"DeleteWorkflowResponse":{"description":"Empty response object denoting successful deletion of a workflow.","type":"object"},"Error":{"description":"The error response object.","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"GetDataSourceResponse":{"properties":{"dataSource":{"$ref":"#/components/schemas/DataSource"}},"type":"object"},"GetScheduleResponse":{"properties":{"schedule":{"$ref":"#/components/schemas/Schedule"}},"type":"object"},"GetWorkflowExecutionDownloadUrlsResponse":{"properties":{"downloadUrls":{"description":"A list of pre-signed S3 URLs for the workflow execution's results. Multiple URLs will be given for results that produce multiple files.","items":{"properties":{},"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"metadataDownloadUrls":{"description":"A list of pre-signed S3 URLs for the workflow execution's metadata used during execution.","items":{"properties":{},"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"nextToken":{"description":"[Placeholder - To be used as a Future Scope] Token to use in subsequent request to retrieve next page of results. Null if all results have been returned.","type":"string"}},"type":"object"},"GetWorkflowExecutionResponse":{"properties":{"workflowExecution":{"$ref":"#/components/schemas/WorkflowExecution"}},"type":"object"},"GetWorkflowResponse":{"properties":{"workflow":{"$ref":"#/components/schemas/Workflow"}},"type":"object"},"ListDataSourcesResponse":{"properties":{"dataSources":{"description":"List of data sources.","items":{"$ref":"#/components/schemas/DataSource","properties":{}},"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"},"ListSchedulesResponse":{"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"},"schedules":{"description":"List of schedules.","items":{"$ref":"#/components/schemas/Schedule","properties":{}},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"ListWorkflowExecutionsResponse":{"properties":{"executions":{"description":"List of workflow executions.","items":{"$ref":"#/components/schemas/WorkflowExecution","properties":{}},"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"},"ListWorkflowsResponse":{"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"},"workflows":{"description":"List of workflows.","items":{"$ref":"#/components/schemas/Workflow","properties":{}},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"OutputChannel":{"description":"Contains information about a channel for retrieving workflow execution output in an instance.","properties":{"acrMemberId":{"description":"The account ID of the AWS Clean Rooms member to which results were delivered. Is only populated for the ACR channel type.","type":"string"},"acrMembershipId":{"description":"The membership ID of the AWS Clean Rooms member to which results were delivered. Is only populated for the ACR channel type.","type":"string"},"type":{"$ref":"#/components/schemas/OutputChannelType","description":"The mechanism for retrieving output."}},"required":["type"],"type":"object"},"OutputChannelType":{"description":"Defines the mechanism for retrieving output for a workflow execution. The following are the possible output channel types:\n|Type|Description|\n|-----------|-----------|\n|DOWNLOAD|The output can be down...","enum":["ACR","DOWNLOAD","PUBLISH"],"type":"string"},"Schedule":{"properties":{"aggregationHourUtc":{"description":"Specifies the number of hours of offset from UTC, which designates the delineating hour for workflow runs.","type":"integer"},"aggregationPeriod":{"description":"The cadence at which to run a workflow. The following table lists available periods:\n|Period Name|Description|\n|-----------|-----------|\n|Daily|Schedule a workflow to run every day.","enum":["Daily","Weekly"],"type":"string"},"aggregationStartDay":{"description":"Day of week to start aggregations. If not specified, this defaults to the day of week that the schedule is created.","enum":["Friday","Monday","Saturday","Sunday","Thursday","Tuesday","Wednesday"],"type":"string"},"disableAggregationControls":{"description":"If true aggregation controls were NOT applied to the workflow. \nQuery output could still be retrieved when aggregation controls were skipped if only requireSyntheticData was true.","type":"boolean"},"requireSyntheticData":{"description":"If true the execution was allowed to use data sets that only contain synthetic data.","type":"boolean"},"scheduleEnabled":{"description":"Boolean flag to signify whether or not the schedule is enabled. Disabled schedules will not run workflows.","type":"boolean"},"scheduleId":{"description":"User-supplied identifier of the schedule.","type":"string"},"workflowId":{"description":"The identifier of the workflow associated with the schedule.","type":"string"}},"type":"object"},"UpdateScheduleResponse":{"description":"Empty response object denoting successful update of a schedule.","type":"object"},"UpdateWorkflowExecutionResponse":{"description":"Empty response object denoting a successful update of a workflow execution.","type":"object"},"UpdateWorkflowResponse":{"description":"Empty response object denoting a successful update of a workflow.","type":"object"},"Workflow":{"description":"Workflows are defined as a set of operations that take previously defined data sources as input and use them to generate reports.","properties":{"filteredMetricsDiscriminatorColumn":{"description":"If this field is not provided, rows which do not meet the minimum distinct user count requirements will be completely filtered out of the workflow output.","type":"string"},"inputParameters":{"description":"Optional. Defines the parameters that can be referenced by workflow definition. If workflow references a parameter not defined here the compilation fails.","items":{"properties":{"columnType":{"description":"The type of the column corresponding to the parameter. The following table lists available types:\n|Type Name|Description|\n|-----------|-----------|\n|METRIC|The column is a quantity or value rather tha...","enum":["DIMENSION","METRIC"],"type":"string"},"dataType":{"description":"The data type of the parameter corresponding to the data type of a column. The following table lists available types:\n|Type Name|Description|\n|-----------|-----------|\n|BINARY|Binary data.","enum":["BINARY","BOOLEAN","BYTE","CALENDAR_INTERVAL","DATE","DECIMAL","DOUBLE","FLOAT","INTEGER","LONG","SHORT","STRING","TIMESTAMP"],"type":"string"},"defaultValue":{"description":"The value to assign to the parameter if no value is provided.","type":"string"},"description":{"description":"The human-readable description of what the parameter is used for.","type":"string"},"displayName":{"description":"The human-readable name of the parameter.","type":"string"},"name":{"description":"The name of the parameter used as a variable in SQL.","type":"string"}},"type":"object"},"maxItems":100,"minItems":0,"type":"array"},"inputSchema":{"description":"Optional. 'null' schema if not provided. Provides the schema to use when resolving unqualified data sources to avoid collisions. Data sources include their schema in their ids, ex: 'sandbox.","type":"string"},"outputColumns":{"description":"Optional. The columns that the workflow must produce as output. If provided, the workflow will be validated during compilation to ensure that the schema of the output from the workflow exactly matches...","items":{"properties":{"columnType":{"description":"The type of the column. The following table lists available types:\n|Type Name|Description|\n|-----------|-----------|\n|METRIC|The column is a quantity or value rather than a dimension.","enum":["DIMENSION","METRIC"],"type":"string"},"dataType":{"description":"The data type of the column. The following table lists available types:\n|Type Name|Description|\n|-----------|-----------|\n|BINARY|Binary data.|\n|BOOLEAN|TRUE or FALSE.","enum":["BINARY","BOOLEAN","BYTE","CALENDAR_INTERVAL","DATE","DECIMAL","DOUBLE","FLOAT","INTEGER","LONG","SHORT","STRING","TIMESTAMP"],"type":"string"},"dataTypePrecision":{"description":"Specifies additional information about the dataType for DataType.DECIMAL. Corresponds to the total number of digits.","type":"integer"},"dataTypeScale":{"description":"Specifies additional information about the dataType DataType.DECIMAL. Corresponds to the number of digits to the right of the decimal point.","type":"integer"},"description":{"description":"The human-readable description of what the parameter is used for.","type":"string"},"name":{"description":"The name of the column.","type":"string"}},"type":"object"},"maxItems":100,"minItems":0,"type":"array"},"outputFormat":{"description":"Specifies the CSV output format for a workflow.","properties":{"escapeCharacter":{"description":"The character to use for escaping characters inside a quoted field.","type":"string"},"quoteCharacter":{"description":"The character to use for quoting fields that need it.","type":"string"},"separatorCharacter":{"description":"The character to use for separating fields.","type":"string"}},"type":"object"},"privacyFilteringBehavior":{"description":"Specifies how workflow output will be processed after sensitive values have been removed. The following table lists available behaviors:\n|Behavior|Description|\n|-----------|-----------|\n|REMOVE_VALUES...","enum":["REMOVE_ROWS","REMOVE_VALUES"],"type":"string"},"query":{"description":"Defines a list of [operations] that produce a set of output data based on input data from one or more [DataSource]s.","items":{"format":"byte","pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","type":"string"},"maxItems":100,"minItems":0,"type":"array"},"sqlQuery":{"description":"The SQL query to run to produce output for the workflow. If a [sqlQuery] and a [query] are both provided, the [sqlQuery] will be used.","type":"string"},"workflowId":{"description":"User-supplied identifier of the workflow.","type":"string"}},"type":"object"},"WorkflowExecution":{"properties":{"acrCollaborationId":{"description":"The ID of the ACR collaboration that the execution is being executed in. Will only be populated for executions where at least one customer-owned member will be receiving results directly from ACR.","type":"string"},"acrCustomerMembershipId":{"description":"The ID of the ACR membership for the primary customer-owned member. Will only be populated for executions where the primary customer-owned member will be receiving results directly from ACR.","type":"string"},"acrDetailPageUrl":{"description":"The URL for the detail page of the ACR protected query performing the compute for this execution. Will only be populated for executions where the primary customer-owned member will be receiving results directly from ACR and where a protected query has already been submitted.","type":"string"},"acrProtectedQueryId":{"description":"The ID for the ACR protected query performing the compute for this execution. Will only be populated for executions where at least one customer-owned member will be receiving results directly from ACR and where a protected query has already been submitted.","type":"string"},"advertisers":{"description":"If the execution was configured to read data for only a specified list of advertisers queryable for the instance, contains the advertisers for which data was read. Null if the execution was not configured to read data for a specific subset of advertisers.","items":{"$ref":"#/components/schemas/AmcAdvertiserIdentifier"},"type":"array"},"createTime":{"description":"The time the workflow execution was created. This field is in UTC and is formatted as yyyy-MM-dd'T'HH:mm:ss'Z'.","type":"string"},"disableAggregationControls":{"description":"If true aggregation controls were NOT applied to the workflow. \nQuery output could still be retrieved when aggregation controls were skipped if only requireSyntheticData was true.","type":"boolean"},"expireTime":{"description":"The time at which the workflow execution will alarm due to SLA breach (if it has not already started running). This field is in UTC and is formatted as yyyy-MM-dd'T'HH:mm:ss'Z'.","type":"string"},"invalidationOffsetSecs":{"description":"How much wider of a time range should be used for fact invalidation data than for fact data, in seconds.","type":"integer"},"lastUpdatedTime":{"description":"The last time the workflow execution was updated. This field is in UTC and is formatted as yyyy-MM-dd'T'HH:mm:ss'Z'.","type":"string"},"outputChannels":{"description":"The possible channels for retrieving workflow execution output in this instance with information about whether or not it's possible to retrieve the output of this workflow execution through the channe...","items":{"$ref":"#/components/schemas/WorkflowExecutionOutputChannel"},"type":"array"},"outputS3URI":{"description":"The fully qualified S3 path at which the output files for the workflow execution will be created inside the AMC instance. Note that the path the files will be created in your AWS account will be the same except for the bucket.","type":"string"},"requireSyntheticData":{"description":"If true the execution was allowed to use data sets that only contain synthetic data.","type":"boolean"},"sqlQuery":{"description":"The SQL query that was executed.\nWill only be populated if includeWorkflow was true for the request to retrieve the execution and the workflow used a SQL query.","type":"string"},"status":{"description":"The current status of the workflow execution. The following table lists available statuses:\n|Status Name|Description|\n|-----------|-----------|\n|PENDING|The workflow execution has not yet started runn...","enum":["CANCELLED","FAILED","PENDING","RUNNING","SUCCEEDED"],"type":"string"},"timeWindowEnd":{"description":"The end of the time window for data being used as input for the workflow execution. This is a nominal time window and not a guarantee that timestamps on any rows will be inside this window. This field is in UTC and is formatted as yyyy-MM-dd'T'HH:mm:ss'Z'.","type":"string"},"timeWindowEndOriginal":{"description":"The originally provided end of the time window. This field is in the original timezone and is formatted as yyyy-MM-dd'T'HH:mm:ss with no offset. The value will be in UTC when the execution was created before this field was added.","type":"string"},"timeWindowStart":{"description":"The start of the time window for data being used as input for the workflow execution. This is a nominal time window and not a guarantee that timestamps on any rows will be inside this window. This field is in UTC and is formatted as yyyy-MM-dd'T'HH:mm:ss'Z'.","type":"string"},"timeWindowStartOriginal":{"description":"The originally provided start of the time window. This field is in the original timezone and is formatted as yyyy-MM-dd'T'HH:mm:ss with no offset. The value will be in UTC when the execution was created before this field was added.","type":"string"},"timeWindowTimeZoneOriginal":{"description":"The timezone provided when creating the workflow execution. This field allows using the timeWindowStartOriginal and timeWindowEndOriginal fields to produce the original localized time window.","type":"string"},"waitUntil":{"description":"The time at which the workflow execution will not start running before. This field is in UTC and is formatted as yyyy-MM-dd'T'HH:mm:ss'Z'.","type":"string"},"workflowExecutionId":{"description":"The unique identifier of the workflow execution.","type":"string"},"workflowExecutionTimeoutSeconds":{"description":"The amount of time that the workflow is allowed to execute in the compute engine. If a workflow exceeds this value, the execution will timeout.","type":"integer"},"workflowId":{"description":"The ID of the workflow being executed. This ID is automatically generated when a new execution is created and can be used to retrieve the status of the execution via the read workflow execution endpoint.","type":"string"}},"type":"object"},"WorkflowExecutionOutputChannel":{"description":"Contains information about a channel for retrieving workflow execution output in an instance and information about whether or not the output of a specific workflow execution can be retrieved through the channel and if not, why.","properties":{"acrDetailPageUrl":{"description":"The URL of the AWS Clean Rooms protected query detail page URL which can be used to view information about this protected query, including information about where the output can be retrieved. Is only populated for the `ACR` channel type.","type":"string"},"channel":{"$ref":"#/components/schemas/OutputChannel","description":"The channel for receiving output."},"status":{"$ref":"#/components/schemas/WorkflowExecutionOutputChannelStatus","description":"A status indicating whether output can be retrieved through the channel now or in the future."},"statusReason":{"description":"If output cannot be retrieved through this channel, contains a description of why not. Otherwise, is null.","type":"string"}},"required":["channel","status"],"type":"object"},"WorkflowExecutionOutputChannelStatus":{"description":"Defines the status of output being available for a workflow execution through a given channel. The following are the possible statuses:\n|Status|Description|\n|-----------|-----------|\n|PENDING|The outp...","enum":["AVAILABLE","FAILED","PENDING","UNAVAILABLE"],"type":"string"}},"securitySchemes":{}},"info":{"title":"Workflow Management Service","version":"3.0"},"openapi":"3.0.1","paths":{"/amc/reporting/{instanceId}/dataSources":{"get":{"description":"Returns a list of available data sources. Data sources can be used as input for reporting workflows. Each data source has a flat schema consisting of a list of columns that each have a name, a data type, and a column typeof metric or dimension.","operationId":"listDataSources","parameters":[{"description":"The identifier of a client associated with an Amazon Developer account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"This header is deprecated. Clients must pass in Amazon-Advertising-API-AdvertiserId and Amazon-Advertising-API-MarketplaceId as headers","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}},{"description":"The AMC Account ID","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"type":"string"}},{"description":"The Marketplace ID","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"type":"string"}},{"description":"Optional. Token to retrieve subsequent page of results.","in":"query","name":"nextToken","schema":{"type":"string"}},{"description":"Optional. Limits the number of items to return in the response. Max value is 100. Defaults to 100.","in":"query","name":"limit","schema":{"type":"string"}},{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.amcdatasources.v1+json":{"schema":{"$ref":"#/components/schemas/ListDataSourcesResponse"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.amcdatasources.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.amcdatasources.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized. Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.amcdatasources.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource."},"422":{"content":{"application/vnd.amcdatasources.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unprocessable Entity - Request was understood, but contained invalid parameters"},"429":{"content":{"application/vnd.amcdatasources.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Too many requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.amcdatasources.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Internal server error. Retry later. Contact support if this response persists."}},"summary":"Returns a list of available data sources.","tags":["Data sources"]}},"/amc/reporting/{instanceId}/dataSources/{dataSourceId}":{"get":{"description":"Gets information about the requested data source. Data sources can be used as input for reporting workflows. Each data source has a flat schema consisting of a list of columns that each have a name, a data type, and a column typeof metric or dimension.","operationId":"getDataSource","parameters":[{"description":"The identifier of a client associated with an Amazon Developer account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"This header is deprecated. Clients must pass in Amazon-Advertising-API-AdvertiserId and Amazon-Advertising-API-MarketplaceId as headers","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}},{"description":"The AMC Account ID","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"type":"string"}},{"description":"The Marketplace ID","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"type":"string"}},{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"type":"string"}},{"description":"The requested data source identifier.","in":"path","name":"dataSourceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.amcdatasources.v1+json":{"schema":{"$ref":"#/components/schemas/GetDataSourceResponse"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.amcdatasources.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.amcdatasources.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized. Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.amcdatasources.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource."},"404":{"content":{"application/vnd.amcdatasources.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not Found. The requested resource either does not exist or the currently authenticated user does not have permission to access it."},"429":{"content":{"application/vnd.amcdatasources.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Too many requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.amcdatasources.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Internal server error. Retry later. Contact support if this response persists."}},"summary":"Gets information about the requested data source.","tags":["Data sources"]}},"/amc/reporting/{instanceId}/schedules":{"get":{"description":"Returns a list of schedules. Schedules are used to specify the periodic execution of a given workflow, on either a daily or weekly cadence.","operationId":"listSchedules","parameters":[{"description":"The identifier of a client associated with an Amazon Developer account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"This header is deprecated. Clients must pass in Amazon-Advertising-API-AdvertiserId and Amazon-Advertising-API-MarketplaceId as headers","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}},{"description":"The AMC Account ID","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"type":"string"}},{"description":"The AMC Account ID","in":"header","name":"Amazon-Ads-AccountId","schema":{"type":"string"}},{"description":"The Marketplace ID","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"type":"string"}},{"description":"Optional. Token to retrieve subsequent page of results.","in":"query","name":"nextToken","schema":{"type":"string"}},{"description":"Optional. Limits the number of items to return in the response. Max value is 100. Defaults to 100.","in":"query","name":"limit","schema":{"type":"string"}},{"description":"Marketplace ID","in":"query","name":"marketplaceId","schema":{"type":"string"}},{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/ListSchedulesResponse"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized. Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource."},"422":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unprocessable Entity - Request was understood, but contained invalid parameters"},"429":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Too many requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Internal server error. Retry later. Contact support if this response persists."}},"summary":"Returns a list of schedules.","tags":["Schedules"]},"post":{"description":"Creates a new schedule. Schedules are used to specify the periodic execution of a given workflow, on either a daily or weekly cadence.","operationId":"createSchedule","parameters":[{"description":"The identifier of a client associated with an Amazon Developer account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"This header is deprecated. Clients must pass in Amazon-Advertising-API-AdvertiserId and Amazon-Advertising-API-MarketplaceId as headers","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}},{"description":"The AMC Account ID","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"type":"string"}},{"description":"The AMC Account ID","in":"header","name":"Amazon-Ads-AccountId","schema":{"type":"string"}},{"description":"The Marketplace ID","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"type":"string"}},{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/CreateScheduleRequest"}}},"description":"Valid schedule definition.","required":true},"responses":{"200":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/CreateScheduleResponse"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized. Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource."},"422":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unprocessable Entity - Request was understood, but contained invalid parameters"},"429":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Too many requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Internal server error. Retry later. Contact support if this response persists."}},"summary":"Creates a new schedule.","tags":["Schedules"]}},"/amc/reporting/{instanceId}/schedules/{scheduleId}":{"delete":{"description":"Deletes the requested schedule. The workflow associated with the schedule will no longer be executed on the specified cadence.","operationId":"deleteSchedule","parameters":[{"description":"The identifier of a client associated with an Amazon Developer account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"This header is deprecated. Clients must pass in Amazon-Advertising-API-AdvertiserId and Amazon-Advertising-API-MarketplaceId as headers","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}},{"description":"The AMC Account ID","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"type":"string"}},{"description":"The Marketplace ID","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"type":"string"}},{"description":"The AMC Account ID","in":"header","name":"Amazon-Ads-AccountId","schema":{"type":"string"}},{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"type":"string"}},{"description":"The requested schedule identifier.","in":"path","name":"scheduleId","required":true,"schema":{"type":"string"}},{"description":"Marketplace ID","in":"query","name":"marketplaceId","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/DeleteScheduleResponse"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized. Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource."},"404":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not Found. The requested resource either does not exist or the currently authenticated user does not have permission to access it."},"429":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Too many requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Internal server error. Retry later. Contact support if this response persists."}},"summary":"Deletes the requested schedule.","tags":["Schedules"]},"get":{"description":"Gets the requested schedule. Schedules are used to specify the periodic execution of a given workflow, on either a daily or weekly cadence.","operationId":"getSchedule","parameters":[{"description":"The identifier of a client associated with an Amazon Developer account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"This header is deprecated. Clients must pass in Amazon-Advertising-API-AdvertiserId and Amazon-Advertising-API-MarketplaceId as headers","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}},{"description":"The AMC Account ID","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"type":"string"}},{"description":"The AMC Account ID","in":"header","name":"Amazon-Ads-AccountId","schema":{"type":"string"}},{"description":"The Marketplace ID","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"type":"string"}},{"description":"Marketplace ID","in":"query","name":"marketplaceId","schema":{"type":"string"}},{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"type":"string"}},{"description":"The requested schedule identifier.","in":"path","name":"scheduleId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/GetScheduleResponse"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized. Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource."},"404":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not Found. The requested resource either does not exist or the currently authenticated user does not have permission to access it."},"429":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Too many requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Internal server error. Retry later. Contact support if this response persists."}},"summary":"Gets the requested schedule.","tags":["Schedules"]},"put":{"description":"Updates the requested schedule. The request body is used as the new schedule definition.","operationId":"updateSchedule","parameters":[{"description":"The identifier of a client associated with an Amazon Developer account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"This header is deprecated. Clients must pass in Amazon-Advertising-API-AdvertiserId and Amazon-Advertising-API-MarketplaceId as headers","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}},{"description":"The AMC Account ID","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"type":"string"}},{"description":"The AMC Account ID","in":"header","name":"Amazon-Ads-AccountId","schema":{"type":"string"}},{"description":"The Marketplace ID","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"type":"string"}},{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"type":"string"}},{"description":"The requested schedule identifier.","in":"path","name":"scheduleId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/CreateScheduleRequest"}}},"description":"Valid schedule definition.","required":true},"responses":{"200":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateScheduleResponse"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized. Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource."},"404":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not Found. The requested resource either does not exist or the currently authenticated user does not have permission to access it."},"422":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unprocessable Entity - Request was understood, but contained invalid parameters"},"429":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Too many requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.amcschedules.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Internal server error. Retry later. Contact support if this response persists."}},"summary":"Updates the requested schedule.","tags":["Schedules"]}},"/amc/reporting/{instanceId}/workflowExecutions":{"get":{"description":"Returns a list of workflow executions. Gets status information about the requested workflow execution.","operationId":"listWorkflowExecutions","parameters":[{"description":"The identifier of a client associated with an Amazon Developer account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"This header is deprecated. Clients must pass in Amazon-Advertising-API-AdvertiserId and Amazon-Advertising-API-MarketplaceId as headers","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}},{"description":"The AMC Account ID","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"type":"string"}},{"description":"The Marketplace ID","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"type":"string"}},{"description":"Optional. Token to retrieve subsequent page of results.","in":"query","name":"nextToken","schema":{"type":"string"}},{"description":"Optional. Limits the number of items to return in the response. Max value is 100. Defaults to 100.","in":"query","name":"limit","schema":{"type":"string"}},{"description":"Optional. If 'true' return items in ascending order by creation time instead of the default, which returns in descending order by creation time.","in":"query","name":"sortAscending","schema":{"default":false,"type":"boolean"}},{"description":"Optional. If 'true' will return executions in the CANCELLED status. By default no CANCELLED executions will be returned.","in":"query","name":"includeCancelled","schema":{"default":false,"type":"boolean"}},{"description":"Optional if workflow id is provided. Exclude all executions prior to min creation time. Required format is yyyy-MM-dd'T'HH:mm:ss (e.g. 2019-08-14T16:12:34).","in":"query","name":"minCreationTime","schema":{"type":"string"}},{"description":"Optional. Exclude all executions after max creation time. Required format is yyyy-MM-dd'T'HH:mm:ss (e.g. 2019-08-14T16:12:34).","in":"query","name":"maxCreationTime","schema":{"type":"string"}},{"description":"Optional. The time zone of the specified creation time. This applies to both mix and max creation time. If not specified, the UTC time zone will be used.","in":"query","name":"timeZone","schema":{"type":"string"}},{"description":"Optional if minCreationTime is provided. Identifier of workflow to filter results on.","in":"query","name":"workflowId","schema":{"type":"string"}},{"description":"Optional. If 'true' includes the workflow definition in the response.","in":"query","name":"includeWorkflow","schema":{"default":false,"type":"boolean"}},{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/ListWorkflowExecutionsResponse"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized. Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource."},"422":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unprocessable Entity - Request was understood, but contained invalid parameters"},"429":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Too many requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Internal server error. Retry later. Contact support if this response persists."}},"summary":"Returns a list of workflow executions.","tags":["Workflow executions"]},"post":{"description":"Creates a new, ad-hoc execution of an existing workflow. Workflow executions are asyncronous and will typically take at least 15 minutes to execute.","operationId":"createWorkflowExecution","parameters":[{"description":"The identifier of a client associated with an Amazon Developer account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"This header is deprecated. Clients must pass in Amazon-Advertising-API-AdvertiserId and Amazon-Advertising-API-MarketplaceId as headers","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}},{"description":"The AMC Account ID","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"type":"string"}},{"description":"The Marketplace ID","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"type":"string"}},{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/CreateWorkflowExecutionRequest"}}},"description":"Request to create a new workflow execution.","required":true},"responses":{"200":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/CreateWorkflowExecutionResponse"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized. Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource."},"422":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unprocessable Entity - Request was understood, but contained invalid parameters"},"429":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Too many requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Internal server error. Retry later. Contact support if this response persists."}},"summary":"Creates a new workflow execution.","tags":["Workflow executions"]}},"/amc/reporting/{instanceId}/workflowExecutions/{workflowExecutionId}":{"get":{"description":"Gets status information about the requested workflow execution. Information includes the time windows of data on which the workflow is executing and the S3 path of the workflow output.","operationId":"getWorkflowExecution","parameters":[{"description":"The identifier of a client associated with an Amazon Developer account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"This header is deprecated. Clients must pass in Amazon-Advertising-API-AdvertiserId and Amazon-Advertising-API-MarketplaceId as headers","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}},{"description":"The AMC Account ID","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"type":"string"}},{"description":"The Marketplace ID","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"type":"string"}},{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"type":"string"}},{"description":"The workflow execution identifier.","in":"path","name":"workflowExecutionId","required":true,"schema":{"type":"string"}},{"description":"Optional. If 'true' includes the workflow definition in the response.","in":"query","name":"includeWorkflow","schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/GetWorkflowExecutionResponse"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized. Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource."},"404":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not Found. The requested resource either does not exist or the currently authenticated user does not have permission to access it."},"429":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Too many requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Internal server error. Retry later. Contact support if this response persists."}},"summary":"Gets status information about the requested workflow execution.","tags":["Workflow executions"]},"put":{"description":"Updates the requested workflow execution. Any missing fields will be ignored.\n\nThis operation can be used to update the requested execution's status to CANCELLED if the execution is still pending or r...","operationId":"UpdateWorkflowExecution","parameters":[{"description":"The identifier of a client associated with an Amazon Developer account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"This header is deprecated. Clients must pass in Amazon-Advertising-API-AdvertiserId and Amazon-Advertising-API-MarketplaceId as headers","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}},{"description":"The AMC Account ID","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"type":"string"}},{"description":"The Marketplace ID","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"type":"string"}},{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"type":"string"}},{"description":"The workflow execution identifier.","in":"path","name":"workflowExecutionId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/WorkflowExecution"}}},"description":"Valid and existing workflow execution definition.","required":true},"responses":{"200":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateWorkflowExecutionResponse"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized. Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource."},"404":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not Found. The requested resource either does not exist or the currently authenticated user does not have permission to access it."},"429":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Too many requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Internal server error. Retry later. Contact support if this response persists."}},"summary":"Updates the requested workflow execution.","tags":["Workflow executions"]}},"/amc/reporting/{instanceId}/workflowExecutions/{workflowExecutionId}/downloadUrls":{"get":{"description":"Generates and returns pre-signed S3 URLs for the result files produced by and metadata used by the provided workflow execution. If there the results are split into multiple files, then multiple URLs will be returned. URLs expire in 10 minutes and are meant for immediate use and discarding.","operationId":"getWorkflowExecutionDownloadUrls","parameters":[{"description":"The identifier of a client associated with an Amazon Developer account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"This header is deprecated. Clients must pass in Amazon-Advertising-API-AdvertiserId and Amazon-Advertising-API-MarketplaceId as headers","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}},{"description":"The AMC Account ID","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"type":"string"}},{"description":"The Marketplace ID","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"type":"string"}},{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"type":"string"}},{"description":"The workflow execution identifier.","in":"path","name":"workflowExecutionId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/GetWorkflowExecutionDownloadUrlsResponse"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized. Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource."},"404":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not Found. The requested resource either does not exist or the currently authenticated user does not have permission to access it."},"429":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Too many requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.amcworkflowexecutions.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Internal server error. Retry later. Contact support if this response persists."}},"summary":"Retrieves pre-signed url for downloading workflow execution results from S3.","tags":["Workflow executions"]}},"/amc/reporting/{instanceId}/workflows":{"get":{"description":"Returns a list of workflows. Workflows are defined as a set of operations that take previously defined data sources as input and use them to generate reports.","operationId":"listWorkflows","parameters":[{"description":"The identifier of a client associated with an Amazon Developer account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"This header is deprecated. Clients must pass in Amazon-Advertising-API-AdvertiserId and Amazon-Advertising-API-MarketplaceId as headers","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}},{"description":"The AMC Account ID","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"type":"string"}},{"description":"The Marketplace ID","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"type":"string"}},{"description":"Optional. Token to retrieve subsequent page of results.","in":"query","name":"nextToken","schema":{"type":"string"}},{"description":"Optional. Limits the number of items to return in the response. Max value is 100. Defaults to 100.","in":"query","name":"limit","schema":{"type":"string"}},{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/ListWorkflowsResponse"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized. Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource."},"422":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unprocessable Entity - Request was understood, but contained invalid parameters"},"429":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Too many requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Internal server error. Retry later. Contact support if this response persists."}},"summary":"Returns a list of workflows.","tags":["Workflows"]},"post":{"description":"Creates a new workflow. The request body is used as the definition for the new workflow. Workflows are defined as a set of operations that take previously defined data sources as input and use them to generate reports.","operationId":"createWorkflow","parameters":[{"description":"The identifier of a client associated with an Amazon Developer account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"This header is deprecated. Clients must pass in Amazon-Advertising-API-AdvertiserId and Amazon-Advertising-API-MarketplaceId as headers","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}},{"description":"The AMC Account ID","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"type":"string"}},{"description":"The Marketplace ID","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"type":"string"}},{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Workflow"}}},"description":"Valid workflow definition.","required":true},"responses":{"200":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/CreateWorkflowResponse"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized. Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource."},"422":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unprocessable Entity - Request was understood, but contained invalid parameters"},"429":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Too many requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Internal server error. Retry later. Contact support if this response persists."}},"summary":"Creates a new workflow.","tags":["Workflows"]}},"/amc/reporting/{instanceId}/workflows/{workflowId}":{"delete":{"description":"Deletes the requested workflow. The specified workflow will no longer be able to be used for ad-hoc or scheduled workflow executions.","operationId":"deleteWorkflow","parameters":[{"description":"The identifier of a client associated with an Amazon Developer account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"This header is deprecated. Clients must pass in Amazon-Advertising-API-AdvertiserId and Amazon-Advertising-API-MarketplaceId as headers","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}},{"description":"The AMC Account ID","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"type":"string"}},{"description":"The Marketplace ID","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"type":"string"}},{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"type":"string"}},{"description":"The requested workflow identifier.","in":"path","name":"workflowId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/DeleteWorkflowResponse"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized. Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource."},"404":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not Found. The requested resource either does not exist or the currently authenticated user does not have permission to access it."},"429":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Too many requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Internal server error. Retry later. Contact support if this response persists."}},"summary":"Deletes the requested workflow.","tags":["Workflows"]},"get":{"description":"Gets the requested workflow. Workflows are defined as a set of operations that take previously defined data sources as input and use them to generate reports.","operationId":"getWorkflow","parameters":[{"description":"The identifier of a client associated with an Amazon Developer account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"This header is deprecated. Clients must pass in Amazon-Advertising-API-AdvertiserId and Amazon-Advertising-API-MarketplaceId as headers","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}},{"description":"The AMC Account ID","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"type":"string"}},{"description":"The Marketplace ID","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"type":"string"}},{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"type":"string"}},{"description":"The requested workflow identifier.","in":"path","name":"workflowId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/GetWorkflowResponse"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized. Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource."},"404":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not Found. The requested resource either does not exist or the currently authenticated user does not have permission to access it."},"429":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Too many requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Internal server error. Retry later. Contact support if this response persists."}},"summary":"Gets the requested workflow.","tags":["Workflows"]},"put":{"description":"Updates the requested workflow, using the request body directly as the new workflow definition. Workflows are defined as a set of operations that take previously defined data sources as input and use them to generate reports.","operationId":"updateWorkflow","parameters":[{"description":"The identifier of a client associated with an Amazon Developer account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"This header is deprecated. Clients must pass in Amazon-Advertising-API-AdvertiserId and Amazon-Advertising-API-MarketplaceId as headers","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"type":"string"}},{"description":"The AMC Account ID","in":"header","name":"Amazon-Advertising-API-AdvertiserId","required":true,"schema":{"type":"string"}},{"description":"The Marketplace ID","in":"header","name":"Amazon-Advertising-API-MarketplaceId","required":true,"schema":{"type":"string"}},{"description":"The instance identifier.","in":"path","name":"instanceId","required":true,"schema":{"type":"string"}},{"description":"The requested workflow identifier.","in":"path","name":"workflowId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Workflow"}}},"description":"Valid workflow definition.","required":true},"responses":{"200":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateWorkflowResponse"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized. Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Forbidden. Request failed because user does not have access to a specified resource."},"404":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not Found. The requested resource either does not exist or the currently authenticated user does not have permission to access it."},"422":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unprocessable Entity - Request was understood, but contained invalid parameters"},"429":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Too many requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.amcworkflows.v1+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Internal server error. Retry later. Contact support if this response persists."}},"summary":"Updates the requested workflow.","tags":["Workflows"]}}}}