Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
amazon-appflow-api-026	amazon-appflow-api.pdf	26	"Execution_ID", "executionMessage": "Request failed with Trendmicro Status Code 404: , RequestId: RequestId_value", "executionMetadata": Examples API Version 2020-08-23 148 API Reference AmazonAppFlow { "bytesProcessed": 234, "bytesWritten": 0, "numFailures": 878, "numFilteredRecords": 0, "numPutFailures": 978978, "reason": null, "recordsProcessed": 23342, "terminateFlow": false }, "executionResult": { "bytesProcessed": 234, "bytesWritten": 0, "errorInfo": { "executionMessage": "Request failed with Trendmicro Status Code 404: , RequestId: RequestId_value", "putFailuresCount": 978978 }, "recordsProcessed": 23342 }, "executionStartTime": "2022-02-22T15:31:41.467000-08:00", "executionStatus": "Error", "lastUpdatedAt": "2022-02-22T15:31:41.467000-08:00", "startedAt": "2022-02-22T15:31:41.467000-08:00" } ], "nextToken": "next_token_value" } Sample Request { "flowName": "test-new-create", "maxResults": 1, "nextToken": "next_token_value" } Sample Response { "flowExecutionList": [ Examples API Version 2020-08-23 149 AmazonAppFlow { API Reference "executionId": "execution_id_value", "executionMessage": "Request failed with Trendmicro Status Code 404: , RequestId: RequestId_value", "executionMetadata": { "bytesProcessed": 234, "bytesWritten": 0, "numFailures": 0, "numFilteredRecords": 0, "numPutFailures": 0, "reason": null, "recordsProcessed": 23342, "terminateFlow": false }, "executionResult": { "bytesProcessed": 234, "bytesWritten": 0, "errorInfo": null, "recordsProcessed": 23342 }, "executionStartTime": "execution_start_time_value", "executionStatus": "Successful", "lastUpdatedAt": "lastupdated_at_value", "lastUpdatedTime": "lastupdated_time_value", "startedAt": "started_at_value" } ], "nextToken": "next_token_value" } Sample Request { "flowName": "name", "maxResults": 1, "nextToken": "next_token_value" } Sample Response { "flowExecutionList": [ { Examples API Version 2020-08-23 150 AmazonAppFlow API Reference "executionId": "execution_id_value-delete", "executionMessage": "Request failed with Trendmicro Status Code 404: , RequestId: RequestId_value", "executionMetadata": { "bytesProcessed": 0, "bytesWritten": 0, "numFailures": 0, "numFilteredRecords": 0, "numPutFailures": 0, "reason": null, "recordsProcessed": 0, "terminateFlow": false }, "executionResult": { "bytesProcessed": 0, "bytesWritten": 0, "errorInfo": { "executionMessage": "Request failed with Trendmicro Status Code 404: , RequestId: RequestId_value", "putFailuresCount": 0 }, "recordsProcessed": 0 }, "executionStartTime": "execution_start_time_value", "executionStatus": "Error", "lastUpdatedAt": "lastupdated_at_value", "lastUpdatedTime": "lastupdated_time_value", "startedAt": "started_at_value" } ], "nextToken": "next_token_value" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2020-08-23 151 AmazonAppFlow • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 152 AmazonAppFlow API Reference ListConnectorEntities Returns the list of available connector entities supported by Amazon AppFlow. For example, you can query Salesforce for Account and Opportunity entities, or query ServiceNow for the Incident entity. Request Syntax POST /list-connector-entities HTTP/1.1 Content-type: application/json { "apiVersion": "string", "connectorProfileName": "string", "connectorType": "string", "entitiesPath": "string", "maxResults": number, "nextToken": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. apiVersion The version of the API that's used by the connector. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: No ListConnectorEntities API Version 2020-08-23 153 AmazonAppFlow connectorProﬁleName API Reference The name of the connector proﬁle. The name is unique for each ConnectorProfile in the AWS account, and is used to query the downstream connector. Type: String Length Constraints: Maximum length of 256. Pattern: [\w/!@#+=.-]+ Required: No connectorType The type of connector, such as Salesforce, Amplitude, and so on. Type: String Valid Values: Salesforce \| Singular \| Slack \| Redshift \| S3 \| Marketo \| Googleanalytics \| Zendesk \| Servicenow \| Datadog \| Trendmicro \| Snowflake \| Dynatrace \| Infornexus \| Amplitude \| Veeva \| EventBridge \| LookoutMetrics \| Upsolver \| Honeycode \| CustomerProfiles \| SAPOData \| CustomConnector \| Pardot Required: No entitiesPath This optional parameter is speciﬁc to connector implementation. Some connectors support multiple levels or categories of entities. You can ﬁnd out the list of roots for such providers by sending a request without the entitiesPath parameter. If the connector supports entities at diﬀerent roots, this initial request returns the list of roots. Otherwise, this request returns all entities supported by the provider. Type: String Length Constraints: Maximum length of 256. Pattern: [\s\w/!@#+=,.-]* Required: No maxResults The maximum number of items that the operation returns in the response. Request Body API Version 2020-08-23 154 AmazonAppFlow Type: Integer Valid Range: Minimum value of 1. Maximum value of 10000. API Reference Required: No nextToken A token that was provided by your prior ListConnectorEntities operation if the response was too big for the page size. You specify this token to get the next page of results in paginated response. Type: String Length Constraints: Maximum length of 2048. Pattern: \S+ Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "connectorEntityMap": { "string" : [ { "hasNestedEntities": boolean, "label": "string", "name": "string" } ] }, "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2020-08-23 155 AmazonAppFlow connectorEntityMap API Reference The response of ListConnectorEntities lists entities grouped by category. This map's key represents the group name, and its value contains the list of entities belonging to that
amazon-appflow-api-027	amazon-appflow-api.pdf	27	Type: String Length Constraints: Maximum length of 2048. Pattern: \S+ Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "connectorEntityMap": { "string" : [ { "hasNestedEntities": boolean, "label": "string", "name": "string" } ] }, "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2020-08-23 155 AmazonAppFlow connectorEntityMap API Reference The response of ListConnectorEntities lists entities grouped by category. This map's key represents the group name, and its value contains the list of entities belonging to that group. Type: String to array of ConnectorEntity objects map Key Length Constraints: Maximum length of 128. Key Pattern: \S+ nextToken A token that you specify in your next ListConnectorEntities operation to get the next page of results in paginated response. The ListConnectorEntities operation provides this token if the response is too big for the page size. Type: String Length Constraints: Maximum length of 2048. Pattern: \S+ Errors For information about the errors that are common to all actions, see Common Errors. ConnectorAuthenticationException An error occurred when authenticating with the connector endpoint. HTTP Status Code: 401 ConnectorServerException An error occurred when retrieving data from the connector endpoint. HTTP Status Code: 400 InternalServerException An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 Errors API Version 2020-08-23 156 AmazonAppFlow ResourceNotFoundException API Reference The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not found. HTTP Status Code: 404 ValidationException The request has invalid or missing parameters. HTTP Status Code: 400 Examples ListConnectorEntities example This example shows sample requests and a sample response for the ListConnectorEntities API. The second sample request shows a request without the optional connectorType). Sample Request { "connectorType": "Slack", "connectorProfileName": "vmSlackProfile" } Sample Request { "connectorProfileName": "vmSlackProfile" } Sample Response { "connectorEntityMap": { "Objects": [ {"hasNestedEntities": true, "label": "Conversations","name": "conversations"} Examples API Version 2020-08-23 157 AmazonAppFlow ] } } Sample Request { "connectorProfileName": "vmSlackProfile", "connectorType": "Slack", "entitiesPath": "conversations" } Sample Response { "connectorEntityMap": { "Channels": [ { "hasNestedEntities": false, "label": "new-to-slack", "name": "conversations/CQCFDC534" }, { "hasNestedEntities": false, "label": "advising", "name": "conversations/CQDSNS2AX" }, { "hasNestedEntities": false, "label": "general", "name": "conversations/CQTFBK48N" }, { "hasNestedEntities": false, "label": "random", "name": "conversations/CQTFBK6CE" }, { "hasNestedEntities": false, "label": "investing", "name": "conversations/CQTFBKDT8" }, Examples API Reference API Version 2020-08-23 158 API Reference AmazonAppFlow { "hasNestedEntities": false, "label": "memories", "name": "conversations/CS44VCEC9" }, { "hasNestedEntities": false, "label": "home-of-nyc", "name": "conversations/CV84P3D7A" }, { "hasNestedEntities": false, "label": "marketing", "name": "conversations/C012DDQRU95" }, { "hasNestedEntities": false, "label": "home-of-phi", "name": "conversations/C012DTFRBL7" }, { "hasNestedEntities": false, "label": "home-of-philadelphia", "name": "conversations/C012N003VU6" }, { "hasNestedEntities": false, "label": "lol", "name": "conversations/C012NJTMZEJ" }, { "hasNestedEntities": false, "label": "home-of-atlanta", "name": "conversations/C012P2739BQ" }, { "hasNestedEntities": false, "label": "it-support", "name": "conversations/C012SRQMLRH" }, { "hasNestedEntities": false, "label": "home-of-nashville", "name": "conversations/C012U9TM5DZ" Examples API Version 2020-08-23 159 API Reference AmazonAppFlow }, { "hasNestedEntities": false, "label": "home-of-texas", "name": "conversations/C012VHLB63X" }, { "hasNestedEntities": false, "label": "data", "name": "conversations/C012Z3VMA7N" }, { "hasNestedEntities": false, "label": "home-of-san-francisco", "name": "conversations/C01308U07HA" }, { "hasNestedEntities": false, "label": "slack-feedback", "name": "conversations/C0131PCV93N" }, { "hasNestedEntities": false, "label": "home-of-seattle", "name": "conversations/C0136MRRQHX" }, { "hasNestedEntities": false, "label": "operations", "name": "conversations/C0136QPJ1KK" }, { "hasNestedEntities": false, "label": "product", "name": "conversations/C0137S730KT" }, { "hasNestedEntities": false, "label": "dev", "name": "conversations/C013HUHSRGQ" }, { "hasNestedEntities": false, "label": "infra", Examples API Version 2020-08-23 160 AmazonAppFlow API Reference "name": "conversations/C013KP5TQ2J" }, { "hasNestedEntities": false, "label": "pets", "name": "conversations/C013NTC2L0G" }, { "hasNestedEntities": false, "label": "founders", "name": "conversations/C014M9JBWCU" } ] } } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-08-23 161 AmazonAppFlow ListConnectors API Reference Returns the list of all registered custom connectors in your AWS account. This API lists only custom connectors registered in this account, not the AWS authored connectors. Request Syntax POST /list-connectors HTTP/1.1 Content-type: application/json { "maxResults": number, "nextToken": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. maxResults Speciﬁes the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations). Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No nextToken The pagination token for the next page of data. Type: String Length Constraints: Maximum length of 2048. Pattern: \S+ ListConnectors API Version 2020-08-23 162 API Reference AmazonAppFlow Required: No Response Syntax HTTP/1.1 200 Content-type:
amazon-appflow-api-028	amazon-appflow-api.pdf	28	"nextToken": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. maxResults Speciﬁes the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations). Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No nextToken The pagination token for the next page of data. Type: String Length Constraints: Maximum length of 2048. Pattern: \S+ ListConnectors API Version 2020-08-23 162 API Reference AmazonAppFlow Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "connectors": [ { "applicationType": "string", "connectorDescription": "string", "connectorLabel": "string", "connectorModes": [ "string" ], "connectorName": "string", "connectorOwner": "string", "connectorProvisioningType": "string", "connectorType": "string", "connectorVersion": "string", "registeredAt": number, "registeredBy": "string", "supportedDataTransferTypes": [ "string" ] } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. connectors Contains information about the connectors supported by Amazon AppFlow. Type: Array of ConnectorDetail objects nextToken The pagination token for the next page of data. If nextToken=null, this means that all records have been fetched. Response Syntax API Version 2020-08-23 163 AmazonAppFlow Type: String Length Constraints: Maximum length of 2048. Pattern: \S+ Errors API Reference For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ValidationException The request has invalid or missing parameters. HTTP Status Code: 400 Examples Listing connectors This example shows a sample request for the ListConnector API and a sample response. Sample Request { "maxResults": 1, "nextToken": "nextToken_value" } Sample Response { "connectors": [ { "connectorArn": "Arn of connector1", "connectorDescription": "Some Sample Connector1", Errors API Version 2020-08-23 164 AmazonAppFlow API Reference "connectorName": "Salesforce custom connector1", "connectorOwner": "AppFlow", "connectorVersion": "1.0", "applicationType": "Salesforce", "connectorType": "CUSTOMCONNECTOR", "connectorLabel": "MyCustomConnector", "registeredAt": 1628732168.132, "registeredBy": "CUSTOM", "tags": null, "connectorModes": [ "SOURCE", "DESTINATION" ], "connectorProvisioningType": "LAMBDA" }, { "connectorArn": "Arn of connector2", "connectorDescription": "Some Sample Connector2", "connectorName": "Salesforce custom connector2", "connectorOwner": "AppFlow", "connectorVersion": "1.0", "applicationType": "Salesforce", "connectorType": "CUSTOMCONNECTOR", "connectorLabel": "MyCustomConnector", "registeredAt": 1628732168.132, "registeredBy": "CUSTOM", "tags": null, "connectorModes": [ "SOURCE", "DESTINATION" ], "connectorProvisioningType": "LAMBDA" } ], "nextToken": null } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2020-08-23 165 API Reference AmazonAppFlow • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-08-23 166 API Reference AmazonAppFlow ListFlows Lists all of the ﬂows associated with your account. Request Syntax POST /list-flows HTTP/1.1 Content-type: application/json { "maxResults": number, "nextToken": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. maxResults Speciﬁes the maximum number of items that should be returned in the result set. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No nextToken The pagination token for next page of data. Type: String Length Constraints: Maximum length of 2048. Pattern: \S+ Required: No ListFlows API Version 2020-08-23 167 API Reference AmazonAppFlow Response Syntax HTTP/1.1 200 Content-type: application/json { "flows": [ { "createdAt": number, "createdBy": "string", "description": "string", "destinationConnectorLabel": "string", "destinationConnectorType": "string", "flowArn": "string", "flowName": "string", "flowStatus": "string", "lastRunExecutionDetails": { "mostRecentExecutionMessage": "string", "mostRecentExecutionStatus": "string", "mostRecentExecutionTime": number }, "lastUpdatedAt": number, "lastUpdatedBy": "string", "sourceConnectorLabel": "string", "sourceConnectorType": "string", "tags": { "string" : "string" }, "triggerType": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ﬂows The list of ﬂows associated with your account. Response Syntax API Version 2020-08-23 168 AmazonAppFlow API Reference Type: Array of FlowDeﬁnition objects nextToken The pagination token for next page of data. Type: String Length Constraints: Maximum length of 2048. Pattern: \S+ Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ValidationException The request has invalid or missing parameters. HTTP Status Code: 400 Examples ListFlows examples This example shows a sample request for the ListFlows API. In the second sample, note that MaxResults will show a number between 1 and 100. Sample Request { "flowList": [ { "createdAt": "created_time_value", "createdBy": "arn:aws:iam::<AccountId>:user/BetaTestUser", "description": "test flow 1 description", Errors API Version 2020-08-23 169 AmazonAppFlow API Reference "destinationConnectorType": "S3", "destinationConnectorLabel": "MyCustomDestinationConnector",
amazon-appflow-api-029	amazon-appflow-api.pdf	29	For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ValidationException The request has invalid or missing parameters. HTTP Status Code: 400 Examples ListFlows examples This example shows a sample request for the ListFlows API. In the second sample, note that MaxResults will show a number between 1 and 100. Sample Request { "flowList": [ { "createdAt": "created_time_value", "createdBy": "arn:aws:iam::<AccountId>:user/BetaTestUser", "description": "test flow 1 description", Errors API Version 2020-08-23 169 AmazonAppFlow API Reference "destinationConnectorType": "S3", "destinationConnectorLabel": "MyCustomDestinationConnector", "flowArn": "arn:aws:appflow:region:<AccountId>:flow/test-flow-1", "flowName": "test-flow-1", "flowStatus": "Active", "lastRunExecutionDetails": { "mostRecentExecutionMessage": "Successfully ran the flow", "mostRecentExecutionStatus": "Successful", "mostRecentExecutionTime": "execution_time_value" }, "lastUpdatedAt": "lastupdated_time_value", "lastUpdatedBy": "arn:aws:iam::<AccountId>:user/BetaTestUser", "sourceConnectorType": "Salesforce", "sourceConnectorLabel": "MyCustomSourceConnector", "tags": { "internalId": "<InternalId>", "resourceArn": "arn:aws:appflow:region:<AccountId>:flow/test-flow-1" }, "triggerType": "OnDemand" } ], "nextToken": "next_token_value" } { "maxResults": 1 } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 See Also API Version 2020-08-23 170 AmazonAppFlow • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 171 AmazonAppFlow API Reference ListTagsForResource Retrieves the tags that are associated with a speciﬁed ﬂow. Request Syntax GET /tags/resourceArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn The Amazon Resource Name (ARN) of the speciﬁed ﬂow. Length Constraints: Maximum length of 512. Pattern: arn:aws:.:.:[0-9]+:.* Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "tags": { "string" : "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. ListTagsForResource API Version 2020-08-23 172 AmazonAppFlow API Reference The following data is returned in JSON format by the service. tags The tags used to organize, track, or control access for your ﬂow. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Maximum length of 256. Value Pattern: [\s\w+-=\.:/@]* Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ResourceNotFoundException The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not found. HTTP Status Code: 404 ValidationException The request has invalid or missing parameters. HTTP Status Code: 400 Errors API Version 2020-08-23 173 AmazonAppFlow See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-08-23 174 AmazonAppFlow RegisterConnector API Reference Registers a new custom connector with your AWS account. Before you can register the connector, you must deploy the associated AWS lambda function in your account. Request Syntax POST /register-connector HTTP/1.1 Content-type: application/json { "clientToken": "string", "connectorLabel": "string", "connectorProvisioningConfig": { "lambda": { "lambdaArn": "string" } }, "connectorProvisioningType": "string", "description": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. clientToken The clientToken parameter is an idempotency token. It ensures that your RegisterConnector request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value. If you omit a clientToken value, the AWS SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases. RegisterConnector API Version 2020-08-23 175 AmazonAppFlow API Reference If you specify input parameters that diﬀer from your ﬁrst request, an error occurs. If you use a diﬀerent value for clientToken, Amazon AppFlow considers it a new call to RegisterConnector. The token is active for 8 hours. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [ -~]+ Required: No connectorLabel The name of the connector. The name is unique for each ConnectorRegistration in your AWS account. Type: String Length Constraints: Maximum
amazon-appflow-api-030	amazon-appflow-api.pdf	30	times after a network error. You must provide your own value for other use cases. RegisterConnector API Version 2020-08-23 175 AmazonAppFlow API Reference If you specify input parameters that diﬀer from your ﬁrst request, an error occurs. If you use a diﬀerent value for clientToken, Amazon AppFlow considers it a new call to RegisterConnector. The token is active for 8 hours. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [ -~]+ Required: No connectorLabel The name of the connector. The name is unique for each ConnectorRegistration in your AWS account. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ Required: No connectorProvisioningConﬁg The provisioning type of the connector. Currently the only supported value is LAMBDA. Type: ConnectorProvisioningConﬁg object Required: No connectorProvisioningType The provisioning type of the connector. Currently the only supported value is LAMBDA. Type: String Valid Values: LAMBDA Required: No description A description about the connector that's being registered. Request Body API Version 2020-08-23 176 AmazonAppFlow Type: String Length Constraints: Maximum length of 1024. API Reference Pattern: [\s\w/!@#+=.-]* Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "connectorArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. connectorArn The ARN of the connector being registered. Type: String Length Constraints: Maximum length of 512. Pattern: arn:aws:.:.:[0-9]+:.* Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException AppFlow/Requester has invalid or missing permissions. Response Syntax API Version 2020-08-23 177 AmazonAppFlow HTTP Status Code: 403 ConﬂictException API Reference There was a conﬂict when processing the request (for example, a ﬂow with the given name already exists within the account. Check for conﬂicting resource names and try again. HTTP Status Code: 409 ConnectorAuthenticationException An error occurred when authenticating with the connector endpoint. HTTP Status Code: 401 ConnectorServerException An error occurred when retrieving data from the connector endpoint. HTTP Status Code: 400 InternalServerException An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ResourceNotFoundException The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not found. HTTP Status Code: 404 ServiceQuotaExceededException The request would cause a service quota (such as the number of ﬂows) to be exceeded. HTTP Status Code: 402 ThrottlingException API calls have exceeded the maximum allowed API request rate per account and per Region. HTTP Status Code: 429 ValidationException The request has invalid or missing parameters. Errors API Version 2020-08-23 178 AmazonAppFlow HTTP Status Code: 400 Examples Registering a connector API Reference This example shows a sample request for the RegisterConnector API and a sample response. Sample Request { "connectorLabel": "Connector_Label_Value", "connectorProvisioningType": "LAMBDA", "connectorProvisioningConfig": { "lambda": { "lambdaArn": "lambda arn" } } } Sample Response { "connectorArn": "arn:aws:appflow:region:<AccountId>:connector/Connector_Label" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 Examples API Version 2020-08-23 179 AmazonAppFlow • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 180 AmazonAppFlow API Reference ResetConnectorMetadataCache Resets metadata about your connector entities that Amazon AppFlow stored in its cache. Use this action when you want Amazon AppFlow to return the latest information about the data that you have in a source application. Amazon AppFlow returns metadata about your entities when you use the ListConnectorEntities or DescribeConnectorEntities actions. Following these actions, Amazon AppFlow caches the metadata to reduce the number of API requests that it must send to the source application. Amazon AppFlow automatically resets the cache once every hour, but you can use this action when you want to get the latest metadata right away. Request Syntax POST /reset-connector-metadata-cache HTTP/1.1 Content-type: application/json { "apiVersion": "string", "connectorEntityName": "string", "connectorProfileName": "string", "connectorType": "string", "entitiesPath": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. apiVersion The API version that you speciﬁed in the connector proﬁle that you’re resetting cached metadata for. You must use this parameter only if the connector supports multiple API versions or if the connector type is CustomConnector. To look up how many versions a connector supports, use the DescribeConnectors action. In the response, ﬁnd the value that Amazon AppFlow returns for the connectorVersion parameter. ResetConnectorMetadataCache API Version 2020-08-23 181 AmazonAppFlow API Reference To look up the connector type, use the DescribeConnectorProﬁles action. In the response, ﬁnd the value that Amazon AppFlow returns for the connectorType parameter.
amazon-appflow-api-031	amazon-appflow-api.pdf	31	data in JSON format. apiVersion The API version that you speciﬁed in the connector proﬁle that you’re resetting cached metadata for. You must use this parameter only if the connector supports multiple API versions or if the connector type is CustomConnector. To look up how many versions a connector supports, use the DescribeConnectors action. In the response, ﬁnd the value that Amazon AppFlow returns for the connectorVersion parameter. ResetConnectorMetadataCache API Version 2020-08-23 181 AmazonAppFlow API Reference To look up the connector type, use the DescribeConnectorProﬁles action. In the response, ﬁnd the value that Amazon AppFlow returns for the connectorType parameter. To look up the API version that you speciﬁed in a connector proﬁle, use the DescribeConnectorProﬁles action. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: No connectorEntityName Use this parameter if you want to reset cached metadata about the details for an individual entity. If you don't include this parameter in your request, Amazon AppFlow only resets cached metadata about entity names, not entity details. Type: String Length Constraints: Maximum length of 1024. Pattern: \S+ Required: No connectorProﬁleName The name of the connector proﬁle that you want to reset cached metadata for. You can omit this parameter if you're resetting the cache for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you must include this parameter in your request. Type: String Length Constraints: Maximum length of 256. Request Body API Version 2020-08-23 182 AmazonAppFlow Pattern: [\w/!@#+=.-]+ Required: No connectorType API Reference The type of connector to reset cached metadata for. You must include this parameter in your request if you're resetting the cache for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you can omit this parameter from your request. Type: String Valid Values: Salesforce \| Singular \| Slack \| Redshift \| S3 \| Marketo \| Googleanalytics \| Zendesk \| Servicenow \| Datadog \| Trendmicro \| Snowflake \| Dynatrace \| Infornexus \| Amplitude \| Veeva \| EventBridge \| LookoutMetrics \| Upsolver \| Honeycode \| CustomerProfiles \| SAPOData \| CustomConnector \| Pardot Required: No entitiesPath Use this parameter only if you’re resetting the cached metadata about a nested entity. Only some connectors support nested entities. A nested entity is one that has another entity as a parent. To use this parameter, specify the name of the parent entity. To look up the parent-child relationship of entities, you can send a ListConnectorEntities request that omits the entitiesPath parameter. Amazon AppFlow will return a list of top-level entities. For each one, it indicates whether the entity has nested entities. Then, in a subsequent ListConnectorEntities request, you can specify a parent entity name for the entitiesPath parameter. Amazon AppFlow will return a list of the child entities for that parent. Type: String Length Constraints: Maximum length of 256. Pattern: [\s\w/!@#+=,.-]* Required: No Request Body API Version 2020-08-23 183 AmazonAppFlow Response Syntax HTTP/1.1 200 Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. ConﬂictException There was a conﬂict when processing the request (for example, a ﬂow with the given name already exists within the account. Check for conﬂicting resource names and try again. HTTP Status Code: 409 InternalServerException An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ResourceNotFoundException The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not found. HTTP Status Code: 404 ValidationException The request has invalid or missing parameters. HTTP Status Code: 400 Examples Reset cache of entity names The following example shows the request body for a call to reset the cached metadata for entity names. Response Syntax API Version 2020-08-23 184 API Reference AmazonAppFlow Sample Request { "apiVersion": "v1.0", "connectorProfileName": "MyCustomConnector" } Sample Response {} Reset cache of entity details The following example shows the request body for a call to reset the cached metadata about the details for a speciﬁc entity. Sample Request { "apiVersion": "v1.0", "connectorProfileName": "MyCustomConnector", "connectorEntityName": "EntityName" } Sample Response {} See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 See Also API Version 2020-08-23 185 AmazonAppFlow • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See
amazon-appflow-api-032	amazon-appflow-api.pdf	32	a speciﬁc entity. Sample Request { "apiVersion": "v1.0", "connectorProfileName": "MyCustomConnector", "connectorEntityName": "EntityName" } Sample Response {} See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 See Also API Version 2020-08-23 185 AmazonAppFlow • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 186 AmazonAppFlow StartFlow API Reference Activates an existing ﬂow. For on-demand ﬂows, this operation runs the ﬂow immediately. For schedule and event-triggered ﬂows, this operation activates the ﬂow. Request Syntax POST /start-flow HTTP/1.1 Content-type: application/json { "clientToken": "string", "flowName": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. clientToken The clientToken parameter is an idempotency token. It ensures that your StartFlow request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value. If you omit a clientToken value, the AWS SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases. If you specify input parameters that diﬀer from your ﬁrst request, an error occurs for ﬂows that run on a schedule or based on an event. However, the error doesn't occur for ﬂows that run on demand. You set the conditions that initiate your ﬂow for the triggerConfig parameter. If you use a diﬀerent value for clientToken, Amazon AppFlow considers it a new call to StartFlow. The token is active for 8 hours. StartFlow API Version 2020-08-23 187 AmazonAppFlow Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [ -~]+ Required: No ﬂowName The speciﬁed name of the ﬂow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "executionId": "string", "flowArn": "string", "flowStatus": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. executionId Returns the internal execution ID of an on-demand ﬂow when the ﬂow is started. For scheduled or event-triggered ﬂows, this value is null. Type: String Response Syntax API Version 2020-08-23 188 AmazonAppFlow API Reference Length Constraints: Maximum length of 256. Pattern: \S+ ﬂowArn The ﬂow's Amazon Resource Name (ARN). Type: String Length Constraints: Maximum length of 512. Pattern: arn:aws:appflow:.:[0-9]+:. ﬂowStatus Indicates the current status of the ﬂow. Type: String Valid Values: Active \| Deprecated \| Deleted \| Draft \| Errored \| Suspended Errors For information about the errors that are common to all actions, see Common Errors. ConﬂictException There was a conﬂict when processing the request (for example, a ﬂow with the given name already exists within the account. Check for conﬂicting resource names and try again. HTTP Status Code: 409 InternalServerException An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ResourceNotFoundException The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not found. HTTP Status Code: 404 Errors API Version 2020-08-23 189 AmazonAppFlow API Reference ServiceQuotaExceededException The request would cause a service quota (such as the number of ﬂows) to be exceeded. HTTP Status Code: 402 Examples StartFlow example This example shows a sample request and response for the StartFlow API. Sample Request { "flowName": "name" } Sample Response { "flowArn": "arn:aws:appflow:region:<AccountId>:flow/test_flow_ondemand_1", "flowStatus": "Active" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 Examples API Version 2020-08-23 190 AmazonAppFlow • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 191 AmazonAppFlow StopFlow API Reference Deactivates the existing ﬂow. For on-demand ﬂows, this operation returns an unsupportedOperationException error message. For schedule and event-triggered ﬂows, this operation deactivates the ﬂow. Request Syntax POST /stop-flow HTTP/1.1 Content-type: application/json { "flowName": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data
amazon-appflow-api-033	amazon-appflow-api.pdf	33	• AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 Examples API Version 2020-08-23 190 AmazonAppFlow • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 191 AmazonAppFlow StopFlow API Reference Deactivates the existing ﬂow. For on-demand ﬂows, this operation returns an unsupportedOperationException error message. For schedule and event-triggered ﬂows, this operation deactivates the ﬂow. Request Syntax POST /stop-flow HTTP/1.1 Content-type: application/json { "flowName": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. ﬂowName The speciﬁed name of the ﬂow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json StopFlow API Version 2020-08-23 192 API Reference AmazonAppFlow { "flowArn": "string", "flowStatus": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ﬂowArn The ﬂow's Amazon Resource Name (ARN). Type: String Length Constraints: Maximum length of 512. Pattern: arn:aws:appflow:.:[0-9]+:. ﬂowStatus Indicates the current status of the ﬂow. Type: String Valid Values: Active \| Deprecated \| Deleted \| Draft \| Errored \| Suspended Errors For information about the errors that are common to all actions, see Common Errors. ConﬂictException There was a conﬂict when processing the request (for example, a ﬂow with the given name already exists within the account. Check for conﬂicting resource names and try again. HTTP Status Code: 409 InternalServerException An internal service error occurred during the processing of your request. Try again later. Response Elements API Version 2020-08-23 193 AmazonAppFlow HTTP Status Code: 500 ResourceNotFoundException API Reference The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not found. HTTP Status Code: 404 UnsupportedOperationException The requested operation is not supported for the current ﬂow. HTTP Status Code: 400 Examples StopFlow example This example shows a sample request and response for the StopFlow API. Sample Request { "flowName": "name" } Sample Response { "flowArn": "arn:aws:appflow:region:<AccountId>:flow/test_flow_ondemand_1", "flowStatus": "Suspended" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Examples API Version 2020-08-23 194 API Reference AmazonAppFlow • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-08-23 195 API Reference AmazonAppFlow TagResource Applies a tag to the speciﬁed ﬂow. Request Syntax POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. resourceArn The Amazon Resource Name (ARN) of the ﬂow that you want to tag. Length Constraints: Maximum length of 512. Pattern: arn:aws:.:.:[0-9]+:.* Required: Yes Request Body The request accepts the following data in JSON format. tags The tags used to organize, track, or control access for your ﬂow. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. TagResource API Version 2020-08-23 196 AmazonAppFlow API Reference Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Maximum length of 256. Value Pattern: [\s\w+-=\.:/@]* Required: Yes Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ResourceNotFoundException The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not found. HTTP Status Code: 404 ValidationException The request has invalid or missing parameters. HTTP Status Code: 400 Response Syntax API Version 2020-08-23 197 AmazonAppFlow See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-08-23 198 AmazonAppFlow API Reference UnregisterConnector Unregisters the custom connector registered in your account that matches the connector label provided in the request. Request Syntax POST /unregister-connector HTTP/1.1 Content-type: application/json { "connectorLabel": "string", "forceDelete": boolean }
amazon-appflow-api-034	amazon-appflow-api.pdf	34	AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-08-23 198 AmazonAppFlow API Reference UnregisterConnector Unregisters the custom connector registered in your account that matches the connector label provided in the request. Request Syntax POST /unregister-connector HTTP/1.1 Content-type: application/json { "connectorLabel": "string", "forceDelete": boolean } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. connectorLabel The label of the connector. The label is unique for each ConnectorRegistration in your AWS account. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ Required: Yes forceDelete Indicates whether Amazon AppFlow should unregister the connector, even if it is currently in use in one or more connector proﬁles. The default value is false. UnregisterConnector API Version 2020-08-23 199 API Reference AmazonAppFlow Type: Boolean Required: No Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. ConﬂictException There was a conﬂict when processing the request (for example, a ﬂow with the given name already exists within the account. Check for conﬂicting resource names and try again. HTTP Status Code: 409 InternalServerException An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ResourceNotFoundException The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not found. HTTP Status Code: 404 Examples Unregister connectors This example shows a sample request for the UnregisterConnector API and a sample response. Response Syntax API Version 2020-08-23 200 AmazonAppFlow Sample Request { "connectorLabel": "MySampleCustomConnector", "forceDelete": true } { API Reference "message": "Conflict executing request: Connector: MySampleCustomConnector is associated with one or more connector profiles. If you still want to delete it, then make delete request with forceDelete flag as true. Some of the associated connector profiles are: [myTestProfile1, myTestProfile2]" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-08-23 201 API Reference AmazonAppFlow UntagResource Removes a tag from the speciﬁed ﬂow. Request Syntax DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn The Amazon Resource Name (ARN) of the ﬂow that you want to untag. Length Constraints: Maximum length of 512. Pattern: arn:aws:.:.:[0-9]+:.* Required: Yes tagKeys The tag keys associated with the tag that you want to remove from your ﬂow. Array Members: Minimum number of 0 items. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 UntagResource API Version 2020-08-23 202 AmazonAppFlow Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ResourceNotFoundException The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not found. HTTP Status Code: 404 ValidationException The request has invalid or missing parameters. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 Response Elements API Version 2020-08-23 203 AmazonAppFlow • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 204 AmazonAppFlow API Reference UpdateConnectorProﬁle Updates a given connector proﬁle associated with your account. Request Syntax POST /update-connector-profile HTTP/1.1 Content-type: application/json { "clientToken": "string", "connectionMode": "string", "connectorProfileConfig": { "connectorProfileCredentials": { "Amplitude": { "apiKey": "string", "secretKey": "string" }, "CustomConnector": { "apiKey": { "apiKey": "string", "apiSecretKey": "string" }, "authenticationType": "string", "basic": { "password":
amazon-appflow-api-035	amazon-appflow-api.pdf	35	v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 Response Elements API Version 2020-08-23 203 AmazonAppFlow • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 204 AmazonAppFlow API Reference UpdateConnectorProﬁle Updates a given connector proﬁle associated with your account. Request Syntax POST /update-connector-profile HTTP/1.1 Content-type: application/json { "clientToken": "string", "connectionMode": "string", "connectorProfileConfig": { "connectorProfileCredentials": { "Amplitude": { "apiKey": "string", "secretKey": "string" }, "CustomConnector": { "apiKey": { "apiKey": "string", "apiSecretKey": "string" }, "authenticationType": "string", "basic": { "password": "string", "username": "string" }, "custom": { "credentialsMap": { "string" : "string" }, "customAuthenticationType": "string" }, "oauth2": { "accessToken": "string", "clientId": "string", "clientSecret": "string", "oAuthRequest": { "authCode": "string", "redirectUri": "string" }, "refreshToken": "string" UpdateConnectorProﬁle API Version 2020-08-23 205 API Reference AmazonAppFlow } }, "Datadog": { "apiKey": "string", "applicationKey": "string" }, "Dynatrace": { "apiToken": "string" }, "GoogleAnalytics": { "accessToken": "string", "clientId": "string", "clientSecret": "string", "oAuthRequest": { "authCode": "string", "redirectUri": "string" }, "refreshToken": "string" }, "Honeycode": { "accessToken": "string", "oAuthRequest": { "authCode": "string", "redirectUri": "string" }, "refreshToken": "string" }, "InforNexus": { "accessKeyId": "string", "datakey": "string", "secretAccessKey": "string", "userId": "string" }, "Marketo": { "accessToken": "string", "clientId": "string", "clientSecret": "string", "oAuthRequest": { "authCode": "string", "redirectUri": "string" } }, "Pardot": { "accessToken": "string", Request Syntax API Version 2020-08-23 206 AmazonAppFlow API Reference "clientCredentialsArn": "string", "oAuthRequest": { "authCode": "string", "redirectUri": "string" }, "refreshToken": "string" }, "Redshift": { "password": "string", "username": "string" }, "Salesforce": { "accessToken": "string", "clientCredentialsArn": "string", "jwtToken": "string", "oAuth2GrantType": "string", "oAuthRequest": { "authCode": "string", "redirectUri": "string" }, "refreshToken": "string" }, "SAPOData": { "basicAuthCredentials": { "password": "string", "username": "string" }, "oAuthCredentials": { "accessToken": "string", "clientId": "string", "clientSecret": "string", "oAuthRequest": { "authCode": "string", "redirectUri": "string" }, "refreshToken": "string" } }, "ServiceNow": { "oAuth2Credentials": { "accessToken": "string", "clientId": "string", "clientSecret": "string", "oAuthRequest": { Request Syntax API Version 2020-08-23 207 AmazonAppFlow API Reference "authCode": "string", "redirectUri": "string" }, "refreshToken": "string" }, "password": "string", "username": "string" }, "Singular": { "apiKey": "string" }, "Slack": { "accessToken": "string", "clientId": "string", "clientSecret": "string", "oAuthRequest": { "authCode": "string", "redirectUri": "string" } }, "Snowflake": { "password": "string", "username": "string" }, "Trendmicro": { "apiSecretKey": "string" }, "Veeva": { "password": "string", "username": "string" }, "Zendesk": { "accessToken": "string", "clientId": "string", "clientSecret": "string", "oAuthRequest": { "authCode": "string", "redirectUri": "string" } } }, "connectorProfileProperties": { "Amplitude": { }, Request Syntax API Version 2020-08-23 208 AmazonAppFlow API Reference "CustomConnector": { "oAuth2Properties": { "oAuth2GrantType": "string", "tokenUrl": "string", "tokenUrlCustomProperties": { "string" : "string" } }, "profileProperties": { "string" : "string" } }, "Datadog": { "instanceUrl": "string" }, "Dynatrace": { "instanceUrl": "string" }, "GoogleAnalytics": { }, "Honeycode": { }, "InforNexus": { "instanceUrl": "string" }, "Marketo": { "instanceUrl": "string" }, "Pardot": { "businessUnitId": "string", "instanceUrl": "string", "isSandboxEnvironment": boolean }, "Redshift": { "bucketName": "string", "bucketPrefix": "string", "clusterIdentifier": "string", "dataApiRoleArn": "string", "databaseName": "string", "databaseUrl": "string", "isRedshiftServerless": boolean, "roleArn": "string", "workgroupName": "string" }, Request Syntax API Version 2020-08-23 209 AmazonAppFlow API Reference "Salesforce": { "instanceUrl": "string", "isSandboxEnvironment": boolean, "usePrivateLinkForMetadataAndAuthorization": boolean }, "SAPOData": { "applicationHostUrl": "string", "applicationServicePath": "string", "clientNumber": "string", "disableSSO": boolean, "logonLanguage": "string", "oAuthProperties": { "authCodeUrl": "string", "oAuthScopes": [ "string" ], "tokenUrl": "string" }, "portNumber": number, "privateLinkServiceName": "string" }, "ServiceNow": { "instanceUrl": "string" }, "Singular": { }, "Slack": { "instanceUrl": "string" }, "Snowflake": { "accountName": "string", "bucketName": "string", "bucketPrefix": "string", "privateLinkServiceName": "string", "region": "string", "stage": "string", "warehouse": "string" }, "Trendmicro": { }, "Veeva": { "instanceUrl": "string" }, "Zendesk": { "instanceUrl": "string" } Request Syntax API Version 2020-08-23 210 API Reference AmazonAppFlow } }, "connectorProfileName": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. clientToken The clientToken parameter is an idempotency token. It ensures that your UpdateConnectorProfile request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value. If you omit a clientToken value, the AWS SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases. If you specify input parameters that diﬀer from your ﬁrst request, an error occurs. If you use a diﬀerent value for clientToken, Amazon AppFlow considers it a new call to UpdateConnectorProfile. The token is active for 8 hours. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [ -~]+ Required: No connectionMode Indicates the connection mode and if it is public or private. Type: String Valid Values: Public \| Private URI Request Parameters API Version 2020-08-23 211 AmazonAppFlow Required: Yes connectorProﬁleConﬁg API Reference Deﬁnes the connector-speciﬁc proﬁle conﬁguration and credentials. Type: ConnectorProﬁleConﬁg object Required: Yes connectorProﬁleName The name of the connector proﬁle and is unique for each
amazon-appflow-api-036	amazon-appflow-api.pdf	36	an error occurs. If you use a diﬀerent value for clientToken, Amazon AppFlow considers it a new call to UpdateConnectorProfile. The token is active for 8 hours. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [ -~]+ Required: No connectionMode Indicates the connection mode and if it is public or private. Type: String Valid Values: Public \| Private URI Request Parameters API Version 2020-08-23 211 AmazonAppFlow Required: Yes connectorProﬁleConﬁg API Reference Deﬁnes the connector-speciﬁc proﬁle conﬁguration and credentials. Type: ConnectorProﬁleConﬁg object Required: Yes connectorProﬁleName The name of the connector proﬁle and is unique for each ConnectorProfile in the AWS account. Type: String Length Constraints: Maximum length of 256. Pattern: [\w/!@#+=.-]+ Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "connectorProfileArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. connectorProﬁleArn The Amazon Resource Name (ARN) of the connector proﬁle. Type: String Length Constraints: Maximum length of 512. Response Syntax API Version 2020-08-23 212 AmazonAppFlow API Reference Pattern: arn:aws:appflow:.:[0-9]+:. Errors For information about the errors that are common to all actions, see Common Errors. ConﬂictException There was a conﬂict when processing the request (for example, a ﬂow with the given name already exists within the account. Check for conﬂicting resource names and try again. HTTP Status Code: 409 ConnectorAuthenticationException An error occurred when authenticating with the connector endpoint. HTTP Status Code: 401 InternalServerException An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ResourceNotFoundException The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not found. HTTP Status Code: 404 ValidationException The request has invalid or missing parameters. HTTP Status Code: 400 Examples UpdateConnectorProﬁle example using Salesforce This example shows a sample request and response for the UpdateConnectorProfile API using Salesforce. Errors API Version 2020-08-23 213 AmazonAppFlow Sample Request { "connectorProfileName": "Connector_Profile_Name_value", API Reference "kmsArn": null, "connectorType": "Salesforce", "connectionMode": "Public", "connectorProfileConfig": { "connectorProfileProperties": { "salesforce": { "instanceUrl": "Instance_url_value", "isSandboxEnvironment": false } }, "connectorProfileCredentials": { "salesforce": { "accessToken": "<AccessToken>", "refreshToken": "<RefreshToken>", "oauthRequest": { "authCode": null, "redirectUri": null } } } } } Sample Response { "connectorProfileArn": "arn:aws:appflow:region:<AccountId>:connectorprofile/ Connector_Profile_Name" } Examples API Version 2020-08-23 214 AmazonAppFlow See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-08-23 215 AmazonAppFlow API Reference UpdateConnectorRegistration Updates a custom connector that you've previously registered. This operation updates the connector with one of the following: • The latest version of the AWS Lambda function that's assigned to the connector • A new AWS Lambda function that you specify Request Syntax POST /update-connector-registration HTTP/1.1 Content-type: application/json { "clientToken": "string", "connectorLabel": "string", "connectorProvisioningConfig": { "lambda": { "lambdaArn": "string" } }, "description": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. clientToken The clientToken parameter is an idempotency token. It ensures that your UpdateConnectorRegistration request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value. UpdateConnectorRegistration API Version 2020-08-23 216 AmazonAppFlow API Reference If you omit a clientToken value, the AWS SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases. If you specify input parameters that diﬀer from your ﬁrst request, an error occurs. If you use a diﬀerent value for clientToken, Amazon AppFlow considers it a new call to UpdateConnectorRegistration. The token is active for 8 hours. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [ -~]+ Required: No connectorLabel The name of the connector. The name is unique for each connector registration in your AWS account. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ Required: Yes connectorProvisioningConﬁg Contains information about the conﬁguration of the connector being registered. Type: ConnectorProvisioningConﬁg object Required: No description A description about the update that you're applying to the connector. Type: String Request Body API Version 2020-08-23 217 AmazonAppFlow API Reference Length Constraints: Maximum length of 1024. Pattern: [\s\w/!@#+=.-]* Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "connectorArn": "string" } Response Elements If the action is successful, the
amazon-appflow-api-037	amazon-appflow-api.pdf	37	-~]+ Required: No connectorLabel The name of the connector. The name is unique for each connector registration in your AWS account. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ Required: Yes connectorProvisioningConﬁg Contains information about the conﬁguration of the connector being registered. Type: ConnectorProvisioningConﬁg object Required: No description A description about the update that you're applying to the connector. Type: String Request Body API Version 2020-08-23 217 AmazonAppFlow API Reference Length Constraints: Maximum length of 1024. Pattern: [\s\w/!@#+=.-]* Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "connectorArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. connectorArn The ARN of the connector being updated. Type: String Length Constraints: Maximum length of 512. Pattern: arn:aws:.:.:[0-9]+:.* Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException AppFlow/Requester has invalid or missing permissions. HTTP Status Code: 403 Response Syntax API Version 2020-08-23 218 AmazonAppFlow ConﬂictException API Reference There was a conﬂict when processing the request (for example, a ﬂow with the given name already exists within the account. Check for conﬂicting resource names and try again. HTTP Status Code: 409 ConnectorAuthenticationException An error occurred when authenticating with the connector endpoint. HTTP Status Code: 401 ConnectorServerException An error occurred when retrieving data from the connector endpoint. HTTP Status Code: 400 InternalServerException An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ResourceNotFoundException The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not found. HTTP Status Code: 404 ServiceQuotaExceededException The request would cause a service quota (such as the number of ﬂows) to be exceeded. HTTP Status Code: 402 ThrottlingException API calls have exceeded the maximum allowed API request rate per account and per Region. HTTP Status Code: 429 ValidationException The request has invalid or missing parameters. Errors API Version 2020-08-23 219 AmazonAppFlow HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-08-23 220 API Reference AmazonAppFlow UpdateFlow Updates an existing ﬂow. Request Syntax POST /update-flow HTTP/1.1 Content-type: application/json { "clientToken": "string", "description": "string", "destinationFlowConfigList": [ { "apiVersion": "string", "connectorProfileName": "string", "connectorType": "string", "destinationConnectorProperties": { "CustomConnector": { "customProperties": { "string" : "string" }, "entityName": "string", "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "idFieldNames": [ "string" ], "writeOperationType": "string" }, "CustomerProfiles": { "domainName": "string", "objectTypeName": "string" }, "EventBridge": { "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "object": "string" }, UpdateFlow API Version 2020-08-23 221 AmazonAppFlow API Reference "Honeycode": { "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "object": "string" }, "LookoutMetrics": { }, "Marketo": { "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "object": "string" }, "Redshift": { "bucketPrefix": "string", "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "intermediateBucketName": "string", "object": "string" }, "S3": { "bucketName": "string", "bucketPrefix": "string", "s3OutputFormatConfig": { "aggregationConfig": { "aggregationType": "string", "targetFileSize": number }, "fileType": "string", "prefixConfig": { "pathPrefixHierarchy": [ "string" ], "prefixFormat": "string", "prefixType": "string" }, "preserveSourceDataTyping": boolean } Request Syntax API Version 2020-08-23 222 AmazonAppFlow }, API Reference "Salesforce": { "dataTransferApi": "string", "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "idFieldNames": [ "string" ], "object": "string", "writeOperationType": "string" }, "SAPOData": { "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "idFieldNames": [ "string" ], "objectPath": "string", "successResponseHandlingConfig": { "bucketName": "string", "bucketPrefix": "string" }, "writeOperationType": "string" }, "Snowflake": { "bucketPrefix": "string", "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "intermediateBucketName": "string", "object": "string" }, "Upsolver": { "bucketName": "string", "bucketPrefix": "string", "s3OutputFormatConfig": { "aggregationConfig": { "aggregationType": "string", "targetFileSize": number }, Request Syntax API Version 2020-08-23 223 AmazonAppFlow API Reference "fileType": "string", "prefixConfig": { "pathPrefixHierarchy": [ "string" ], "prefixFormat": "string", "prefixType": "string" } } }, "Zendesk": { "errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "idFieldNames": [ "string" ], "object": "string", "writeOperationType": "string" } } } ], "flowName": "string", "metadataCatalogConfig": { "glueDataCatalog": { "databaseName": "string", "roleArn": "string", "tablePrefix": "string" } }, "sourceFlowConfig": { "apiVersion": "string", "connectorProfileName": "string", "connectorType": "string", "incrementalPullConfig": { "datetimeTypeFieldName": "string" }, "sourceConnectorProperties": { "Amplitude": { "object": "string" }, "CustomConnector": { "customProperties": { "string" : "string" }, Request Syntax API Version 2020-08-23 224 AmazonAppFlow API Reference "dataTransferApi": { "Name": "string", "Type": "string" }, "entityName": "string" }, "Datadog": { "object": "string" }, "Dynatrace": { "object": "string" }, "GoogleAnalytics": { "object": "string" }, "InforNexus": { "object":
amazon-appflow-api-038	amazon-appflow-api.pdf	38	"errorHandlingConfig": { "bucketName": "string", "bucketPrefix": "string", "failOnFirstDestinationError": boolean }, "idFieldNames": [ "string" ], "object": "string", "writeOperationType": "string" } } } ], "flowName": "string", "metadataCatalogConfig": { "glueDataCatalog": { "databaseName": "string", "roleArn": "string", "tablePrefix": "string" } }, "sourceFlowConfig": { "apiVersion": "string", "connectorProfileName": "string", "connectorType": "string", "incrementalPullConfig": { "datetimeTypeFieldName": "string" }, "sourceConnectorProperties": { "Amplitude": { "object": "string" }, "CustomConnector": { "customProperties": { "string" : "string" }, Request Syntax API Version 2020-08-23 224 AmazonAppFlow API Reference "dataTransferApi": { "Name": "string", "Type": "string" }, "entityName": "string" }, "Datadog": { "object": "string" }, "Dynatrace": { "object": "string" }, "GoogleAnalytics": { "object": "string" }, "InforNexus": { "object": "string" }, "Marketo": { "object": "string" }, "Pardot": { "object": "string" }, "S3": { "bucketName": "string", "bucketPrefix": "string", "s3InputFormatConfig": { "s3InputFileType": "string" } }, "Salesforce": { "dataTransferApi": "string", "enableDynamicFieldUpdate": boolean, "includeDeletedRecords": boolean, "object": "string" }, "SAPOData": { "objectPath": "string", "paginationConfig": { "maxPageSize": number }, "parallelismConfig": { "maxParallelism": number Request Syntax API Version 2020-08-23 225 AmazonAppFlow API Reference } }, "ServiceNow": { "object": "string" }, "Singular": { "object": "string" }, "Slack": { "object": "string" }, "Trendmicro": { "object": "string" }, "Veeva": { "documentType": "string", "includeAllVersions": boolean, "includeRenditions": boolean, "includeSourceFiles": boolean, "object": "string" }, "Zendesk": { "object": "string" } } }, "tasks": [ { "connectorOperator": { "Amplitude": "string", "CustomConnector": "string", "Datadog": "string", "Dynatrace": "string", "GoogleAnalytics": "string", "InforNexus": "string", "Marketo": "string", "Pardot": "string", "S3": "string", "Salesforce": "string", "SAPOData": "string", "ServiceNow": "string", "Singular": "string", "Slack": "string", "Trendmicro": "string", Request Syntax API Version 2020-08-23 226 AmazonAppFlow API Reference "Veeva": "string", "Zendesk": "string" }, "destinationField": "string", "sourceFields": [ "string" ], "taskProperties": { "string" : "string" }, "taskType": "string" } ], "triggerConfig": { "triggerProperties": { "Scheduled": { "dataPullMode": "string", "firstExecutionFrom": number, "flowErrorDeactivationThreshold": number, "scheduleEndTime": number, "scheduleExpression": "string", "scheduleOffset": number, "scheduleStartTime": number, "timezone": "string" } }, "triggerType": "string" } } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. clientToken The clientToken parameter is an idempotency token. It ensures that your UpdateFlow request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value. URI Request Parameters API Version 2020-08-23 227 AmazonAppFlow API Reference If you omit a clientToken value, the AWS SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases. If you specify input parameters that diﬀer from your ﬁrst request, an error occurs. If you use a diﬀerent value for clientToken, Amazon AppFlow considers it a new call to UpdateFlow. The token is active for 8 hours. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [ -~]+ Required: No description A description of the ﬂow. Type: String Length Constraints: Maximum length of 2048. Pattern: [\w!@#\-.?,\s]* Required: No destinationFlowConﬁgList The conﬁguration that controls how Amazon AppFlow transfers data to the destination connector. Type: Array of DestinationFlowConﬁg objects Required: Yes ﬂowName The speciﬁed name of the ﬂow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ Request Body API Version 2020-08-23 228 AmazonAppFlow Required: Yes metadataCatalogConﬁg API Reference Speciﬁes the conﬁguration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated ﬂow. When Amazon AppFlow catalogs the data from a ﬂow, it stores metadata in a data catalog. Type: MetadataCatalogConﬁg object Required: No sourceFlowConﬁg Contains information about the conﬁguration of the source connector used in the ﬂow. Type: SourceFlowConﬁg object Required: Yes tasks A list of tasks that Amazon AppFlow performs while transferring the data in the ﬂow run. Type: Array of Task objects Required: Yes triggerConﬁg The trigger settings that determine how and when the ﬂow runs. Type: TriggerConﬁg object Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "flowStatus": "string" } Response Syntax API Version 2020-08-23 229 AmazonAppFlow Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ﬂowStatus Indicates the current status of the ﬂow. Type: String Valid Values: Active \| Deprecated \| Deleted \| Draft \| Errored \| Suspended Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException AppFlow/Requester has invalid or missing permissions. HTTP Status Code: 403 ConﬂictException There was a conﬂict when processing the request (for example, a ﬂow with the given name already exists within the account. Check for conﬂicting resource names and try again. HTTP Status Code: 409 ConnectorAuthenticationException An error occurred when authenticating with the connector endpoint. HTTP Status Code: 401 ConnectorServerException An error occurred when retrieving data from the connector endpoint. HTTP Status
amazon-appflow-api-039	amazon-appflow-api.pdf	39	Valid Values: Active \| Deprecated \| Deleted \| Draft \| Errored \| Suspended Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException AppFlow/Requester has invalid or missing permissions. HTTP Status Code: 403 ConﬂictException There was a conﬂict when processing the request (for example, a ﬂow with the given name already exists within the account. Check for conﬂicting resource names and try again. HTTP Status Code: 409 ConnectorAuthenticationException An error occurred when authenticating with the connector endpoint. HTTP Status Code: 401 ConnectorServerException An error occurred when retrieving data from the connector endpoint. HTTP Status Code: 400 InternalServerException An internal service error occurred during the processing of your request. Try again later. Response Elements API Version 2020-08-23 230 AmazonAppFlow HTTP Status Code: 500 ResourceNotFoundException API Reference The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not found. HTTP Status Code: 404 ServiceQuotaExceededException The request would cause a service quota (such as the number of ﬂows) to be exceeded. HTTP Status Code: 402 ValidationException The request has invalid or missing parameters. HTTP Status Code: 400 Examples Salesforce This example shows a sample request for the UpdateFlow API using Salesforce. Sample Request { "flowName": "testFlow-newpayload", "description": "TestFlow", "triggerConfig": { "triggerType": "OnDemand" }, "sourceFlowConfig": { "connectorType": "Salesforce", "connectorProfileName": "Connector_Profile_Name", "sourceConnectorProperties": { "salesforce": { "object": "account" } } }, "destinationFlowConfigList": [ Examples API Version 2020-08-23 231 API Reference AmazonAppFlow { "connectorType": "S3", "connectorProfileName": "Test", "destinationConnectorProperties": { "s3": { "bucketName": "Bucket_Name_value", "bucketKey": "Bucket_Name_value" } } } ], "tasks": [ { "sourceFields": ["CreatedDate"], "taskProperties": {}, "destinationField": "CreatedDate", "taskType": "Map" }, { "destinationField": "LastActivityDate", "sourceFields": ["LastActivityDate"], "taskProperties": {}, "taskType": "Map" } ] } Zendesk This example shows a sample request for the UpdateFlow API using Zendesk. Sample Request { "useDefaultEncryption": false, "flowName": "testFlowZendesk", "description": "TestFlow", "triggerConfig": { "triggerType": "OnDemand" }, "sourceFlowConfig": { "connectorType": "Zendesk", "connectorProfileName": "connector-profile-name", Examples API Version 2020-08-23 232 AmazonAppFlow API Reference "sourceConnectorProperties": { "zendesk": { "object": "tickets" } } }, "destinationFlowConfigList": [ { "connectorType": "S3", "connectorProfileName": "Test", "destinationConnectorProperties": { "s3": { "bucketName": "Bucket_Name_Value", "bucketKey": "Bucket_Name_Value" } } } ], "tasks": [ { "destinationField": "url", "sourceFields": ["url"], "taskProperties": { "SOURCE_DATA_TYPE": "integer" }, "taskType": "Map" } ] } Google Analytics This example shows a sample request for the UpdateFlow API using Google Analytics. Sample Request { "useDefaultEncryption": false, "flowName": "testFlowGAnalytics", "description": "TestFlow", "triggerConfig": { "triggerType": "OnDemand" }, Examples API Version 2020-08-23 233 API Reference AmazonAppFlow "sourceFlowConfig": { "connectorType": "Googleanalytics", "connectorProfileName": "connector-profile-name", "sourceConnectorProperties": { "googleanalytics": { "object": "Object_ID" } } }, "destinationFlowConfigList": [ { "connectorType": "S3", "connectorProfileName": "Test", "destinationConnectorProperties": { "s3": { "bucketName": "Bucket_Name_Value", "bucketKey": "Bucket_Name_Value" } } } ], "tasks": [ { "destinationField": "url", "sourceFields": ["url"], "taskProperties": { "SOURCE_DATA_TYPE": "integer" }, "taskType": "Map" } ] } Marketo This example shows a sample request for the UpdateFlow API using Marketo. Sample Request { "flowName": "testMarketo", "description": "TestFlow", "triggerConfig": { Examples API Version 2020-08-23 234 AmazonAppFlow API Reference "triggerType": "OnDemand" }, "sourceFlowConfig": { "connectorType": "Marketo", "connectorProfileName": "Connector-profile-new", "sourceConnectorProperties": { "marketo": { "object": "leads" } } }, "destinationFlowConfigList": [ { "connectorType": "S3", "connectorProfileName": "Test", "destinationConnectorProperties": { "s3": { "bucketName": "Bucket_Name_Value", "bucketKey": "Bucket_Name_Value" } } } ], "tasks": [ { "connectorOperator": { "marketo":"BETWEEN" }, "sourceFields": [ "updatedAt" ], "taskProperties": { "DATA_TYPE": "datetime", "LOWER_BOUND": "Lower_Bound_value", "UPPER_BOUND": "Upper_Bound_value" }, "taskType": "Filter" }, { "destinationField": "company", "sourceFields": [ "company" ], "taskProperties": { Examples API Version 2020-08-23 235 AmazonAppFlow API Reference "SOURCE_DATA_TYPE": "string" }, "taskType": "Map" } ] } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-08-23 236 AmazonAppFlow Data Types API Reference The Amazon Appﬂow API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • AggregationConﬁg • AmplitudeConnectorProﬁleCredentials • AmplitudeConnectorProﬁleProperties • AmplitudeMetadata • AmplitudeSourceProperties • ApiKeyCredentials • AuthenticationConﬁg • AuthParameter • BasicAuthCredentials • ConnectorConﬁguration • ConnectorDetail • ConnectorEntity • ConnectorEntityField • ConnectorMetadata • ConnectorOAuthRequest • ConnectorOperator • ConnectorProﬁle • ConnectorProﬁleConﬁg • ConnectorProﬁleCredentials • ConnectorProﬁleProperties API Version 2020-08-23 237 AmazonAppFlow • ConnectorProvisioningConﬁg • ConnectorRuntimeSetting • CustomAuthConﬁg • CustomAuthCredentials • CustomConnectorDestinationProperties • CustomConnectorProﬁleCredentials • CustomConnectorProﬁleProperties • CustomConnectorSourceProperties • CustomerProﬁlesDestinationProperties • CustomerProﬁlesMetadata • DatadogConnectorProﬁleCredentials • DatadogConnectorProﬁleProperties • DatadogMetadata • DatadogSourceProperties • DataTransferApi • DestinationConnectorProperties • DestinationFieldProperties • DestinationFlowConﬁg • DynatraceConnectorProﬁleCredentials • DynatraceConnectorProﬁleProperties • DynatraceMetadata • DynatraceSourceProperties • ErrorHandlingConﬁg • ErrorInfo • EventBridgeDestinationProperties • EventBridgeMetadata • ExecutionDetails • ExecutionRecord •
amazon-appflow-api-040	amazon-appflow-api.pdf	40	• AmplitudeConnectorProﬁleCredentials • AmplitudeConnectorProﬁleProperties • AmplitudeMetadata • AmplitudeSourceProperties • ApiKeyCredentials • AuthenticationConﬁg • AuthParameter • BasicAuthCredentials • ConnectorConﬁguration • ConnectorDetail • ConnectorEntity • ConnectorEntityField • ConnectorMetadata • ConnectorOAuthRequest • ConnectorOperator • ConnectorProﬁle • ConnectorProﬁleConﬁg • ConnectorProﬁleCredentials • ConnectorProﬁleProperties API Version 2020-08-23 237 AmazonAppFlow • ConnectorProvisioningConﬁg • ConnectorRuntimeSetting • CustomAuthConﬁg • CustomAuthCredentials • CustomConnectorDestinationProperties • CustomConnectorProﬁleCredentials • CustomConnectorProﬁleProperties • CustomConnectorSourceProperties • CustomerProﬁlesDestinationProperties • CustomerProﬁlesMetadata • DatadogConnectorProﬁleCredentials • DatadogConnectorProﬁleProperties • DatadogMetadata • DatadogSourceProperties • DataTransferApi • DestinationConnectorProperties • DestinationFieldProperties • DestinationFlowConﬁg • DynatraceConnectorProﬁleCredentials • DynatraceConnectorProﬁleProperties • DynatraceMetadata • DynatraceSourceProperties • ErrorHandlingConﬁg • ErrorInfo • EventBridgeDestinationProperties • EventBridgeMetadata • ExecutionDetails • ExecutionRecord • ExecutionResult • FieldTypeDetails API Reference API Version 2020-08-23 238 AmazonAppFlow • FlowDeﬁnition • GlueDataCatalogConﬁg • GoogleAnalyticsConnectorProﬁleCredentials • GoogleAnalyticsConnectorProﬁleProperties • GoogleAnalyticsMetadata • GoogleAnalyticsSourceProperties • HoneycodeConnectorProﬁleCredentials • HoneycodeConnectorProﬁleProperties • HoneycodeDestinationProperties • HoneycodeMetadata • IncrementalPullConﬁg • InforNexusConnectorProﬁleCredentials • InforNexusConnectorProﬁleProperties • InforNexusMetadata • InforNexusSourceProperties • LambdaConnectorProvisioningConﬁg • LookoutMetricsDestinationProperties • MarketoConnectorProﬁleCredentials • MarketoConnectorProﬁleProperties • MarketoDestinationProperties • MarketoMetadata • MarketoSourceProperties • MetadataCatalogConﬁg • MetadataCatalogDetail • OAuth2Credentials • OAuth2CustomParameter • OAuth2Defaults • OAuth2Properties • OAuthCredentials • OAuthProperties API Reference API Version 2020-08-23 239 AmazonAppFlow API Reference • PardotConnectorProﬁleCredentials • PardotConnectorProﬁleProperties • PardotMetadata • PardotSourceProperties • PreﬁxConﬁg • PrivateConnectionProvisioningState • Range • RedshiftConnectorProﬁleCredentials • RedshiftConnectorProﬁleProperties • RedshiftDestinationProperties • RedshiftMetadata • RegistrationOutput • S3DestinationProperties • S3InputFormatConﬁg • S3Metadata • S3OutputFormatConﬁg • S3SourceProperties • SalesforceConnectorProﬁleCredentials • SalesforceConnectorProﬁleProperties • SalesforceDestinationProperties • SalesforceMetadata • SalesforceSourceProperties • SAPODataConnectorProﬁleCredentials • SAPODataConnectorProﬁleProperties • SAPODataDestinationProperties • SAPODataMetadata • SAPODataPaginationConﬁg • SAPODataParallelismConﬁg • SAPODataSourceProperties • ScheduledTriggerProperties API Version 2020-08-23 240 AmazonAppFlow API Reference • ServiceNowConnectorProﬁleCredentials • ServiceNowConnectorProﬁleProperties • ServiceNowMetadata • ServiceNowSourceProperties • SingularConnectorProﬁleCredentials • SingularConnectorProﬁleProperties • SingularMetadata • SingularSourceProperties • SlackConnectorProﬁleCredentials • SlackConnectorProﬁleProperties • SlackMetadata • SlackSourceProperties • SnowﬂakeConnectorProﬁleCredentials • SnowﬂakeConnectorProﬁleProperties • SnowﬂakeDestinationProperties • SnowﬂakeMetadata • SourceConnectorProperties • SourceFieldProperties • SourceFlowConﬁg • SuccessResponseHandlingConﬁg • SupportedFieldTypeDetails • Task • TrendmicroConnectorProﬁleCredentials • TrendmicroConnectorProﬁleProperties • TrendmicroMetadata • TrendmicroSourceProperties • TriggerConﬁg • TriggerProperties • UpsolverDestinationProperties • UpsolverMetadata API Version 2020-08-23 241 AmazonAppFlow API Reference • UpsolverS3OutputFormatConﬁg • VeevaConnectorProﬁleCredentials • VeevaConnectorProﬁleProperties • VeevaMetadata • VeevaSourceProperties • ZendeskConnectorProﬁleCredentials • ZendeskConnectorProﬁleProperties • ZendeskDestinationProperties • ZendeskMetadata • ZendeskSourceProperties API Version 2020-08-23 242 AmazonAppFlow AggregationConﬁg API Reference The aggregation settings that you can use to customize the output format of your ﬂow data. Contents aggregationType Speciﬁes whether Amazon AppFlow aggregates the ﬂow records into a single ﬁle, or leave them unaggregated. Type: String Valid Values: None \| SingleFile Required: No targetFileSize The desired ﬁle size, in MB, for each output ﬁle that Amazon AppFlow writes to the ﬂow destination. For each ﬁle, Amazon AppFlow attempts to achieve the size that you specify. The actual ﬁle sizes might diﬀer from this target based on the number and size of the records that each ﬁle contains. Type: Long Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AggregationConﬁg API Version 2020-08-23 243 AmazonAppFlow API Reference AmplitudeConnectorProﬁleCredentials The connector-speciﬁc credentials required when using Amplitude. Contents apiKey A unique alphanumeric identiﬁer used to authenticate a user, developer, or calling program to your API. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: Yes secretKey The Secret Access Key portion of the credentials. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AmplitudeConnectorProﬁleCredentials API Version 2020-08-23 244 AmazonAppFlow API Reference AmplitudeConnectorProﬁleProperties The connector-speciﬁc proﬁle properties required when using Amplitude. Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AmplitudeConnectorProﬁleProperties API Version 2020-08-23 245 AmazonAppFlow API Reference AmplitudeMetadata The connector metadata speciﬁc to Amplitude. Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AmplitudeMetadata API Version 2020-08-23 246 AmazonAppFlow API Reference AmplitudeSourceProperties The properties that are applied when Amplitude is being used as a source. Contents object The object speciﬁed in the Amplitude ﬂow source. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AmplitudeSourceProperties API Version 2020-08-23 247 AmazonAppFlow ApiKeyCredentials The API key credentials required for API key authentication. API
amazon-appflow-api-041	amazon-appflow-api.pdf	41	for Ruby V3 AmplitudeMetadata API Version 2020-08-23 246 AmazonAppFlow API Reference AmplitudeSourceProperties The properties that are applied when Amplitude is being used as a source. Contents object The object speciﬁed in the Amplitude ﬂow source. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AmplitudeSourceProperties API Version 2020-08-23 247 AmazonAppFlow ApiKeyCredentials The API key credentials required for API key authentication. API Reference Contents apiKey The API key required for API key authentication. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: Yes apiSecretKey The API secret key required for API key authentication. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ApiKeyCredentials API Version 2020-08-23 248 AmazonAppFlow API Reference AuthenticationConﬁg Contains information about the authentication conﬁg that the connector supports. Contents customAuthConﬁgs Contains information required for custom authentication. Type: Array of CustomAuthConﬁg objects Required: No isApiKeyAuthSupported Indicates whether API key authentication is supported by the connector Type: Boolean Required: No isBasicAuthSupported Indicates whether basic authentication is supported by the connector. Type: Boolean Required: No isCustomAuthSupported Indicates whether custom authentication is supported by the connector Type: Boolean Required: No isOAuth2Supported Indicates whether OAuth 2.0 authentication is supported by the connector. Type: Boolean Required: No AuthenticationConﬁg API Version 2020-08-23 249 AmazonAppFlow oAuth2Defaults API Reference Contains the default values required for OAuth 2.0 authentication. Type: OAuth2Defaults object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 250 AmazonAppFlow AuthParameter Information about required authentication parameters. Contents connectorSuppliedValues API Reference Contains default values for this authentication parameter that are supplied by the connector. Type: Array of strings Length Constraints: Maximum length of 256. Pattern: \S+ Required: No description A description about the authentication parameter. Type: String Length Constraints: Maximum length of 1024. Pattern: [\s\w/!@#+=.-]* Required: No isRequired Indicates whether this authentication parameter is required. Type: Boolean Required: No isSensitiveField Indicates whether this authentication parameter is a sensitive ﬁeld. Type: Boolean Required: No AuthParameter API Version 2020-08-23 251 AmazonAppFlow key API Reference The authentication key required to authenticate with the connector. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: No label Label used for authentication parameter. Type: String Length Constraints: Maximum length of 128. Pattern: .* Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 252 AmazonAppFlow API Reference BasicAuthCredentials The basic auth credentials required for basic authentication. Contents password The password to use to connect to a resource. Type: String Length Constraints: Maximum length of 512. Pattern: .* Required: Yes username The username to use to connect to a resource. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 BasicAuthCredentials API Version 2020-08-23 253 AmazonAppFlow API Reference ConnectorConﬁguration The conﬁguration settings related to a given connector. Contents authenticationConﬁg The authentication conﬁg required for the connector. Type: AuthenticationConﬁg object Required: No canUseAsDestination Speciﬁes whether the connector can be used as a destination. Type: Boolean Required: No canUseAsSource Speciﬁes whether the connector can be used as a source. Type: Boolean Required: No connectorArn The Amazon Resource Name (ARN) for the registered connector. Type: String Length Constraints: Maximum length of 512. Pattern: arn:aws:.:.:[0-9]+:.* Required: No connectorDescription A description about the connector. ConnectorConﬁguration API Version 2020-08-23 254 API Reference AmazonAppFlow Type: String Length Constraints: Maximum length of 2048. Pattern: [\w!@#\-.?,\s]* Required: No connectorLabel The label used for registering the connector. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ Required: No connectorMetadata Speciﬁes connector-speciﬁc metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on. Type: ConnectorMetadata object Required: No connectorModes The connection modes that the connector supports. Type: Array of strings Length Constraints: Maximum length of 256. Pattern: \S+ Required: No connectorName The connector name. Type: String Contents API Version 2020-08-23 255 AmazonAppFlow API Reference Length Constraints: Maximum length of 256. Pattern: .* Required: No connectorOwner The owner who
amazon-appflow-api-042	amazon-appflow-api.pdf	42	AmazonAppFlow Type: String Length Constraints: Maximum length of 2048. Pattern: [\w!@#\-.?,\s]* Required: No connectorLabel The label used for registering the connector. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ Required: No connectorMetadata Speciﬁes connector-speciﬁc metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on. Type: ConnectorMetadata object Required: No connectorModes The connection modes that the connector supports. Type: Array of strings Length Constraints: Maximum length of 256. Pattern: \S+ Required: No connectorName The connector name. Type: String Contents API Version 2020-08-23 255 AmazonAppFlow API Reference Length Constraints: Maximum length of 256. Pattern: .* Required: No connectorOwner The owner who developed the connector. Type: String Length Constraints: Maximum length of 256. Pattern: .* Required: No connectorProvisioningConﬁg The conﬁguration required for registering the connector. Type: ConnectorProvisioningConﬁg object Required: No connectorProvisioningType The provisioning type used to register the connector. Type: String Valid Values: LAMBDA Required: No connectorRuntimeSettings The required connector runtime settings. Type: Array of ConnectorRuntimeSetting objects Required: No connectorType The connector type. Contents API Version 2020-08-23 256 AmazonAppFlow Type: String API Reference Valid Values: Salesforce \| Singular \| Slack \| Redshift \| S3 \| Marketo \| Googleanalytics \| Zendesk \| Servicenow \| Datadog \| Trendmicro \| Snowflake \| Dynatrace \| Infornexus \| Amplitude \| Veeva \| EventBridge \| LookoutMetrics \| Upsolver \| Honeycode \| CustomerProfiles \| SAPOData \| CustomConnector \| Pardot Required: No connectorVersion The connector version. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: No isPrivateLinkEnabled Speciﬁes if PrivateLink is enabled for that connector. Type: Boolean Required: No isPrivateLinkEndpointUrlRequired Speciﬁes if a PrivateLink endpoint URL is required. Type: Boolean Required: No logoURL Logo URL of the connector. Type: String Length Constraints: Maximum length of 256. Contents API Version 2020-08-23 257 AmazonAppFlow API Reference Pattern: ^(https?\|ftp\|file)://[-a-zA-Z0-9+&@#/%?=~_\|!:,.;][-a-zA-Z0-9+&@#/ %=~_\|] Required: No registeredAt The date on which the connector was registered. Type: Timestamp Required: No registeredBy Information about who registered the connector. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: No supportedApiVersions A list of API versions that are supported by the connector. Type: Array of strings Length Constraints: Maximum length of 256. Pattern: \S+ Required: No supportedDataTransferApis The APIs of the connector application that Amazon AppFlow can use to transfer your data. Type: Array of DataTransferApi objects Required: No supportedDataTransferTypes The data transfer types that the connector supports. Contents API Version 2020-08-23 258 API Reference AmazonAppFlow RECORD Structured records. FILE Files or binary data. Type: Array of strings Valid Values: RECORD \| FILE Required: No supportedDestinationConnectors Lists the connectors that are available for use as destinations. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 100 items. Valid Values: Salesforce \| Singular \| Slack \| Redshift \| S3 \| Marketo \| Googleanalytics \| Zendesk \| Servicenow \| Datadog \| Trendmicro \| Snowflake \| Dynatrace \| Infornexus \| Amplitude \| Veeva \| EventBridge \| LookoutMetrics \| Upsolver \| Honeycode \| CustomerProfiles \| SAPOData \| CustomConnector \| Pardot Required: No supportedOperators A list of operators supported by the connector. Type: Array of strings Valid Values: PROJECTION \| LESS_THAN \| GREATER_THAN \| CONTAINS \| BETWEEN \| LESS_THAN_OR_EQUAL_TO \| GREATER_THAN_OR_EQUAL_TO \| EQUAL_TO \| NOT_EQUAL_TO \| ADDITION \| MULTIPLICATION \| DIVISION \| SUBTRACTION \| MASK_ALL \| MASK_FIRST_N \| MASK_LAST_N \| VALIDATE_NON_NULL \| VALIDATE_NON_ZERO \| VALIDATE_NON_NEGATIVE \| VALIDATE_NUMERIC \| NO_OP Required: No Contents API Version 2020-08-23 259 AmazonAppFlow API Reference supportedSchedulingFrequencies Speciﬁes the supported ﬂow frequency for that connector. Type: Array of strings Valid Values: BYMINUTE \| HOURLY \| DAILY \| WEEKLY \| MONTHLY \| ONCE Required: No supportedTriggerTypes Speciﬁes the supported trigger types for the ﬂow. Type: Array of strings Valid Values: Scheduled \| Event \| OnDemand Required: No supportedWriteOperations A list of write operations supported by the connector. Type: Array of strings Valid Values: INSERT \| UPSERT \| UPDATE \| DELETE Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 260 API Reference AmazonAppFlow ConnectorDetail Information about the registered connector. Contents applicationType The application type of the connector. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: No connectorDescription A description about the registered connector. Type: String Length Constraints: Maximum length of 2048. Pattern: [\w!@#\-.?,\s] Required: No connectorLabel A label used for the connector. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ Required: No connectorModes The connection mode that the connector supports. ConnectorDetail API Version 2020-08-23 261 API Reference AmazonAppFlow Type: Array of strings Length Constraints: Maximum length of 256. Pattern: \S+ Required: No connectorName The name of the connector. Type: String Length Constraints: Maximum length of 256. Pattern: .* Required: No connectorOwner The owner of the connector. Type: String Length Constraints: Maximum length of 256. Pattern: .*
amazon-appflow-api-043	amazon-appflow-api.pdf	43	description about the registered connector. Type: String Length Constraints: Maximum length of 2048. Pattern: [\w!@#\-.?,\s]* Required: No connectorLabel A label used for the connector. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ Required: No connectorModes The connection mode that the connector supports. ConnectorDetail API Version 2020-08-23 261 API Reference AmazonAppFlow Type: Array of strings Length Constraints: Maximum length of 256. Pattern: \S+ Required: No connectorName The name of the connector. Type: String Length Constraints: Maximum length of 256. Pattern: .* Required: No connectorOwner The owner of the connector. Type: String Length Constraints: Maximum length of 256. Pattern: .* Required: No connectorProvisioningType The provisioning type that the connector uses. Type: String Valid Values: LAMBDA Required: No connectorType The connector type. Type: String Contents API Version 2020-08-23 262 AmazonAppFlow API Reference Valid Values: Salesforce \| Singular \| Slack \| Redshift \| S3 \| Marketo \| Googleanalytics \| Zendesk \| Servicenow \| Datadog \| Trendmicro \| Snowflake \| Dynatrace \| Infornexus \| Amplitude \| Veeva \| EventBridge \| LookoutMetrics \| Upsolver \| Honeycode \| CustomerProfiles \| SAPOData \| CustomConnector \| Pardot Required: No connectorVersion The connector version. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: No registeredAt The time at which the connector was registered. Type: Timestamp Required: No registeredBy The user who registered the connector. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: No supportedDataTransferTypes The data transfer types that the connector supports. RECORD Structured records. Contents API Version 2020-08-23 263 API Reference AmazonAppFlow FILE Files or binary data. Type: Array of strings Valid Values: RECORD \| FILE Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 264 AmazonAppFlow ConnectorEntity API Reference The high-level entity that can be queried in Amazon AppFlow. For example, a Salesforce entity might be an Account or Opportunity, whereas a ServiceNow entity might be an Incident. Contents name The name of the connector entity. Type: String Length Constraints: Maximum length of 128. Pattern: \S+ Required: Yes hasNestedEntities Speciﬁes whether the connector entity is a parent or a category and has more entities nested underneath it. If another call is made with entitiesPath = "the_current_entity_name_with_hasNestedEntities_true", then it returns the nested entities underneath it. This provides a way to retrieve all supported entities in a recursive fashion. Type: Boolean Required: No label The label applied to the connector entity. Type: String Length Constraints: Maximum length of 128. Pattern: .* Required: No ConnectorEntity API Version 2020-08-23 265 AmazonAppFlow See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 266 AmazonAppFlow API Reference ConnectorEntityField Describes the data model of a connector ﬁeld. For example, for an account entity, the ﬁelds would be account name, account ID, and so on. Contents identiﬁer The unique identiﬁer of the connector ﬁeld. Type: String Length Constraints: Maximum length of 128. Pattern: \S+ Required: Yes customProperties A map that has speciﬁc properties related to the ConnectorEntityField. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: [\w]+ Value Length Constraints: Maximum length of 2048. Value Pattern: \S+ Required: No defaultValue Default value that can be assigned to this ﬁeld. Type: String Length Constraints: Maximum length of 2048. ConnectorEntityField API Version 2020-08-23 267 API Reference AmazonAppFlow Pattern: .* Required: No description A description of the connector entity ﬁeld. Type: String Length Constraints: Maximum length of 1024. Pattern: [\s\w/!@#+=.-]* Required: No destinationProperties The properties applied to a ﬁeld when the connector is being used as a destination. Type: DestinationFieldProperties object Required: No isDeprecated Booelan value that indicates whether this ﬁeld is deprecated or not. Type: Boolean Required: No isPrimaryKey Booelan value that indicates whether this ﬁeld can be used as a primary key. Type: Boolean Required: No label The label applied to a connector entity ﬁeld. Type: String Length Constraints: Maximum length of 128. Contents API Version 2020-08-23 268 API Reference AmazonAppFlow Pattern: .* Required: No parentIdentiﬁer The parent identiﬁer of the connector ﬁeld. Type: String Length Constraints: Maximum length of 128. Pattern: \S+ Required: No sourceProperties The properties that can be applied to a ﬁeld when the connector is being used as a source. Type: SourceFieldProperties object Required: No supportedFieldTypeDetails Contains details regarding the supported FieldType, including the corresponding filterOperators and supportedValues. Type: SupportedFieldTypeDetails object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS
amazon-appflow-api-044	amazon-appflow-api.pdf	44	connector entity ﬁeld. Type: String Length Constraints: Maximum length of 128. Contents API Version 2020-08-23 268 API Reference AmazonAppFlow Pattern: .* Required: No parentIdentiﬁer The parent identiﬁer of the connector ﬁeld. Type: String Length Constraints: Maximum length of 128. Pattern: \S+ Required: No sourceProperties The properties that can be applied to a ﬁeld when the connector is being used as a source. Type: SourceFieldProperties object Required: No supportedFieldTypeDetails Contains details regarding the supported FieldType, including the corresponding filterOperators and supportedValues. Type: SupportedFieldTypeDetails object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 269 AmazonAppFlow ConnectorMetadata API Reference A structure to specify connector-speciﬁc metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on. Contents Amplitude The connector metadata speciﬁc to Amplitude. Type: AmplitudeMetadata object Required: No CustomerProﬁles The connector metadata speciﬁc to Amazon Connect Customer Proﬁles. Type: CustomerProﬁlesMetadata object Required: No Datadog The connector metadata speciﬁc to Datadog. Type: DatadogMetadata object Required: No Dynatrace The connector metadata speciﬁc to Dynatrace. Type: DynatraceMetadata object Required: No EventBridge The connector metadata speciﬁc to Amazon EventBridge. Type: EventBridgeMetadata object Required: No ConnectorMetadata API Version 2020-08-23 270 AmazonAppFlow GoogleAnalytics The connector metadata speciﬁc to Google Analytics. Type: GoogleAnalyticsMetadata object Required: No Honeycode The connector metadata speciﬁc to Amazon Honeycode. Type: HoneycodeMetadata object Required: No InforNexus The connector metadata speciﬁc to Infor Nexus. Type: InforNexusMetadata object Required: No Marketo The connector metadata speciﬁc to Marketo. Type: MarketoMetadata object Required: No Pardot The connector metadata speciﬁc to Salesforce Pardot. Type: PardotMetadata object Required: No Redshift The connector metadata speciﬁc to Amazon Redshift. Type: RedshiftMetadata object Required: No Contents API Reference API Version 2020-08-23 271 AmazonAppFlow S3 The connector metadata speciﬁc to Amazon S3. Type: S3Metadata object Required: No Salesforce The connector metadata speciﬁc to Salesforce. Type: SalesforceMetadata object Required: No SAPOData The connector metadata speciﬁc to SAPOData. Type: SAPODataMetadata object Required: No ServiceNow The connector metadata speciﬁc to ServiceNow. Type: ServiceNowMetadata object Required: No Singular The connector metadata speciﬁc to Singular. Type: SingularMetadata object Required: No Slack The connector metadata speciﬁc to Slack. Type: SlackMetadata object Required: No Contents API Reference API Version 2020-08-23 272 API Reference AmazonAppFlow Snowﬂake The connector metadata speciﬁc to Snowﬂake. Type: SnowﬂakeMetadata object Required: No Trendmicro The connector metadata speciﬁc to Trend Micro. Type: TrendmicroMetadata object Required: No Upsolver The connector metadata speciﬁc to Upsolver. Type: UpsolverMetadata object Required: No Veeva The connector metadata speciﬁc to Veeva. Type: VeevaMetadata object Required: No Zendesk The connector metadata speciﬁc to Zendesk. Type: ZendeskMetadata object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2020-08-23 273 AmazonAppFlow • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 274 AmazonAppFlow API Reference ConnectorOAuthRequest Used by select connectors for which the OAuth workﬂow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack. Contents authCode The code provided by the connector when it has been authenticated via the connected app. Type: String Length Constraints: Maximum length of 4096. Pattern: \S+ Required: No redirectUri The URL to which the authentication server redirects the browser after authorization has been granted. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ConnectorOAuthRequest API Version 2020-08-23 275 AmazonAppFlow ConnectorOperator The operation to be performed on the provided source ﬁelds. API Reference Contents Amplitude The operation to be performed on the provided Amplitude source ﬁelds. Type: String Valid Values: BETWEEN Required: No CustomConnector Operators supported by the custom connector. Type: String Valid Values: PROJECTION \| LESS_THAN \| GREATER_THAN \| CONTAINS \| BETWEEN \| LESS_THAN_OR_EQUAL_TO \| GREATER_THAN_OR_EQUAL_TO \| EQUAL_TO \| NOT_EQUAL_TO \| ADDITION \| MULTIPLICATION \| DIVISION \| SUBTRACTION \| MASK_ALL \| MASK_FIRST_N \| MASK_LAST_N \| VALIDATE_NON_NULL \| VALIDATE_NON_ZERO \| VALIDATE_NON_NEGATIVE \| VALIDATE_NUMERIC \| NO_OP Required: No Datadog The operation to be performed on the provided Datadog source ﬁelds. Type: String Valid Values: PROJECTION \| BETWEEN \| EQUAL_TO \| ADDITION \| MULTIPLICATION \| DIVISION \| SUBTRACTION \| MASK_ALL \| MASK_FIRST_N \| MASK_LAST_N \| VALIDATE_NON_NULL \| VALIDATE_NON_ZERO \| VALIDATE_NON_NEGATIVE \| VALIDATE_NUMERIC \| NO_OP Required: No ConnectorOperator API Version 2020-08-23 276 AmazonAppFlow Dynatrace API Reference The operation to be performed on the provided Dynatrace source ﬁelds. Type: String Valid Values: PROJECTION \| BETWEEN \| EQUAL_TO \| ADDITION \| MULTIPLICATION \| DIVISION \| SUBTRACTION \| MASK_ALL \| MASK_FIRST_N \| MASK_LAST_N \| VALIDATE_NON_NULL \| VALIDATE_NON_ZERO
amazon-appflow-api-045	amazon-appflow-api.pdf	45	\| VALIDATE_NUMERIC \| NO_OP Required: No Datadog The operation to be performed on the provided Datadog source ﬁelds. Type: String Valid Values: PROJECTION \| BETWEEN \| EQUAL_TO \| ADDITION \| MULTIPLICATION \| DIVISION \| SUBTRACTION \| MASK_ALL \| MASK_FIRST_N \| MASK_LAST_N \| VALIDATE_NON_NULL \| VALIDATE_NON_ZERO \| VALIDATE_NON_NEGATIVE \| VALIDATE_NUMERIC \| NO_OP Required: No ConnectorOperator API Version 2020-08-23 276 AmazonAppFlow Dynatrace API Reference The operation to be performed on the provided Dynatrace source ﬁelds. Type: String Valid Values: PROJECTION \| BETWEEN \| EQUAL_TO \| ADDITION \| MULTIPLICATION \| DIVISION \| SUBTRACTION \| MASK_ALL \| MASK_FIRST_N \| MASK_LAST_N \| VALIDATE_NON_NULL \| VALIDATE_NON_ZERO \| VALIDATE_NON_NEGATIVE \| VALIDATE_NUMERIC \| NO_OP Required: No GoogleAnalytics The operation to be performed on the provided Google Analytics source ﬁelds. Type: String Valid Values: PROJECTION \| BETWEEN Required: No InforNexus The operation to be performed on the provided Infor Nexus source ﬁelds. Type: String Valid Values: PROJECTION \| BETWEEN \| EQUAL_TO \| ADDITION \| MULTIPLICATION \| DIVISION \| SUBTRACTION \| MASK_ALL \| MASK_FIRST_N \| MASK_LAST_N \| VALIDATE_NON_NULL \| VALIDATE_NON_ZERO \| VALIDATE_NON_NEGATIVE \| VALIDATE_NUMERIC \| NO_OP Required: No Marketo The operation to be performed on the provided Marketo source ﬁelds. Type: String Valid Values: PROJECTION \| LESS_THAN \| GREATER_THAN \| BETWEEN \| ADDITION \| MULTIPLICATION \| DIVISION \| SUBTRACTION \| MASK_ALL \| Contents API Version 2020-08-23 277 AmazonAppFlow API Reference MASK_FIRST_N \| MASK_LAST_N \| VALIDATE_NON_NULL \| VALIDATE_NON_ZERO \| VALIDATE_NON_NEGATIVE \| VALIDATE_NUMERIC \| NO_OP Required: No Pardot The operation to be performed on the provided Salesforce Pardot source ﬁelds. Type: String Valid Values: PROJECTION \| EQUAL_TO \| NO_OP \| ADDITION \| MULTIPLICATION \| DIVISION \| SUBTRACTION \| MASK_ALL \| MASK_FIRST_N \| MASK_LAST_N \| VALIDATE_NON_NULL \| VALIDATE_NON_ZERO \| VALIDATE_NON_NEGATIVE \| VALIDATE_NUMERIC Required: No S3 The operation to be performed on the provided Amazon S3 source ﬁelds. Type: String Valid Values: PROJECTION \| LESS_THAN \| GREATER_THAN \| BETWEEN \| LESS_THAN_OR_EQUAL_TO \| GREATER_THAN_OR_EQUAL_TO \| EQUAL_TO \| NOT_EQUAL_TO \| ADDITION \| MULTIPLICATION \| DIVISION \| SUBTRACTION \| MASK_ALL \| MASK_FIRST_N \| MASK_LAST_N \| VALIDATE_NON_NULL \| VALIDATE_NON_ZERO \| VALIDATE_NON_NEGATIVE \| VALIDATE_NUMERIC \| NO_OP Required: No Salesforce The operation to be performed on the provided Salesforce source ﬁelds. Type: String Valid Values: PROJECTION \| LESS_THAN \| CONTAINS \| GREATER_THAN \| BETWEEN \| LESS_THAN_OR_EQUAL_TO \| GREATER_THAN_OR_EQUAL_TO \| EQUAL_TO \| NOT_EQUAL_TO \| ADDITION \| MULTIPLICATION \| DIVISION \| SUBTRACTION \| MASK_ALL \| MASK_FIRST_N \| MASK_LAST_N \| VALIDATE_NON_NULL \| VALIDATE_NON_ZERO \| VALIDATE_NON_NEGATIVE \| VALIDATE_NUMERIC \| NO_OP Contents API Version 2020-08-23 278 AmazonAppFlow Required: No SAPOData API Reference The operation to be performed on the provided SAPOData source ﬁelds. Type: String Valid Values: PROJECTION \| LESS_THAN \| CONTAINS \| GREATER_THAN \| BETWEEN \| LESS_THAN_OR_EQUAL_TO \| GREATER_THAN_OR_EQUAL_TO \| EQUAL_TO \| NOT_EQUAL_TO \| ADDITION \| MULTIPLICATION \| DIVISION \| SUBTRACTION \| MASK_ALL \| MASK_FIRST_N \| MASK_LAST_N \| VALIDATE_NON_NULL \| VALIDATE_NON_ZERO \| VALIDATE_NON_NEGATIVE \| VALIDATE_NUMERIC \| NO_OP Required: No ServiceNow The operation to be performed on the provided ServiceNow source ﬁelds. Type: String Valid Values: PROJECTION \| CONTAINS \| LESS_THAN \| GREATER_THAN \| BETWEEN \| LESS_THAN_OR_EQUAL_TO \| GREATER_THAN_OR_EQUAL_TO \| EQUAL_TO \| NOT_EQUAL_TO \| ADDITION \| MULTIPLICATION \| DIVISION \| SUBTRACTION \| MASK_ALL \| MASK_FIRST_N \| MASK_LAST_N \| VALIDATE_NON_NULL \| VALIDATE_NON_ZERO \| VALIDATE_NON_NEGATIVE \| VALIDATE_NUMERIC \| NO_OP Required: No Singular The operation to be performed on the provided Singular source ﬁelds. Type: String Valid Values: PROJECTION \| EQUAL_TO \| ADDITION \| MULTIPLICATION \| DIVISION \| SUBTRACTION \| MASK_ALL \| MASK_FIRST_N \| MASK_LAST_N \| VALIDATE_NON_NULL \| VALIDATE_NON_ZERO \| VALIDATE_NON_NEGATIVE \| VALIDATE_NUMERIC \| NO_OP Required: No Slack The operation to be performed on the provided Slack source ﬁelds. Contents API Version 2020-08-23 279 AmazonAppFlow Type: String API Reference Valid Values: PROJECTION \| LESS_THAN \| GREATER_THAN \| BETWEEN \| LESS_THAN_OR_EQUAL_TO \| GREATER_THAN_OR_EQUAL_TO \| EQUAL_TO \| ADDITION \| MULTIPLICATION \| DIVISION \| SUBTRACTION \| MASK_ALL \| MASK_FIRST_N \| MASK_LAST_N \| VALIDATE_NON_NULL \| VALIDATE_NON_ZERO \| VALIDATE_NON_NEGATIVE \| VALIDATE_NUMERIC \| NO_OP Required: No Trendmicro The operation to be performed on the provided Trend Micro source ﬁelds. Type: String Valid Values: PROJECTION \| EQUAL_TO \| ADDITION \| MULTIPLICATION \| DIVISION \| SUBTRACTION \| MASK_ALL \| MASK_FIRST_N \| MASK_LAST_N \| VALIDATE_NON_NULL \| VALIDATE_NON_ZERO \| VALIDATE_NON_NEGATIVE \| VALIDATE_NUMERIC \| NO_OP Required: No Veeva The operation to be performed on the provided Veeva source ﬁelds. Type: String Valid Values: PROJECTION \| LESS_THAN \| GREATER_THAN \| CONTAINS \| BETWEEN \| LESS_THAN_OR_EQUAL_TO \| GREATER_THAN_OR_EQUAL_TO \| EQUAL_TO \| NOT_EQUAL_TO \| ADDITION \| MULTIPLICATION \| DIVISION \| SUBTRACTION \| MASK_ALL \| MASK_FIRST_N \| MASK_LAST_N \| VALIDATE_NON_NULL \| VALIDATE_NON_ZERO \| VALIDATE_NON_NEGATIVE \| VALIDATE_NUMERIC \| NO_OP Required: No Zendesk The operation to be performed on the provided Zendesk source ﬁelds. Type: String Valid Values: PROJECTION \| GREATER_THAN \| ADDITION \| MULTIPLICATION \| DIVISION \| SUBTRACTION \| MASK_ALL \| MASK_FIRST_N \| MASK_LAST_N \| Contents API Version 2020-08-23 280 AmazonAppFlow API Reference VALIDATE_NON_NULL \| VALIDATE_NON_ZERO \| VALIDATE_NON_NEGATIVE \| VALIDATE_NUMERIC \| NO_OP Required: No See Also For more information about using this API in
amazon-appflow-api-046	amazon-appflow-api.pdf	46	CONTAINS \| BETWEEN \| LESS_THAN_OR_EQUAL_TO \| GREATER_THAN_OR_EQUAL_TO \| EQUAL_TO \| NOT_EQUAL_TO \| ADDITION \| MULTIPLICATION \| DIVISION \| SUBTRACTION \| MASK_ALL \| MASK_FIRST_N \| MASK_LAST_N \| VALIDATE_NON_NULL \| VALIDATE_NON_ZERO \| VALIDATE_NON_NEGATIVE \| VALIDATE_NUMERIC \| NO_OP Required: No Zendesk The operation to be performed on the provided Zendesk source ﬁelds. Type: String Valid Values: PROJECTION \| GREATER_THAN \| ADDITION \| MULTIPLICATION \| DIVISION \| SUBTRACTION \| MASK_ALL \| MASK_FIRST_N \| MASK_LAST_N \| Contents API Version 2020-08-23 280 AmazonAppFlow API Reference VALIDATE_NON_NULL \| VALIDATE_NON_ZERO \| VALIDATE_NON_NEGATIVE \| VALIDATE_NUMERIC \| NO_OP Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 281 AmazonAppFlow ConnectorProﬁle API Reference Describes an instance of a connector. This includes the provided name, credentials ARN, connection-mode, and so on. To keep the API intuitive and extensible, the ﬁelds that are common to all types of connector proﬁles are explicitly speciﬁed at the top level. The rest of the connector- speciﬁc properties are available via the connectorProfileProperties ﬁeld. Contents connectionMode Indicates the connection mode and if it is public or private. Type: String Valid Values: Public \| Private Required: No connectorLabel The label for the connector proﬁle being created. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ Required: No connectorProﬁleArn The Amazon Resource Name (ARN) of the connector proﬁle. Type: String Length Constraints: Maximum length of 512. Pattern: arn:aws:appflow:.:[0-9]+:. Required: No ConnectorProﬁle API Version 2020-08-23 282 AmazonAppFlow connectorProﬁleName API Reference The name of the connector proﬁle. The name is unique for each ConnectorProfile in the AWS account. Type: String Length Constraints: Maximum length of 256. Pattern: [\w/!@#+=.-]+ Required: No connectorProﬁleProperties The connector-speciﬁc properties of the proﬁle conﬁguration. Type: ConnectorProﬁleProperties object Required: No connectorType The type of connector, such as Salesforce, Amplitude, and so on. Type: String Valid Values: Salesforce \| Singular \| Slack \| Redshift \| S3 \| Marketo \| Googleanalytics \| Zendesk \| Servicenow \| Datadog \| Trendmicro \| Snowflake \| Dynatrace \| Infornexus \| Amplitude \| Veeva \| EventBridge \| LookoutMetrics \| Upsolver \| Honeycode \| CustomerProfiles \| SAPOData \| CustomConnector \| Pardot Required: No createdAt Speciﬁes when the connector proﬁle was created. Type: Timestamp Required: No credentialsArn The Amazon Resource Name (ARN) of the connector proﬁle credentials. Contents API Version 2020-08-23 283 API Reference AmazonAppFlow Type: String Length Constraints: Maximum length of 512. Pattern: arn:aws:.:.:[0-9]+:.* Required: No lastUpdatedAt Speciﬁes when the connector proﬁle was last updated. Type: Timestamp Required: No privateConnectionProvisioningState Speciﬁes the private connection provisioning state. Type: PrivateConnectionProvisioningState object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 284 AmazonAppFlow API Reference ConnectorProﬁleConﬁg Deﬁnes the connector-speciﬁc conﬁguration and credentials for the connector proﬁle. Contents connectorProﬁleProperties The connector-speciﬁc properties of the proﬁle conﬁguration. Type: ConnectorProﬁleProperties object Required: Yes connectorProﬁleCredentials The connector-speciﬁc credentials required by each connector. Type: ConnectorProﬁleCredentials object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ConnectorProﬁleConﬁg API Version 2020-08-23 285 AmazonAppFlow API Reference ConnectorProﬁleCredentials The connector-speciﬁc credentials required by a connector. Contents Amplitude The connector-speciﬁc credentials required when using Amplitude. Type: AmplitudeConnectorProﬁleCredentials object Required: No CustomConnector The connector-speciﬁc proﬁle credentials that are required when using the custom connector. Type: CustomConnectorProﬁleCredentials object Required: No Datadog The connector-speciﬁc credentials required when using Datadog. Type: DatadogConnectorProﬁleCredentials object Required: No Dynatrace The connector-speciﬁc credentials required when using Dynatrace. Type: DynatraceConnectorProﬁleCredentials object Required: No GoogleAnalytics The connector-speciﬁc credentials required when using Google Analytics. Type: GoogleAnalyticsConnectorProﬁleCredentials object Required: No ConnectorProﬁleCredentials API Version 2020-08-23 286 AmazonAppFlow Honeycode API Reference The connector-speciﬁc credentials required when using Amazon Honeycode. Type: HoneycodeConnectorProﬁleCredentials object Required: No InforNexus The connector-speciﬁc credentials required when using Infor Nexus. Type: InforNexusConnectorProﬁleCredentials object Required: No Marketo The connector-speciﬁc credentials required when using Marketo. Type: MarketoConnectorProﬁleCredentials object Required: No Pardot The connector-speciﬁc credentials required when using Salesforce Pardot. Type: PardotConnectorProﬁleCredentials object Required: No Redshift The connector-speciﬁc credentials required when using Amazon Redshift. Type: RedshiftConnectorProﬁleCredentials object Required: No Salesforce The connector-speciﬁc credentials required when using Salesforce. Type: SalesforceConnectorProﬁleCredentials object Required: No Contents API Version 2020-08-23 287 AmazonAppFlow SAPOData API Reference The connector-speciﬁc proﬁle credentials required when using SAPOData. Type: SAPODataConnectorProﬁleCredentials object Required: No ServiceNow The connector-speciﬁc credentials required when using ServiceNow. Type: ServiceNowConnectorProﬁleCredentials object Required: No Singular The connector-speciﬁc credentials required when using Singular. Type: SingularConnectorProﬁleCredentials object Required: No Slack The connector-speciﬁc credentials required when using Slack. Type: SlackConnectorProﬁleCredentials object Required: No Snowﬂake The
amazon-appflow-api-047	amazon-appflow-api.pdf	47	required when using Salesforce Pardot. Type: PardotConnectorProﬁleCredentials object Required: No Redshift The connector-speciﬁc credentials required when using Amazon Redshift. Type: RedshiftConnectorProﬁleCredentials object Required: No Salesforce The connector-speciﬁc credentials required when using Salesforce. Type: SalesforceConnectorProﬁleCredentials object Required: No Contents API Version 2020-08-23 287 AmazonAppFlow SAPOData API Reference The connector-speciﬁc proﬁle credentials required when using SAPOData. Type: SAPODataConnectorProﬁleCredentials object Required: No ServiceNow The connector-speciﬁc credentials required when using ServiceNow. Type: ServiceNowConnectorProﬁleCredentials object Required: No Singular The connector-speciﬁc credentials required when using Singular. Type: SingularConnectorProﬁleCredentials object Required: No Slack The connector-speciﬁc credentials required when using Slack. Type: SlackConnectorProﬁleCredentials object Required: No Snowﬂake The connector-speciﬁc credentials required when using Snowﬂake. Type: SnowﬂakeConnectorProﬁleCredentials object Required: No Trendmicro The connector-speciﬁc credentials required when using Trend Micro. Type: TrendmicroConnectorProﬁleCredentials object Required: No Contents API Version 2020-08-23 288 AmazonAppFlow Veeva API Reference The connector-speciﬁc credentials required when using Veeva. Type: VeevaConnectorProﬁleCredentials object Required: No Zendesk The connector-speciﬁc credentials required when using Zendesk. Type: ZendeskConnectorProﬁleCredentials object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 289 AmazonAppFlow API Reference ConnectorProﬁleProperties The connector-speciﬁc proﬁle properties required by each connector. Contents Amplitude The connector-speciﬁc properties required by Amplitude. Type: AmplitudeConnectorProﬁleProperties object Required: No CustomConnector The properties required by the custom connector. Type: CustomConnectorProﬁleProperties object Required: No Datadog The connector-speciﬁc properties required by Datadog. Type: DatadogConnectorProﬁleProperties object Required: No Dynatrace The connector-speciﬁc properties required by Dynatrace. Type: DynatraceConnectorProﬁleProperties object Required: No GoogleAnalytics The connector-speciﬁc properties required Google Analytics. Type: GoogleAnalyticsConnectorProﬁleProperties object Required: No ConnectorProﬁleProperties API Version 2020-08-23 290 AmazonAppFlow Honeycode API Reference The connector-speciﬁc properties required by Amazon Honeycode. Type: HoneycodeConnectorProﬁleProperties object Required: No InforNexus The connector-speciﬁc properties required by Infor Nexus. Type: InforNexusConnectorProﬁleProperties object Required: No Marketo The connector-speciﬁc properties required by Marketo. Type: MarketoConnectorProﬁleProperties object Required: No Pardot The connector-speciﬁc properties required by Salesforce Pardot. Type: PardotConnectorProﬁleProperties object Required: No Redshift The connector-speciﬁc properties required by Amazon Redshift. Type: RedshiftConnectorProﬁleProperties object Required: No Salesforce The connector-speciﬁc properties required by Salesforce. Type: SalesforceConnectorProﬁleProperties object Required: No Contents API Version 2020-08-23 291 AmazonAppFlow SAPOData API Reference The connector-speciﬁc proﬁle properties required when using SAPOData. Type: SAPODataConnectorProﬁleProperties object Required: No ServiceNow The connector-speciﬁc properties required by serviceNow. Type: ServiceNowConnectorProﬁleProperties object Required: No Singular The connector-speciﬁc properties required by Singular. Type: SingularConnectorProﬁleProperties object Required: No Slack The connector-speciﬁc properties required by Slack. Type: SlackConnectorProﬁleProperties object Required: No Snowﬂake The connector-speciﬁc properties required by Snowﬂake. Type: SnowﬂakeConnectorProﬁleProperties object Required: No Trendmicro The connector-speciﬁc properties required by Trend Micro. Type: TrendmicroConnectorProﬁleProperties object Required: No Contents API Version 2020-08-23 292 API Reference AmazonAppFlow Veeva The connector-speciﬁc properties required by Veeva. Type: VeevaConnectorProﬁleProperties object Required: No Zendesk The connector-speciﬁc properties required by Zendesk. Type: ZendeskConnectorProﬁleProperties object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 293 AmazonAppFlow API Reference ConnectorProvisioningConﬁg Contains information about the conﬁguration of the connector being registered. Contents lambda Contains information about the conﬁguration of the lambda which is being registered as the connector. Type: LambdaConnectorProvisioningConﬁg object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ConnectorProvisioningConﬁg API Version 2020-08-23 294 AmazonAppFlow API Reference ConnectorRuntimeSetting Contains information about the connector runtime settings that are required for ﬂow execution. Contents connectorSuppliedValueOptions Contains default values for the connector runtime setting that are supplied by the connector. Type: Array of strings Length Constraints: Maximum length of 256. Pattern: \S+ Required: No dataType Data type of the connector runtime setting. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: No description A description about the connector runtime setting. Type: String Length Constraints: Maximum length of 1024. Pattern: [\s\w/!@#+=.-]* Required: No isRequired Indicates whether this connector runtime setting is required. ConnectorRuntimeSetting API Version 2020-08-23 295 API Reference AmazonAppFlow Type: Boolean Required: No key Contains value information about the connector runtime setting. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: No label A label used for connector runtime setting. Type: String Length Constraints: Maximum length of 128. Pattern: .* Required: No scope Indicates the scope of the connector runtime setting. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2020-08-23 296 AmazonAppFlow • AWS SDK for C++ • AWS SDK for Java V2
amazon-appflow-api-048	amazon-appflow-api.pdf	48	No key Contains value information about the connector runtime setting. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: No label A label used for connector runtime setting. Type: String Length Constraints: Maximum length of 128. Pattern: .* Required: No scope Indicates the scope of the connector runtime setting. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2020-08-23 296 AmazonAppFlow • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 297 AmazonAppFlow CustomAuthConﬁg Conﬁguration information required for custom authentication. API Reference Contents authParameters Information about authentication parameters required for authentication. Type: Array of AuthParameter objects Required: No customAuthenticationType The authentication type that the custom connector uses. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CustomAuthConﬁg API Version 2020-08-23 298 AmazonAppFlow API Reference CustomAuthCredentials The custom credentials required for custom authentication. Contents customAuthenticationType The custom authentication type that the connector uses. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: Yes credentialsMap A map that holds custom authentication credentials. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: [\w]+ Value Length Constraints: Maximum length of 2048. Value Pattern: \S+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ CustomAuthCredentials API Version 2020-08-23 299 AmazonAppFlow • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 300 AmazonAppFlow API Reference CustomConnectorDestinationProperties The properties that are applied when the custom connector is being used as a destination. Contents entityName The entity speciﬁed in the custom connector as a destination in the ﬂow. Type: String Length Constraints: Maximum length of 1024. Pattern: \S+ Required: Yes customProperties The custom properties that are speciﬁc to the connector when it's used as a destination in the ﬂow. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: [\w]+ Value Length Constraints: Maximum length of 2048. Value Pattern: \S+ Required: No errorHandlingConﬁg The settings that determine how Amazon AppFlow handles an error when placing data in the custom connector as destination. Type: ErrorHandlingConﬁg object CustomConnectorDestinationProperties API Version 2020-08-23 301 AmazonAppFlow Required: No idFieldNames API Reference The name of the ﬁeld that Amazon AppFlow uses as an ID when performing a write operation such as update, delete, or upsert. Type: Array of strings Array Members: Minimum number of 0 items. Length Constraints: Maximum length of 128. Pattern: \S+ Required: No writeOperationType Speciﬁes the type of write operation to be performed in the custom connector when it's used as destination. Type: String Valid Values: INSERT \| UPSERT \| UPDATE \| DELETE Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 302 AmazonAppFlow API Reference CustomConnectorProﬁleCredentials The connector-speciﬁc proﬁle credentials that are required when using the custom connector. Contents authenticationType The authentication type that the custom connector uses for authenticating while creating a connector proﬁle. Type: String Valid Values: OAUTH2 \| APIKEY \| BASIC \| CUSTOM Required: Yes apiKey The API keys required for the authentication of the user. Type: ApiKeyCredentials object Required: No basic The basic credentials that are required for the authentication of the user. Type: BasicAuthCredentials object Required: No custom If the connector uses the custom authentication mechanism, this holds the required credentials. Type: CustomAuthCredentials object Required: No oauth2 The OAuth 2.0 credentials required for the authentication of the user. Type: OAuth2Credentials object CustomConnectorProﬁleCredentials API Version 2020-08-23 303 AmazonAppFlow Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 304 AmazonAppFlow API Reference CustomConnectorProﬁleProperties The proﬁle properties required by the custom connector. Contents oAuth2Properties The OAuth 2.0 properties required for OAuth 2.0 authentication. Type: OAuth2Properties object Required: No proﬁleProperties A map of properties that are required to create
amazon-appflow-api-049	amazon-appflow-api.pdf	49	required for the authentication of the user. Type: OAuth2Credentials object CustomConnectorProﬁleCredentials API Version 2020-08-23 303 AmazonAppFlow Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 304 AmazonAppFlow API Reference CustomConnectorProﬁleProperties The proﬁle properties required by the custom connector. Contents oAuth2Properties The OAuth 2.0 properties required for OAuth 2.0 authentication. Type: OAuth2Properties object Required: No proﬁleProperties A map of properties that are required to create a proﬁle for the custom connector. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: [\w]+ Value Length Constraints: Maximum length of 2048. Value Pattern: \S+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CustomConnectorProﬁleProperties API Version 2020-08-23 305 AmazonAppFlow API Reference CustomConnectorSourceProperties The properties that are applied when the custom connector is being used as a source. Contents entityName The entity speciﬁed in the custom connector as a source in the ﬂow. Type: String Length Constraints: Maximum length of 1024. Pattern: \S+ Required: Yes customProperties Custom properties that are required to use the custom connector as a source. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: [\w]+ Value Length Constraints: Maximum length of 2048. Value Pattern: \S+ Required: No dataTransferApi The API of the connector application that Amazon AppFlow uses to transfer your data. Type: DataTransferApi object Required: No CustomConnectorSourceProperties API Version 2020-08-23 306 AmazonAppFlow See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 307 AmazonAppFlow API Reference CustomerProﬁlesDestinationProperties The properties that are applied when Amazon Connect Customer Proﬁles is used as a destination. Contents domainName The unique name of the Amazon Connect Customer Proﬁles domain. Type: String Length Constraints: Maximum length of 64. Pattern: \S+ Required: Yes objectTypeName The object speciﬁed in the Amazon Connect Customer Proﬁles ﬂow destination. Type: String Length Constraints: Maximum length of 255. Pattern: \S+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CustomerProﬁlesDestinationProperties API Version 2020-08-23 308 AmazonAppFlow API Reference CustomerProﬁlesMetadata The connector metadata speciﬁc to Amazon Connect Customer Proﬁles. Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CustomerProﬁlesMetadata API Version 2020-08-23 309 AmazonAppFlow API Reference DatadogConnectorProﬁleCredentials The connector-speciﬁc credentials required by Datadog. Contents apiKey A unique alphanumeric identiﬁer used to authenticate a user, developer, or calling program to your API. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: Yes applicationKey Application keys, in conjunction with your API key, give you full access to Datadog’s programmatic API. Application keys are associated with the user account that created them. The application key is used to log all requests made to the API. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DatadogConnectorProﬁleCredentials API Version 2020-08-23 310 AmazonAppFlow API Reference See Also API Version 2020-08-23 311 AmazonAppFlow API Reference DatadogConnectorProﬁleProperties The connector-speciﬁc proﬁle properties required by Datadog. Contents instanceUrl The location of the Datadog resource. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DatadogConnectorProﬁleProperties API Version 2020-08-23 312 AmazonAppFlow DatadogMetadata The connector metadata speciﬁc to Datadog. Contents API Reference The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS
amazon-appflow-api-050	amazon-appflow-api.pdf	50	Maximum length of 256. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DatadogConnectorProﬁleProperties API Version 2020-08-23 312 AmazonAppFlow DatadogMetadata The connector metadata speciﬁc to Datadog. Contents API Reference The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DatadogMetadata API Version 2020-08-23 313 AmazonAppFlow API Reference DatadogSourceProperties The properties that are applied when Datadog is being used as a source. Contents object The object speciﬁed in the Datadog ﬂow source. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DatadogSourceProperties API Version 2020-08-23 314 AmazonAppFlow DataTransferApi API Reference The API of the connector application that Amazon AppFlow uses to transfer your data. Contents Name The name of the connector application API. Type: String Length Constraints: Maximum length of 64. Pattern: [\w/-]+ Required: No Type You can specify one of the following types: AUTOMATIC The default. Optimizes a ﬂow for datasets that ﬂuctuate in size from small to large. For each ﬂow run, Amazon AppFlow chooses to use the SYNC or ASYNC API type based on the amount of data that the run transfers. SYNC A synchronous API. This type of API optimizes a ﬂow for small to medium-sized datasets. ASYNC An asynchronous API. This type of API optimizes a ﬂow for large datasets. Type: String Valid Values: SYNC \| ASYNC \| AUTOMATIC Required: No DataTransferApi API Version 2020-08-23 315 AmazonAppFlow See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 316 AmazonAppFlow API Reference DestinationConnectorProperties This stores the information that is required to query a particular connector. Contents CustomConnector The properties that are required to query the custom Connector. Type: CustomConnectorDestinationProperties object Required: No CustomerProﬁles The properties required to query Amazon Connect Customer Proﬁles. Type: CustomerProﬁlesDestinationProperties object Required: No EventBridge The properties required to query Amazon EventBridge. Type: EventBridgeDestinationProperties object Required: No Honeycode The properties required to query Amazon Honeycode. Type: HoneycodeDestinationProperties object Required: No LookoutMetrics The properties required to query Amazon Lookout for Metrics. Type: LookoutMetricsDestinationProperties object Required: No DestinationConnectorProperties API Version 2020-08-23 317 AmazonAppFlow Marketo The properties required to query Marketo. Type: MarketoDestinationProperties object Required: No Redshift The properties required to query Amazon Redshift. Type: RedshiftDestinationProperties object Required: No S3 The properties required to query Amazon S3. Type: S3DestinationProperties object Required: No Salesforce The properties required to query Salesforce. Type: SalesforceDestinationProperties object Required: No SAPOData The properties required to query SAPOData. Type: SAPODataDestinationProperties object Required: No Snowﬂake The properties required to query Snowﬂake. Type: SnowﬂakeDestinationProperties object Required: No Contents API Reference API Version 2020-08-23 318 API Reference AmazonAppFlow Upsolver The properties required to query Upsolver. Type: UpsolverDestinationProperties object Required: No Zendesk The properties required to query Zendesk. Type: ZendeskDestinationProperties object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 319 AmazonAppFlow API Reference DestinationFieldProperties The properties that can be applied to a ﬁeld when connector is being used as a destination. Contents isCreatable Speciﬁes if the destination ﬁeld can be created by the current user. Type: Boolean Required: No isDefaultedOnCreate Speciﬁes whether the ﬁeld can use the default value during a Create operation. Type: Boolean Required: No isNullable Speciﬁes if the destination ﬁeld can have a null value. Type: Boolean Required: No isUpdatable Speciﬁes whether the ﬁeld can be updated during an UPDATE or UPSERT write operation. Type: Boolean Required: No isUpsertable Speciﬁes if the ﬂow run can either insert new rows in the destination ﬁeld if they do not already exist, or update them if they do. Type: Boolean Required: No DestinationFieldProperties API Version 2020-08-23 320 AmazonAppFlow supportedWriteOperations API Reference A list of supported write operations. For each write operation listed, this ﬁeld can be used in idFieldNames when that write operation is present as a destination option. Type: Array of strings Valid Values: INSERT \| UPSERT \| UPDATE \| DELETE Required: No See Also For more information about using this API in one of
amazon-appflow-api-051	amazon-appflow-api.pdf	51	operation. Type: Boolean Required: No isUpsertable Speciﬁes if the ﬂow run can either insert new rows in the destination ﬁeld if they do not already exist, or update them if they do. Type: Boolean Required: No DestinationFieldProperties API Version 2020-08-23 320 AmazonAppFlow supportedWriteOperations API Reference A list of supported write operations. For each write operation listed, this ﬁeld can be used in idFieldNames when that write operation is present as a destination option. Type: Array of strings Valid Values: INSERT \| UPSERT \| UPDATE \| DELETE Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 321 AmazonAppFlow API Reference DestinationFlowConﬁg Contains information about the conﬁguration of destination connectors present in the ﬂow. Contents connectorType The type of connector, such as Salesforce, Amplitude, and so on. Type: String Valid Values: Salesforce \| Singular \| Slack \| Redshift \| S3 \| Marketo \| Googleanalytics \| Zendesk \| Servicenow \| Datadog \| Trendmicro \| Snowflake \| Dynatrace \| Infornexus \| Amplitude \| Veeva \| EventBridge \| LookoutMetrics \| Upsolver \| Honeycode \| CustomerProfiles \| SAPOData \| CustomConnector \| Pardot Required: Yes destinationConnectorProperties This stores the information that is required to query a particular connector. Type: DestinationConnectorProperties object Required: Yes apiVersion The API version that the destination connector uses. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: No connectorProﬁleName The name of the connector proﬁle. This name must be unique for each connector proﬁle in the AWS account. DestinationFlowConﬁg API Version 2020-08-23 322 AmazonAppFlow Type: String Length Constraints: Maximum length of 256. Pattern: [\w/!@#+=.-]+ Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 323 AmazonAppFlow API Reference DynatraceConnectorProﬁleCredentials The connector-speciﬁc proﬁle credentials required by Dynatrace. Contents apiToken The API tokens used by Dynatrace API to authenticate various API calls. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DynatraceConnectorProﬁleCredentials API Version 2020-08-23 324 AmazonAppFlow API Reference DynatraceConnectorProﬁleProperties The connector-speciﬁc proﬁle properties required by Dynatrace. Contents instanceUrl The location of the Dynatrace resource. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DynatraceConnectorProﬁleProperties API Version 2020-08-23 325 AmazonAppFlow DynatraceMetadata The connector metadata speciﬁc to Dynatrace. Contents API Reference The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DynatraceMetadata API Version 2020-08-23 326 AmazonAppFlow API Reference DynatraceSourceProperties The properties that are applied when Dynatrace is being used as a source. Contents object The object speciﬁed in the Dynatrace ﬂow source. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DynatraceSourceProperties API Version 2020-08-23 327 AmazonAppFlow API Reference ErrorHandlingConﬁg The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the ﬂow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details. Contents bucketName Speciﬁes the name of the Amazon S3 bucket. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: \S+ Required: No bucketPreﬁx Speciﬁes the Amazon S3 bucket preﬁx. Type: String Length Constraints: Maximum length of 512. Pattern: .* Required: No failOnFirstDestinationError Speciﬁes if the ﬂow should fail after the ﬁrst instance of a failure when attempting to place data in the destination. Type: Boolean Required: No ErrorHandlingConﬁg API Version 2020-08-23 328 AmazonAppFlow See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23
amazon-appflow-api-052	amazon-appflow-api.pdf	52	of 63. Pattern: \S+ Required: No bucketPreﬁx Speciﬁes the Amazon S3 bucket preﬁx. Type: String Length Constraints: Maximum length of 512. Pattern: .* Required: No failOnFirstDestinationError Speciﬁes if the ﬂow should fail after the ﬁrst instance of a failure when attempting to place data in the destination. Type: Boolean Required: No ErrorHandlingConﬁg API Version 2020-08-23 328 AmazonAppFlow See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 329 AmazonAppFlow ErrorInfo API Reference Provides details in the event of a failed ﬂow, including the failure count and the related error messages. Contents executionMessage Speciﬁes the error message that appears if a ﬂow fails. Type: String Length Constraints: Maximum length of 2048. Pattern: [\s\w/!@#+=.-]* Required: No putFailuresCount Speciﬁes the failure count for the attempted ﬂow. Type: Long Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ErrorInfo API Version 2020-08-23 330 AmazonAppFlow API Reference EventBridgeDestinationProperties The properties that are applied when Amazon EventBridge is being used as a destination. Contents object The object speciﬁed in the Amazon EventBridge ﬂow destination. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes errorHandlingConﬁg The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the ﬂow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details. Type: ErrorHandlingConﬁg object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 EventBridgeDestinationProperties API Version 2020-08-23 331 AmazonAppFlow API Reference EventBridgeMetadata The connector metadata speciﬁc to Amazon EventBridge. Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 EventBridgeMetadata API Version 2020-08-23 332 AmazonAppFlow ExecutionDetails API Reference Describes the details of the ﬂow run, including the timestamp, status, and message. Contents mostRecentExecutionMessage Describes the details of the most recent ﬂow run. Type: String Length Constraints: Maximum length of 2048. Pattern: [\w!@#\-.?,\s]* Required: No mostRecentExecutionStatus Speciﬁes the status of the most recent ﬂow run. Type: String Valid Values: InProgress \| Successful \| Error \| CancelStarted \| Canceled Required: No mostRecentExecutionTime Speciﬁes the time of the most recent ﬂow run. Type: Timestamp Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 ExecutionDetails API Version 2020-08-23 333 AmazonAppFlow • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 334 AmazonAppFlow ExecutionRecord API Reference Speciﬁes information about the past ﬂow run instances for a given ﬂow. Contents dataPullEndTime The timestamp that indicates the last new or updated record to be transferred in the ﬂow run. Type: Timestamp Required: No dataPullStartTime The timestamp that determines the ﬁrst new or updated record to be transferred in the ﬂow run. Type: Timestamp Required: No executionId Speciﬁes the identiﬁer of the given ﬂow run. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: No executionResult Describes the result of the given ﬂow run. Type: ExecutionResult object Required: No executionStatus Speciﬁes the ﬂow run status and whether it is in progress, has completed successfully, or has failed. ExecutionRecord API Version 2020-08-23 335 AmazonAppFlow Type: String API Reference Valid Values: InProgress \| Successful \| Error \| CancelStarted \| Canceled Required: No lastUpdatedAt Speciﬁes the time of the most recent update. Type: Timestamp Required: No metadataCatalogDetails Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated ﬂow run. Type: Array of MetadataCatalogDetail objects Required: No startedAt Speciﬁes the start time of the ﬂow run. Type: Timestamp Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 336 API Reference AmazonAppFlow ExecutionResult Speciﬁes the end result of the ﬂow run. Contents bytesProcessed The total number of bytes processed by the ﬂow run. Type: Long Required: No bytesWritten The total number of bytes written as a
amazon-appflow-api-053	amazon-appflow-api.pdf	53	run. Type: Array of MetadataCatalogDetail objects Required: No startedAt Speciﬁes the start time of the ﬂow run. Type: Timestamp Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 336 API Reference AmazonAppFlow ExecutionResult Speciﬁes the end result of the ﬂow run. Contents bytesProcessed The total number of bytes processed by the ﬂow run. Type: Long Required: No bytesWritten The total number of bytes written as a result of the ﬂow run. Type: Long Required: No errorInfo Provides any error message information related to the ﬂow run. Type: ErrorInfo object Required: No maxPageSize The maximum number of records that Amazon AppFlow receives in each page of the response from your SAP application. Type: Long Required: No numParallelProcesses The number of processes that Amazon AppFlow ran at the same time when it retrieved your data. Type: Long ExecutionResult API Version 2020-08-23 337 AmazonAppFlow Required: No recordsProcessed The number of records processed in the ﬂow run. API Reference Type: Long Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 338 AmazonAppFlow FieldTypeDetails API Reference Contains details regarding the supported ﬁeld type and the operators that can be applied for ﬁltering. Contents ﬁeldType The type of ﬁeld, such as string, integer, date, and so on. Type: String Required: Yes ﬁlterOperators The list of operators supported by a ﬁeld. Type: Array of strings Valid Values: PROJECTION \| LESS_THAN \| GREATER_THAN \| CONTAINS \| BETWEEN \| LESS_THAN_OR_EQUAL_TO \| GREATER_THAN_OR_EQUAL_TO \| EQUAL_TO \| NOT_EQUAL_TO \| ADDITION \| MULTIPLICATION \| DIVISION \| SUBTRACTION \| MASK_ALL \| MASK_FIRST_N \| MASK_LAST_N \| VALIDATE_NON_NULL \| VALIDATE_NON_ZERO \| VALIDATE_NON_NEGATIVE \| VALIDATE_NUMERIC \| NO_OP Required: Yes ﬁeldLengthRange This is the allowable length range for this ﬁeld's value. Type: Range object Required: No ﬁeldValueRange The range of values this ﬁeld can hold. Type: Range object Required: No FieldTypeDetails API Version 2020-08-23 339 API Reference AmazonAppFlow supportedDateFormat The date format that the ﬁeld supports. Type: String Length Constraints: Maximum length of 2048. Pattern: .* Required: No supportedValues The list of values that a ﬁeld can contain. For example, a Boolean fieldType can have two values: "true" and "false". Type: Array of strings Length Constraints: Maximum length of 128. Pattern: \S+ Required: No valueRegexPattern The regular expression pattern for the ﬁeld name. Type: String Length Constraints: Maximum length of 2048. Pattern: .* Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ See Also API Version 2020-08-23 340 AmazonAppFlow • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 341 AmazonAppFlow FlowDeﬁnition API Reference The properties of the ﬂow, such as its source, destination, trigger type, and so on. Contents createdAt Speciﬁes when the ﬂow was created. Type: Timestamp Required: No createdBy The ARN of the user who created the ﬂow. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: No description A user-entered description of the ﬂow. Type: String Length Constraints: Maximum length of 2048. Pattern: [\w!@#\-.?,\s]* Required: No destinationConnectorLabel The label of the destination connector in the ﬂow. Type: String Length Constraints: Maximum length of 256. FlowDeﬁnition API Version 2020-08-23 342 AmazonAppFlow API Reference Pattern: [a-zA-Z0-9][\w!@#.-]+ Required: No destinationConnectorType Speciﬁes the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on. Type: String Valid Values: Salesforce \| Singular \| Slack \| Redshift \| S3 \| Marketo \| Googleanalytics \| Zendesk \| Servicenow \| Datadog \| Trendmicro \| Snowflake \| Dynatrace \| Infornexus \| Amplitude \| Veeva \| EventBridge \| LookoutMetrics \| Upsolver \| Honeycode \| CustomerProfiles \| SAPOData \| CustomConnector \| Pardot Required: No ﬂowArn The ﬂow's Amazon Resource Name (ARN). Type: String Length Constraints: Maximum length of 512. Pattern: arn:aws:appflow:.:[0-9]+:. Required: No ﬂowName The speciﬁed name of the ﬂow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ Required: No ﬂowStatus Indicates the current status of the ﬂow. Type: String Contents API Version 2020-08-23 343 AmazonAppFlow API Reference Valid Values: Active \| Deprecated \| Deleted \| Draft \| Errored \| Suspended Required: No lastRunExecutionDetails Describes the details of the most recent ﬂow run. Type: ExecutionDetails object Required: No lastUpdatedAt Speciﬁes when the ﬂow was last updated. Type: Timestamp Required: No lastUpdatedBy Speciﬁes the account user name that most recently updated the ﬂow. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: No
amazon-appflow-api-054	amazon-appflow-api.pdf	54	or hyphens (-) only. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ Required: No ﬂowStatus Indicates the current status of the ﬂow. Type: String Contents API Version 2020-08-23 343 AmazonAppFlow API Reference Valid Values: Active \| Deprecated \| Deleted \| Draft \| Errored \| Suspended Required: No lastRunExecutionDetails Describes the details of the most recent ﬂow run. Type: ExecutionDetails object Required: No lastUpdatedAt Speciﬁes when the ﬂow was last updated. Type: Timestamp Required: No lastUpdatedBy Speciﬁes the account user name that most recently updated the ﬂow. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: No sourceConnectorLabel The label of the source connector in the ﬂow. Type: String Length Constraints: Maximum length of 256. Pattern: [a-zA-Z0-9][\w!@#.-]+ Required: No sourceConnectorType Speciﬁes the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on. Contents API Version 2020-08-23 344 AmazonAppFlow Type: String API Reference Valid Values: Salesforce \| Singular \| Slack \| Redshift \| S3 \| Marketo \| Googleanalytics \| Zendesk \| Servicenow \| Datadog \| Trendmicro \| Snowflake \| Dynatrace \| Infornexus \| Amplitude \| Veeva \| EventBridge \| LookoutMetrics \| Upsolver \| Honeycode \| CustomerProfiles \| SAPOData \| CustomConnector \| Pardot Required: No tags The tags used to organize, track, or control access for your ﬂow. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Maximum length of 256. Value Pattern: [\s\w+-=\.:/@]* Required: No triggerType Speciﬁes the type of ﬂow trigger. This can be OnDemand, Scheduled, or Event. Type: String Valid Values: Scheduled \| Event \| OnDemand Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2020-08-23 345 AmazonAppFlow • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 346 AmazonAppFlow API Reference GlueDataCatalogConﬁg Speciﬁes the conﬁguration that Amazon AppFlow uses when it catalogs your data with the AWS Glue Data Catalog. When Amazon AppFlow catalogs your data, it stores metadata in Data Catalog tables. This metadata represents the data that's transferred by the ﬂow that you conﬁgure with these settings. Note You can conﬁgure a ﬂow with these settings only when the ﬂow destination is Amazon S3. Contents databaseName The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your AWS account. These tables contain metadata for the data that's transferred by the ﬂow that you conﬁgure with this parameter. Note When you conﬁgure a new ﬂow with this parameter, you must specify an existing database. Type: String Length Constraints: Maximum length of 255. Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]* Required: Yes roleArn The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions it needs to create Data Catalog tables, databases, and partitions. For an example IAM policy that has the required permissions, see Identity-based policy examples for Amazon AppFlow. GlueDataCatalogConﬁg API Version 2020-08-23 347 AmazonAppFlow Type: String Length Constraints: Maximum length of 512. Pattern: arn:aws:iam:.:[0-9]+:. Required: Yes tablePreﬁx API Reference A naming preﬁx for each Data Catalog table that Amazon AppFlow creates for the ﬂow that you conﬁgure with this setting. Amazon AppFlow adds the preﬁx to the beginning of the each table name. Type: String Length Constraints: Maximum length of 128. Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]* Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 348 AmazonAppFlow API Reference GoogleAnalyticsConnectorProﬁleCredentials The connector-speciﬁc proﬁle credentials required by Google Analytics. Contents clientId The identiﬁer for the desired client. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes clientSecret The client secret used by the OAuth client to authenticate to the authorization server. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes accessToken The credentials used to access protected Google Analytics resources. Type: String Length Constraints: Maximum length of 4096. Pattern: \S+ Required: No oAuthRequest The OAuth requirement needed to request security tokens from the connector endpoint. GoogleAnalyticsConnectorProﬁleCredentials API Version 2020-08-23 349 AmazonAppFlow API Reference Type: ConnectorOAuthRequest object Required: No refreshToken The credentials used to acquire new access tokens. This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens. Type: String Length Constraints: Maximum length of 4096. Pattern: \S+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also
amazon-appflow-api-055	amazon-appflow-api.pdf	55	The OAuth requirement needed to request security tokens from the connector endpoint. GoogleAnalyticsConnectorProﬁleCredentials API Version 2020-08-23 349 AmazonAppFlow API Reference Type: ConnectorOAuthRequest object Required: No refreshToken The credentials used to acquire new access tokens. This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens. Type: String Length Constraints: Maximum length of 4096. Pattern: \S+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 350 AmazonAppFlow API Reference GoogleAnalyticsConnectorProﬁleProperties The connector-speciﬁc proﬁle properties required by Google Analytics. Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GoogleAnalyticsConnectorProﬁleProperties API Version 2020-08-23 351 AmazonAppFlow API Reference GoogleAnalyticsMetadata The connector metadata speciﬁc to Google Analytics. Contents oAuthScopes The desired authorization scope for the Google Analytics account. Type: Array of strings Length Constraints: Maximum length of 128. Pattern: \S+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GoogleAnalyticsMetadata API Version 2020-08-23 352 AmazonAppFlow API Reference GoogleAnalyticsSourceProperties The properties that are applied when Google Analytics is being used as a source. Contents object The object speciﬁed in the Google Analytics ﬂow source. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GoogleAnalyticsSourceProperties API Version 2020-08-23 353 AmazonAppFlow API Reference HoneycodeConnectorProﬁleCredentials The connector-speciﬁc credentials required when using Amazon Honeycode. Contents accessToken The credentials used to access protected Amazon Honeycode resources. Type: String Length Constraints: Maximum length of 4096. Pattern: \S+ Required: No oAuthRequest Used by select connectors for which the OAuth workﬂow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack. Type: ConnectorOAuthRequest object Required: No refreshToken The credentials used to acquire new access tokens. Type: String Length Constraints: Maximum length of 4096. Pattern: \S+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: HoneycodeConnectorProﬁleCredentials API Version 2020-08-23 354 AmazonAppFlow • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 355 AmazonAppFlow API Reference HoneycodeConnectorProﬁleProperties The connector-speciﬁc properties required when using Amazon Honeycode. Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 HoneycodeConnectorProﬁleProperties API Version 2020-08-23 356 AmazonAppFlow API Reference HoneycodeDestinationProperties The properties that are applied when Amazon Honeycode is used as a destination. Contents object The object speciﬁed in the Amazon Honeycode ﬂow destination. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes errorHandlingConﬁg The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the ﬂow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details. Type: ErrorHandlingConﬁg object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 HoneycodeDestinationProperties API Version 2020-08-23 357 AmazonAppFlow API Reference HoneycodeMetadata The connector metadata speciﬁc to Amazon Honeycode. Contents oAuthScopes The desired authorization scope for the Amazon Honeycode account. Type: Array of strings Length Constraints: Maximum length of 128. Pattern: \S+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 HoneycodeMetadata API Version 2020-08-23 358 AmazonAppFlow API Reference IncrementalPullConﬁg Speciﬁes the conﬁguration used when importing incremental records from the source. Contents datetimeTypeFieldName A ﬁeld that speciﬁes the date time or timestamp ﬁeld as the criteria to use when importing incremental records from the source. Type: String Length Constraints: Maximum length of 256. Pattern: .* Required: No See Also For more information about using this API in one of the
amazon-appflow-api-056	amazon-appflow-api.pdf	56	about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 HoneycodeMetadata API Version 2020-08-23 358 AmazonAppFlow API Reference IncrementalPullConﬁg Speciﬁes the conﬁguration used when importing incremental records from the source. Contents datetimeTypeFieldName A ﬁeld that speciﬁes the date time or timestamp ﬁeld as the criteria to use when importing incremental records from the source. Type: String Length Constraints: Maximum length of 256. Pattern: .* Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 IncrementalPullConﬁg API Version 2020-08-23 359 AmazonAppFlow API Reference InforNexusConnectorProﬁleCredentials The connector-speciﬁc proﬁle credentials required by Infor Nexus. Contents accessKeyId The Access Key portion of the credentials. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: Yes datakey The encryption keys used to encrypt data. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes secretAccessKey The secret key used to sign requests. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes userId The identiﬁer for the user. InforNexusConnectorProﬁleCredentials API Version 2020-08-23 360 AmazonAppFlow Type: String Length Constraints: Maximum length of 512. API Reference Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 361 AmazonAppFlow API Reference InforNexusConnectorProﬁleProperties The connector-speciﬁc proﬁle properties required by Infor Nexus. Contents instanceUrl The location of the Infor Nexus resource. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 InforNexusConnectorProﬁleProperties API Version 2020-08-23 362 AmazonAppFlow API Reference InforNexusMetadata The connector metadata speciﬁc to Infor Nexus. Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 InforNexusMetadata API Version 2020-08-23 363 AmazonAppFlow API Reference InforNexusSourceProperties The properties that are applied when Infor Nexus is being used as a source. Contents object The object speciﬁed in the Infor Nexus ﬂow source. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 InforNexusSourceProperties API Version 2020-08-23 364 AmazonAppFlow API Reference LambdaConnectorProvisioningConﬁg Contains information about the conﬁguration of the lambda which is being registered as the connector. Contents lambdaArn Lambda ARN of the connector being registered. Type: String Length Constraints: Maximum length of 512. Pattern: arn:aws:.:.:[0-9]+:.* Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LambdaConnectorProvisioningConﬁg API Version 2020-08-23 365 AmazonAppFlow API Reference LookoutMetricsDestinationProperties The properties that are applied when Amazon Lookout for Metrics is used as a destination. Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LookoutMetricsDestinationProperties API Version 2020-08-23 366 AmazonAppFlow API Reference MarketoConnectorProﬁleCredentials The connector-speciﬁc proﬁle credentials required by Marketo. Contents clientId The identiﬁer for the desired client. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes clientSecret The client secret used by the OAuth client to authenticate to the authorization server. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes accessToken The credentials used to access protected Marketo resources. Type: String Length Constraints: Maximum length of 4096. Pattern: \S+ Required: No oAuthRequest The OAuth requirement needed to request security tokens from the connector endpoint. MarketoConnectorProﬁleCredentials API Version 2020-08-23 367 AmazonAppFlow API Reference Type: ConnectorOAuthRequest object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 368 AmazonAppFlow API Reference MarketoConnectorProﬁleProperties The connector-speciﬁc proﬁle properties required when using Marketo. Contents instanceUrl The location of
amazon-appflow-api-057	amazon-appflow-api.pdf	57	protected Marketo resources. Type: String Length Constraints: Maximum length of 4096. Pattern: \S+ Required: No oAuthRequest The OAuth requirement needed to request security tokens from the connector endpoint. MarketoConnectorProﬁleCredentials API Version 2020-08-23 367 AmazonAppFlow API Reference Type: ConnectorOAuthRequest object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 368 AmazonAppFlow API Reference MarketoConnectorProﬁleProperties The connector-speciﬁc proﬁle properties required when using Marketo. Contents instanceUrl The location of the Marketo resource. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MarketoConnectorProﬁleProperties API Version 2020-08-23 369 AmazonAppFlow API Reference MarketoDestinationProperties The properties that Amazon AppFlow applies when you use Marketo as a ﬂow destination. Contents object The object speciﬁed in the Marketo ﬂow destination. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes errorHandlingConﬁg The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the ﬂow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details. Type: ErrorHandlingConﬁg object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MarketoDestinationProperties API Version 2020-08-23 370 AmazonAppFlow MarketoMetadata The connector metadata speciﬁc to Marketo. Contents API Reference The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MarketoMetadata API Version 2020-08-23 371 AmazonAppFlow API Reference MarketoSourceProperties The properties that are applied when Marketo is being used as a source. Contents object The object speciﬁed in the Marketo ﬂow source. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MarketoSourceProperties API Version 2020-08-23 372 AmazonAppFlow API Reference MetadataCatalogConﬁg Speciﬁes the conﬁguration that Amazon AppFlow uses when it catalogs your data. When Amazon AppFlow catalogs your data, it stores metadata in a data catalog. Contents glueDataCatalog Speciﬁes the conﬁguration that Amazon AppFlow uses when it catalogs your data with the AWS Glue Data Catalog. Type: GlueDataCatalogConﬁg object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MetadataCatalogConﬁg API Version 2020-08-23 373 AmazonAppFlow API Reference MetadataCatalogDetail Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated ﬂow run. Contents catalogType The type of metadata catalog that Amazon AppFlow used for the associated ﬂow run. This parameter returns the following value: GLUE The metadata catalog is provided by the AWS Glue Data Catalog. AWS Glue includes the AWS Glue Data Catalog as a component. Type: String Valid Values: GLUE Required: No partitionRegistrationOutput Describes the status of the attempt from Amazon AppFlow to register the data partitions with the metadata catalog. The data partitions organize the ﬂow output into a hierarchical path, such as a folder path in an S3 bucket. Amazon AppFlow creates the partitions (if they don't already exist) based on your ﬂow conﬁguration. Type: RegistrationOutput object Required: No tableName The name of the table that stores the metadata for the associated ﬂow run. The table stores metadata that represents the data that the ﬂow transferred. Amazon AppFlow stores the table in the metadata catalog. Type: String Length Constraints: Maximum length of 2048. MetadataCatalogDetail API Version 2020-08-23 374 AmazonAppFlow Pattern: .* Required: No tableRegistrationOutput API Reference Describes the status of the attempt from Amazon AppFlow to register the metadata table with the metadata catalog. Amazon AppFlow creates or updates this table for the associated ﬂow run. Type: RegistrationOutput object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 375 AmazonAppFlow OAuth2Credentials
amazon-appflow-api-058	amazon-appflow-api.pdf	58	Type: String Length Constraints: Maximum length of 2048. MetadataCatalogDetail API Version 2020-08-23 374 AmazonAppFlow Pattern: .* Required: No tableRegistrationOutput API Reference Describes the status of the attempt from Amazon AppFlow to register the metadata table with the metadata catalog. Amazon AppFlow creates or updates this table for the associated ﬂow run. Type: RegistrationOutput object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 375 AmazonAppFlow OAuth2Credentials The OAuth 2.0 credentials required for OAuth 2.0 authentication. API Reference Contents accessToken The access token used to access the connector on your behalf. Type: String Length Constraints: Maximum length of 4096. Pattern: \S+ Required: No clientId The identiﬁer for the desired client. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: No clientSecret The client secret used by the OAuth client to authenticate to the authorization server. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: No oAuthRequest Used by select connectors for which the OAuth workﬂow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack. OAuth2Credentials API Version 2020-08-23 376 AmazonAppFlow API Reference Type: ConnectorOAuthRequest object Required: No refreshToken The refresh token used to refresh an expired access token. Type: String Length Constraints: Maximum length of 4096. Pattern: \S+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 377 AmazonAppFlow API Reference OAuth2CustomParameter Custom parameter required for OAuth 2.0 authentication. Contents connectorSuppliedValues Contains default values for this authentication parameter that are supplied by the connector. Type: Array of strings Length Constraints: Maximum length of 256. Pattern: \S+ Required: No description A description about the custom parameter used for OAuth 2.0 authentication. Type: String Length Constraints: Maximum length of 1024. Pattern: [\s\w/!@#+=.-]* Required: No isRequired Indicates whether the custom parameter for OAuth 2.0 authentication is required. Type: Boolean Required: No isSensitiveField Indicates whether this authentication custom parameter is a sensitive ﬁeld. Type: Boolean Required: No OAuth2CustomParameter API Version 2020-08-23 378 AmazonAppFlow key API Reference The key of the custom parameter required for OAuth 2.0 authentication. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: No label The label of the custom parameter used for OAuth 2.0 authentication. Type: String Length Constraints: Maximum length of 128. Pattern: .* Required: No type Indicates whether custom parameter is used with TokenUrl or AuthUrl. Type: String Valid Values: TOKEN_URL \| AUTH_URL Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 379 AmazonAppFlow OAuth2Defaults Contains the default values required for OAuth 2.0 authentication. API Reference Contents authCodeUrls Auth code URLs that can be used for OAuth 2.0 authentication. Type: Array of strings Length Constraints: Maximum length of 256. Pattern: ^(https?)://[-a-zA-Z0-9+&@#/%?=~_\|!:,.;][-a-zA-Z0-9+&@#/%=~_\|] Required: No oauth2CustomProperties List of custom parameters required for OAuth 2.0 authentication. Type: Array of OAuth2CustomParameter objects Required: No oauth2GrantTypesSupported OAuth 2.0 grant types supported by the connector. Type: Array of strings Valid Values: CLIENT_CREDENTIALS \| AUTHORIZATION_CODE \| JWT_BEARER Required: No oauthScopes OAuth 2.0 scopes that the connector supports. Type: Array of strings Length Constraints: Maximum length of 128. Pattern: \S+ OAuth2Defaults API Version 2020-08-23 380 AmazonAppFlow Required: No tokenUrls Token URLs that can be used for OAuth 2.0 authentication. Type: Array of strings Length Constraints: Maximum length of 256. API Reference Pattern: ^(https?)://[-a-zA-Z0-9+&@#/%?=~_\|!:,.;][-a-zA-Z0-9+&@#/%=~_\|] Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 381 AmazonAppFlow OAuth2Properties The OAuth 2.0 properties required for OAuth 2.0 authentication. API Reference Contents oAuth2GrantType The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication. Type: String Valid Values: CLIENT_CREDENTIALS \| AUTHORIZATION_CODE \| JWT_BEARER Required: Yes tokenUrl The token URL required for OAuth 2.0 authentication. Type: String Length Constraints: Maximum length of 256. Pattern: ^(https?)://[-a-zA-Z0-9+&@#/%?=~_\|!:,.;]*[-a-zA-Z0-9+&@#/%=~_\|] Required: Yes tokenUrlCustomProperties Associates your token URL with a map of properties that you deﬁne. Use this parameter to provide any additional details that the connector requires to authenticate your request. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: [\w]+ Value Length Constraints: Maximum length of 2048. Value Pattern: \S+ OAuth2Properties
amazon-appflow-api-059	amazon-appflow-api.pdf	59	Values: CLIENT_CREDENTIALS \| AUTHORIZATION_CODE \| JWT_BEARER Required: Yes tokenUrl The token URL required for OAuth 2.0 authentication. Type: String Length Constraints: Maximum length of 256. Pattern: ^(https?)://[-a-zA-Z0-9+&@#/%?=~_\|!:,.;][-a-zA-Z0-9+&@#/%=~_\|] Required: Yes tokenUrlCustomProperties Associates your token URL with a map of properties that you deﬁne. Use this parameter to provide any additional details that the connector requires to authenticate your request. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: [\w]+ Value Length Constraints: Maximum length of 2048. Value Pattern: \S+ OAuth2Properties API Version 2020-08-23 382 AmazonAppFlow Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 383 AmazonAppFlow OAuthCredentials The OAuth credentials required for OAuth type authentication. API Reference Contents clientId The identiﬁer for the desired client. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes clientSecret The client secret used by the OAuth client to authenticate to the authorization server. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes accessToken The access token used to access protected SAPOData resources. Type: String Length Constraints: Maximum length of 4096. Pattern: \S+ Required: No oAuthRequest The OAuth requirement needed to request security tokens from the connector endpoint. OAuthCredentials API Version 2020-08-23 384 AmazonAppFlow API Reference Type: ConnectorOAuthRequest object Required: No refreshToken The refresh token used to refresh expired access token. Type: String Length Constraints: Maximum length of 4096. Pattern: \S+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 385 AmazonAppFlow OAuthProperties The OAuth properties required for OAuth type authentication. API Reference Contents authCodeUrl The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type authentication. Type: String Length Constraints: Maximum length of 256. Pattern: ^(https?)://[-a-zA-Z0-9+&@#/%?=~_\|!:,.;][-a-zA-Z0-9+&@#/%=~_\|] Required: Yes oAuthScopes The OAuth scopes required for OAuth type authentication. Type: Array of strings Length Constraints: Maximum length of 128. Pattern: \S+ Required: Yes tokenUrl The token url required to fetch access/refresh tokens using authorization code and also to refresh expired access token using refresh token. Type: String Length Constraints: Maximum length of 256. Pattern: ^(https?)://[-a-zA-Z0-9+&@#/%?=~_\|!:,.;][-a-zA-Z0-9+&@#/%=~_\|] Required: Yes OAuthProperties API Version 2020-08-23 386 AmazonAppFlow See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 387 AmazonAppFlow API Reference PardotConnectorProﬁleCredentials The connector-speciﬁc proﬁle credentials required when using Salesforce Pardot. Contents accessToken The credentials used to access protected Salesforce Pardot resources. Type: String Length Constraints: Maximum length of 4096. Pattern: \S+ Required: No clientCredentialsArn The secret manager ARN, which contains the client ID and client secret of the connected app. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:aws:secretsmanager:.:[0-9]+:.* Required: No oAuthRequest Used by select connectors for which the OAuth workﬂow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack. Type: ConnectorOAuthRequest object Required: No refreshToken The credentials used to acquire new access tokens. Type: String PardotConnectorProﬁleCredentials API Version 2020-08-23 388 AmazonAppFlow API Reference Length Constraints: Maximum length of 4096. Pattern: \S+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 389 AmazonAppFlow API Reference PardotConnectorProﬁleProperties The connector-speciﬁc proﬁle properties required when using Salesforce Pardot. Contents businessUnitId The business unit id of Salesforce Pardot instance. Type: String Length Constraints: Maximum length of 18. Pattern: \S+ Required: No instanceUrl The location of the Salesforce Pardot resource. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: No isSandboxEnvironment Indicates whether the connector proﬁle applies to a sandbox or production environment. Type: Boolean Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: PardotConnectorProﬁleProperties API Version 2020-08-23 390 AmazonAppFlow • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 391 API Reference AmazonAppFlow PardotMetadata The connector metadata speciﬁc to Salesforce Pardot. Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
amazon-appflow-api-060	amazon-appflow-api.pdf	60	proﬁle applies to a sandbox or production environment. Type: Boolean Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: PardotConnectorProﬁleProperties API Version 2020-08-23 390 AmazonAppFlow • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 391 API Reference AmazonAppFlow PardotMetadata The connector metadata speciﬁc to Salesforce Pardot. Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PardotMetadata API Version 2020-08-23 392 AmazonAppFlow API Reference PardotSourceProperties The properties that are applied when Salesforce Pardot is being used as a source. Contents object The object speciﬁed in the Salesforce Pardot ﬂow source. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PardotSourceProperties API Version 2020-08-23 393 AmazonAppFlow PreﬁxConﬁg API Reference Speciﬁes elements that Amazon AppFlow includes in the ﬁle and folder names in the ﬂow destination. Contents pathPreﬁxHierarchy Speciﬁes whether the destination ﬁle path includes either or both of the following elements: EXECUTION_ID The ID that Amazon AppFlow assigns to the ﬂow run. SCHEMA_VERSION The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your ﬂow conﬁguration: • Source-to-destination ﬁeld mappings • Field data types • Partition keys Type: Array of strings Valid Values: EXECUTION_ID \| SCHEMA_VERSION Required: No preﬁxFormat Determines the level of granularity for the date and time that's included in the preﬁx. Type: String Valid Values: YEAR \| MONTH \| DAY \| HOUR \| MINUTE Required: No preﬁxType Determines the format of the preﬁx, and whether it applies to the ﬁle name, ﬁle path, or both. PreﬁxConﬁg API Version 2020-08-23 394 AmazonAppFlow Type: String API Reference Valid Values: FILENAME \| PATH \| PATH_AND_FILENAME Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 395 AmazonAppFlow API Reference PrivateConnectionProvisioningState Speciﬁes the private connection provisioning state. Contents failureCause Speciﬁes the private connection provisioning failure cause. Type: String Valid Values: CONNECTOR_AUTHENTICATION \| CONNECTOR_SERVER \| INTERNAL_SERVER \| ACCESS_DENIED \| VALIDATION Required: No failureMessage Speciﬁes the private connection provisioning failure reason. Type: String Length Constraints: Maximum length of 2048. Pattern: [\s\w/!@#+=.-]* Required: No status Speciﬁes the private connection provisioning status. Type: String Valid Values: FAILED \| PENDING \| CREATED Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: PrivateConnectionProvisioningState API Version 2020-08-23 396 AmazonAppFlow • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 397 API Reference AmazonAppFlow Range The range of values that the property supports. Contents maximum Maximum value supported by the ﬁeld. Type: Double Required: No minimum Minimum value supported by the ﬁeld. Type: Double Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Range API Version 2020-08-23 398 AmazonAppFlow API Reference RedshiftConnectorProﬁleCredentials The connector-speciﬁc proﬁle credentials required when using Amazon Redshift. Contents password The password that corresponds to the user name. Type: String Length Constraints: Maximum length of 512. Pattern: .* Required: No username The name of the user. Type: String Length Constraints: Maximum length of 2048. Pattern: .* Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RedshiftConnectorProﬁleCredentials API Version 2020-08-23 399 AmazonAppFlow API Reference RedshiftConnectorProﬁleProperties The connector-speciﬁc proﬁle properties when using Amazon Redshift. Contents bucketName A name for the associated Amazon S3 bucket. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: \S+ Required: Yes roleArn The Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift read-only access to Amazon S3. For more information, and for the polices that you attach to this role, see Allow Amazon Redshift to access your Amazon AppFlow data in Amazon S3. Type: String Length Constraints: Maximum length of 512. Pattern:
amazon-appflow-api-061	amazon-appflow-api.pdf	61	SDK for Ruby V3 RedshiftConnectorProﬁleCredentials API Version 2020-08-23 399 AmazonAppFlow API Reference RedshiftConnectorProﬁleProperties The connector-speciﬁc proﬁle properties when using Amazon Redshift. Contents bucketName A name for the associated Amazon S3 bucket. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: \S+ Required: Yes roleArn The Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift read-only access to Amazon S3. For more information, and for the polices that you attach to this role, see Allow Amazon Redshift to access your Amazon AppFlow data in Amazon S3. Type: String Length Constraints: Maximum length of 512. Pattern: arn:aws:iam:.:[0-9]+:. Required: Yes bucketPreﬁx The object key for the destination bucket in which Amazon AppFlow places the ﬁles. Type: String Length Constraints: Maximum length of 512. Pattern: .* Required: No RedshiftConnectorProﬁleProperties API Version 2020-08-23 400 AmazonAppFlow clusterIdentiﬁer API Reference The unique ID that's assigned to an Amazon Redshift cluster. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: No dataApiRoleArn The Amazon Resource Name (ARN) of an IAM role that permits Amazon AppFlow to access your Amazon Redshift database through the Data API. For more information, and for the polices that you attach to this role, see Allow Amazon AppFlow to access Amazon Redshift databases with the Data API. Type: String Length Constraints: Maximum length of 512. Pattern: arn:aws:iam:.:[0-9]+:. Required: No databaseName The name of an Amazon Redshift database. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: No databaseUrl The JDBC URL of the Amazon Redshift cluster. Type: String Length Constraints: Maximum length of 512. Contents API Version 2020-08-23 401 AmazonAppFlow Pattern: \S+ Required: No isRedshiftServerless API Reference Indicates whether the connector proﬁle deﬁnes a connection to an Amazon Redshift Serverless data warehouse. Type: Boolean Required: No workgroupName The name of an Amazon Redshift workgroup. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 402 AmazonAppFlow API Reference RedshiftDestinationProperties The properties that are applied when Amazon Redshift is being used as a destination. Contents intermediateBucketName The intermediate bucket that Amazon AppFlow uses when moving data into Amazon Redshift. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: \S+ Required: Yes object The object speciﬁed in the Amazon Redshift ﬂow destination. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes bucketPreﬁx The object key for the bucket in which Amazon AppFlow places the destination ﬁles. Type: String Length Constraints: Maximum length of 512. Pattern: .* Required: No errorHandlingConﬁg The settings that determine how Amazon AppFlow handles an error when placing data in the Amazon Redshift destination. For example, this setting would determine if the ﬂow should fail RedshiftDestinationProperties API Version 2020-08-23 403 AmazonAppFlow API Reference after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details. Type: ErrorHandlingConﬁg object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 404 API Reference AmazonAppFlow RedshiftMetadata The connector metadata speciﬁc to Amazon Redshift. Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RedshiftMetadata API Version 2020-08-23 405 AmazonAppFlow RegistrationOutput API Reference Describes the status of an attempt from Amazon AppFlow to register a resource. When you run a ﬂow that you've conﬁgured to use a metadata catalog, Amazon AppFlow registers a metadata table and data partitions with that catalog. This operation provides the status of that registration attempt. The operation also indicates how many related resources Amazon AppFlow created or updated. Contents message Explains the status of the registration attempt from Amazon AppFlow. If the attempt fails, the message explains why. Type: String Length Constraints: Maximum length of 2048. Pattern: .* Required: No result Indicates the number of resources that Amazon AppFlow created or updated. Possible resources include metadata tables and data partitions. Type: String Length Constraints: Maximum length of 2048. Pattern: .* Required: No status Indicates the status of the registration attempt from Amazon AppFlow. Type: String Valid Values: InProgress \| Successful \| Error \| CancelStarted \| Canceled RegistrationOutput API Version 2020-08-23 406 AmazonAppFlow Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc
amazon-appflow-api-062	amazon-appflow-api.pdf	62	If the attempt fails, the message explains why. Type: String Length Constraints: Maximum length of 2048. Pattern: .* Required: No result Indicates the number of resources that Amazon AppFlow created or updated. Possible resources include metadata tables and data partitions. Type: String Length Constraints: Maximum length of 2048. Pattern: .* Required: No status Indicates the status of the registration attempt from Amazon AppFlow. Type: String Valid Values: InProgress \| Successful \| Error \| CancelStarted \| Canceled RegistrationOutput API Version 2020-08-23 406 AmazonAppFlow Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 407 AmazonAppFlow API Reference S3DestinationProperties The properties that are applied when Amazon S3 is used as a destination. Contents bucketName The Amazon S3 bucket name in which Amazon AppFlow places the transferred data. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: \S+ Required: Yes bucketPreﬁx The object key for the destination bucket in which Amazon AppFlow places the ﬁles. Type: String Length Constraints: Maximum length of 512. Pattern: .* Required: No s3OutputFormatConﬁg The conﬁguration that determines how Amazon AppFlow should format the ﬂow output data when Amazon S3 is used as the destination. Type: S3OutputFormatConﬁg object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: S3DestinationProperties API Version 2020-08-23 408 AmazonAppFlow • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 409 AmazonAppFlow API Reference S3InputFormatConﬁg When you use Amazon S3 as the source, the conﬁguration format that you provide the ﬂow input data. Contents s3InputFileType The ﬁle type that Amazon AppFlow gets from your Amazon S3 bucket. Type: String Valid Values: CSV \| JSON Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 S3InputFormatConﬁg API Version 2020-08-23 410 API Reference AmazonAppFlow S3Metadata The connector metadata speciﬁc to Amazon S3. Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 S3Metadata API Version 2020-08-23 411 AmazonAppFlow API Reference S3OutputFormatConﬁg The conﬁguration that determines how Amazon AppFlow should format the ﬂow output data when Amazon S3 is used as the destination. Contents aggregationConﬁg The aggregation settings that you can use to customize the output format of your ﬂow data. Type: AggregationConﬁg object Required: No ﬁleType Indicates the ﬁle type that Amazon AppFlow places in the Amazon S3 bucket. Type: String Valid Values: CSV \| JSON \| PARQUET Required: No preﬁxConﬁg Determines the preﬁx that Amazon AppFlow applies to the folder name in the Amazon S3 bucket. You can name folders according to the ﬂow frequency and date. Type: PreﬁxConﬁg object Required: No preserveSourceDataTyping If your ﬁle output format is Parquet, use this parameter to set whether Amazon AppFlow preserves the data types in your source data when it writes the output to Amazon S3. • true: Amazon AppFlow preserves the data types when it writes to Amazon S3. For example, an integer or 1 in your source data is still an integer in your output. • false: Amazon AppFlow converts all of the source data into strings when it writes to Amazon S3. For example, an integer of 1 in your source data becomes the string "1" in the output. S3OutputFormatConﬁg API Version 2020-08-23 412 AmazonAppFlow Type: Boolean Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 413 AmazonAppFlow S3SourceProperties API Reference The properties that are applied when Amazon S3 is being used as the ﬂow source. Contents bucketName The Amazon S3 bucket name where the source ﬁles are stored. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: \S+ Required: Yes bucketPreﬁx The object key for the Amazon S3 bucket in which the source ﬁles are stored. Type: String Length Constraints: Maximum length of 512. Pattern: .* Required: No s3InputFormatConﬁg When you use Amazon S3 as the source, the conﬁguration format that you provide the ﬂow input data. Type: S3InputFormatConﬁg object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS
amazon-appflow-api-063	amazon-appflow-api.pdf	63	as the ﬂow source. Contents bucketName The Amazon S3 bucket name where the source ﬁles are stored. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: \S+ Required: Yes bucketPreﬁx The object key for the Amazon S3 bucket in which the source ﬁles are stored. Type: String Length Constraints: Maximum length of 512. Pattern: .* Required: No s3InputFormatConﬁg When you use Amazon S3 as the source, the conﬁguration format that you provide the ﬂow input data. Type: S3InputFormatConﬁg object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: S3SourceProperties API Version 2020-08-23 414 AmazonAppFlow • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 415 AmazonAppFlow API Reference SalesforceConnectorProﬁleCredentials The connector-speciﬁc proﬁle credentials required when using Salesforce. Contents accessToken The credentials used to access protected Salesforce resources. Type: String Length Constraints: Maximum length of 4096. Pattern: \S+ Required: No clientCredentialsArn The secret manager ARN, which contains the client ID and client secret of the connected app. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:aws:secretsmanager:.:[0-9]+:. Required: No jwtToken A JSON web token (JWT) that authorizes Amazon AppFlow to access your Salesforce records. Type: String Length Constraints: Maximum length of 8000. Pattern: ^([a-zA-Z0-9_=]+)\.([a-zA-Z0-9_=]+)\.([a-zA-Z0-9_\-\+\/=]*) Required: No oAuth2GrantType Speciﬁes the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records. SalesforceConnectorProﬁleCredentials API Version 2020-08-23 416 AmazonAppFlow API Reference You can specify one of the following values: AUTHORIZATION_CODE Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records. JWT_BEARER Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you deﬁne the connection to your Salesforce account. When you use this grant type, you don't need to log in to your Salesforce account to authorize Amazon AppFlow to access your records. Note The CLIENT_CREDENTIALS value is not supported for Salesforce. Type: String Valid Values: CLIENT_CREDENTIALS \| AUTHORIZATION_CODE \| JWT_BEARER Required: No oAuthRequest The OAuth requirement needed to request security tokens from the connector endpoint. Type: ConnectorOAuthRequest object Required: No refreshToken The credentials used to acquire new access tokens. Type: String Length Constraints: Maximum length of 4096. Pattern: \S+ Required: No Contents API Version 2020-08-23 417 AmazonAppFlow See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 418 AmazonAppFlow API Reference SalesforceConnectorProﬁleProperties The connector-speciﬁc proﬁle properties required when using Salesforce. Contents instanceUrl The location of the Salesforce resource. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: No isSandboxEnvironment Indicates whether the connector proﬁle applies to a sandbox or production environment. Type: Boolean Required: No usePrivateLinkForMetadataAndAuthorization If the connection mode for the connector proﬁle is private, this parameter sets whether Amazon AppFlow uses the private network to send metadata and authorization calls to Salesforce. Amazon AppFlow sends private calls through AWS PrivateLink. These calls travel through AWS infrastructure without being exposed to the public internet. Set either of the following values: true Amazon AppFlow sends all calls to Salesforce over the private network. These private calls are: • Calls to get metadata about your Salesforce records. This metadata describes your Salesforce objects and their ﬁelds. • Calls to get or refresh access tokens that allow Amazon AppFlow to access your Salesforce records. SalesforceConnectorProﬁleProperties API Version 2020-08-23 419 AmazonAppFlow API Reference • Calls to transfer your Salesforce records as part of a ﬂow run. false The default value. Amazon AppFlow sends some calls to Salesforce privately and other calls over the public internet. The public calls are: • Calls to get metadata about your Salesforce records. • Calls to get or refresh access tokens. The private calls are: • Calls to transfer your Salesforce records as part of a ﬂow run. Type: Boolean Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 420 AmazonAppFlow API Reference SalesforceDestinationProperties The properties that are applied when Salesforce is being used as a destination. Contents object The object speciﬁed in the Salesforce ﬂow destination. Type: String Length Constraints: Maximum length of 512. Pattern:
amazon-appflow-api-064	amazon-appflow-api.pdf	64	tokens. The private calls are: • Calls to transfer your Salesforce records as part of a ﬂow run. Type: Boolean Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 420 AmazonAppFlow API Reference SalesforceDestinationProperties The properties that are applied when Salesforce is being used as a destination. Contents object The object speciﬁed in the Salesforce ﬂow destination. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes dataTransferApi Speciﬁes which Salesforce API is used by Amazon AppFlow when your ﬂow transfers data to Salesforce. AUTOMATIC The default. Amazon AppFlow selects which API to use based on the number of records that your ﬂow transfers to Salesforce. If your ﬂow transfers fewer than 1,000 records, Amazon AppFlow uses Salesforce REST API. If your ﬂow transfers 1,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0. Each of these Salesforce APIs structures data diﬀerently. If Amazon AppFlow selects the API automatically, be aware that, for recurring ﬂows, the data output might vary from one ﬂow run to the next. For example, if a ﬂow runs daily, it might use REST API on one day to transfer 900 records, and it might use Bulk API 2.0 on the next day to transfer 1,100 records. For each of these ﬂow runs, the respective Salesforce API formats the data diﬀerently. Some of the diﬀerences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound ﬁelds. By choosing this option, you optimize ﬂow performance for both small and large data transfers, but the tradeoﬀ is inconsistent formatting in the output. SalesforceDestinationProperties API Version 2020-08-23 421 AmazonAppFlow BULKV2 API Reference Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for large sets of data. By choosing this option, you ensure that your ﬂow writes consistent output, but you optimize performance only for large data transfers. Note that Bulk API 2.0 does not transfer Salesforce compound ﬁelds. REST_SYNC Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your ﬂow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. In some cases, if your ﬂow attempts to transfer a vary large set of data, it might fail with a timed out error. Type: String Valid Values: AUTOMATIC \| BULKV2 \| REST_SYNC Required: No errorHandlingConﬁg The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination. For example, this setting would determine if the ﬂow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details. Type: ErrorHandlingConﬁg object Required: No idFieldNames The name of the ﬁeld that Amazon AppFlow uses as an ID when performing a write operation such as update or delete. Type: Array of strings Array Members: Minimum number of 0 items. Length Constraints: Maximum length of 128. Contents API Version 2020-08-23 422 AmazonAppFlow Pattern: \S+ Required: No writeOperationType API Reference This speciﬁes the type of write operation to be performed in Salesforce. When the value is UPSERT, then idFieldNames is required. Type: String Valid Values: INSERT \| UPSERT \| UPDATE \| DELETE Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 423 AmazonAppFlow SalesforceMetadata The connector metadata speciﬁc to Salesforce. Contents dataTransferApis API Reference The Salesforce APIs that you can have Amazon AppFlow use when your ﬂows transfers data to or from Salesforce. Type: Array of strings Valid Values: AUTOMATIC \| BULKV2 \| REST_SYNC Required: No oauth2GrantTypesSupported The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records. AUTHORIZATION_CODE Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records. JWT_BEARER Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you deﬁne the connection to your Salesforce account. When you use this grant type, you don't need to log in to your Salesforce account to authorize Amazon AppFlow to access your records. Note The CLIENT_CREDENTIALS value is
amazon-appflow-api-065	amazon-appflow-api.pdf	65	Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records. JWT_BEARER Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you deﬁne the connection to your Salesforce account. When you use this grant type, you don't need to log in to your Salesforce account to authorize Amazon AppFlow to access your records. Note The CLIENT_CREDENTIALS value is not supported for Salesforce. Type: Array of strings SalesforceMetadata API Version 2020-08-23 424 AmazonAppFlow API Reference Valid Values: CLIENT_CREDENTIALS \| AUTHORIZATION_CODE \| JWT_BEARER Required: No oAuthScopes The desired authorization scope for the Salesforce account. Type: Array of strings Length Constraints: Maximum length of 128. Pattern: \S+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 425 AmazonAppFlow API Reference SalesforceSourceProperties The properties that are applied when Salesforce is being used as a source. Contents object The object speciﬁed in the Salesforce ﬂow source. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes dataTransferApi Speciﬁes which Salesforce API is used by Amazon AppFlow when your ﬂow transfers data from Salesforce. AUTOMATIC The default. Amazon AppFlow selects which API to use based on the number of records that your ﬂow transfers from Salesforce. If your ﬂow transfers fewer than 1,000,000 records, Amazon AppFlow uses Salesforce REST API. If your ﬂow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0. Each of these Salesforce APIs structures data diﬀerently. If Amazon AppFlow selects the API automatically, be aware that, for recurring ﬂows, the data output might vary from one ﬂow run to the next. For example, if a ﬂow runs daily, it might use REST API on one day to transfer 900,000 records, and it might use Bulk API 2.0 on the next day to transfer 1,100,000 records. For each of these ﬂow runs, the respective Salesforce API formats the data diﬀerently. Some of the diﬀerences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound ﬁelds. By choosing this option, you optimize ﬂow performance for both small and large data transfers, but the tradeoﬀ is inconsistent formatting in the output. SalesforceSourceProperties API Version 2020-08-23 426 AmazonAppFlow BULKV2 API Reference Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for large sets of data. By choosing this option, you ensure that your ﬂow writes consistent output, but you optimize performance only for large data transfers. Note that Bulk API 2.0 does not transfer Salesforce compound ﬁelds. REST_SYNC Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your ﬂow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. In some cases, if your ﬂow attempts to transfer a vary large set of data, it might fail wituh a timed out error. Type: String Valid Values: AUTOMATIC \| BULKV2 \| REST_SYNC Required: No enableDynamicFieldUpdate The ﬂag that enables dynamic fetching of new (recently added) ﬁelds in the Salesforce objects while running a ﬂow. Type: Boolean Required: No includeDeletedRecords Indicates whether Amazon AppFlow includes deleted ﬁles in the ﬂow run. Type: Boolean Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2020-08-23 427 AmazonAppFlow • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 428 AmazonAppFlow API Reference SAPODataConnectorProﬁleCredentials The connector-speciﬁc proﬁle credentials required when using SAPOData. Contents basicAuthCredentials The SAPOData basic authentication credentials. Type: BasicAuthCredentials object Required: No oAuthCredentials The SAPOData OAuth type authentication credentials. Type: OAuthCredentials object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SAPODataConnectorProﬁleCredentials API Version 2020-08-23 429 AmazonAppFlow API Reference SAPODataConnectorProﬁleProperties The connector-speciﬁc proﬁle properties required when using SAPOData. Contents applicationHostUrl The location of the SAPOData resource. Type: String Length Constraints: Maximum length of 256. Pattern: ^(https?)://[-a-zA-Z0-9+&@#/%?=~_\|!:,.;]*[-a-zA-Z0-9+&@#/%=~_\|] Required: Yes applicationServicePath The application path to catalog service. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes clientNumber The client number for the client creating the connection. Type: String Length Constraints: Fixed length of 3. Pattern: ^\d{3}$ Required: Yes portNumber
amazon-appflow-api-066	amazon-appflow-api.pdf	66	SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SAPODataConnectorProﬁleCredentials API Version 2020-08-23 429 AmazonAppFlow API Reference SAPODataConnectorProﬁleProperties The connector-speciﬁc proﬁle properties required when using SAPOData. Contents applicationHostUrl The location of the SAPOData resource. Type: String Length Constraints: Maximum length of 256. Pattern: ^(https?)://[-a-zA-Z0-9+&@#/%?=~_\|!:,.;][-a-zA-Z0-9+&@#/%=~_\|] Required: Yes applicationServicePath The application path to catalog service. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes clientNumber The client number for the client creating the connection. Type: String Length Constraints: Fixed length of 3. Pattern: ^\d{3}$ Required: Yes portNumber The port number of the SAPOData instance. SAPODataConnectorProﬁleProperties API Version 2020-08-23 430 AmazonAppFlow Type: Integer API Reference Valid Range: Minimum value of 1. Maximum value of 65535. Required: Yes disableSSO If you set this parameter to true, Amazon AppFlow bypasses the single sign-on (SSO) settings in your SAP account when it accesses your SAP OData instance. Whether you need this option depends on the types of credentials that you applied to your SAP OData connection proﬁle. If your proﬁle uses basic authentication credentials, SAP SSO can prevent Amazon AppFlow from connecting to your account with your username and password. In this case, bypassing SSO makes it possible for Amazon AppFlow to connect successfully. However, if your proﬁle uses OAuth credentials, this parameter has no aﬀect. Type: Boolean Required: No logonLanguage The logon language of SAPOData instance. Type: String Length Constraints: Maximum length of 2. Pattern: ^[a-zA-Z0-9_]$ Required: No oAuthProperties The SAPOData OAuth properties required for OAuth type authentication. Type: OAuthProperties object Required: No privateLinkServiceName The SAPOData Private Link service name to be used for private data transfers. Type: String Contents API Version 2020-08-23 431 AmazonAppFlow API Reference Length Constraints: Maximum length of 512. Pattern: ^$\|com.amazonaws.vpce.[\w/!:@#.\-]+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 432 AmazonAppFlow API Reference SAPODataDestinationProperties The properties that are applied when using SAPOData as a ﬂow destination Contents objectPath The object path speciﬁed in the SAPOData ﬂow destination. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes errorHandlingConﬁg The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the ﬂow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details. Type: ErrorHandlingConﬁg object Required: No idFieldNames A list of ﬁeld names that can be used as an ID ﬁeld when performing a write operation. Type: Array of strings Array Members: Minimum number of 0 items. Length Constraints: Maximum length of 128. Pattern: \S+ Required: No SAPODataDestinationProperties API Version 2020-08-23 433 AmazonAppFlow API Reference successResponseHandlingConﬁg Determines how Amazon AppFlow handles the success response that it gets from the connector after placing data. For example, this setting would determine where to write the response from a destination connector upon a successful insert operation. Type: SuccessResponseHandlingConﬁg object Required: No writeOperationType The possible write operations in the destination connector. When this value is not provided, this defaults to the INSERT operation. Type: String Valid Values: INSERT \| UPSERT \| UPDATE \| DELETE Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 434 AmazonAppFlow SAPODataMetadata The connector metadata speciﬁc to SAPOData. Contents API Reference The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SAPODataMetadata API Version 2020-08-23 435 AmazonAppFlow API Reference SAPODataPaginationConﬁg Sets the page size for each concurrent process that transfers OData records from your SAP instance. A concurrent process is query that retrieves a batch of records as part of a ﬂow run. Amazon AppFlow can run multiple concurrent processes in parallel to transfer data faster. Contents maxPageSize The maximum number of records that Amazon AppFlow receives in each page of the response from your SAP application. For transfers of OData records, the maximum page size is 3,000. For transfers of data that comes from an ODP provider, the maximum page size is 10,000. Type: Integer Valid Range: Minimum value of 1. Maximum value of 10000. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++
amazon-appflow-api-067	amazon-appflow-api.pdf	67	run. Amazon AppFlow can run multiple concurrent processes in parallel to transfer data faster. Contents maxPageSize The maximum number of records that Amazon AppFlow receives in each page of the response from your SAP application. For transfers of OData records, the maximum page size is 3,000. For transfers of data that comes from an ODP provider, the maximum page size is 10,000. Type: Integer Valid Range: Minimum value of 1. Maximum value of 10000. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SAPODataPaginationConﬁg API Version 2020-08-23 436 AmazonAppFlow API Reference SAPODataParallelismConﬁg Sets the number of concurrent processes that transfer OData records from your SAP instance. A concurrent process is query that retrieves a batch of records as part of a ﬂow run. Amazon AppFlow can run multiple concurrent processes in parallel to transfer data faster. Contents maxParallelism The maximum number of processes that Amazon AppFlow runs at the same time when it retrieves your data from your SAP application. Type: Integer Valid Range: Minimum value of 1. Maximum value of 10. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SAPODataParallelismConﬁg API Version 2020-08-23 437 AmazonAppFlow API Reference SAPODataSourceProperties The properties that are applied when using SAPOData as a ﬂow source. Contents objectPath The object path speciﬁed in the SAPOData ﬂow source. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: No paginationConﬁg Sets the page size for each concurrent process that transfers OData records from your SAP instance. Type: SAPODataPaginationConﬁg object Required: No parallelismConﬁg Sets the number of concurrent processes that transfers OData records from your SAP instance. Type: SAPODataParallelismConﬁg object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 SAPODataSourceProperties API Version 2020-08-23 438 AmazonAppFlow • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 439 AmazonAppFlow API Reference ScheduledTriggerProperties Speciﬁes the conﬁguration details of a schedule-triggered ﬂow as deﬁned by the user. Currently, these settings only apply to the Scheduled trigger type. Contents scheduleExpression The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes). Type: String Length Constraints: Maximum length of 256. Pattern: .* Required: Yes dataPullMode Speciﬁes whether a scheduled ﬂow has an incremental data transfer or a complete data transfer for each ﬂow run. Type: String Valid Values: Incremental \| Complete Required: No ﬁrstExecutionFrom Speciﬁes the date range for the records to import from the connector in the ﬁrst ﬂow run. Type: Timestamp Required: No ﬂowErrorDeactivationThreshold Deﬁnes how many times a scheduled ﬂow fails consecutively before Amazon AppFlow deactivates it. ScheduledTriggerProperties API Version 2020-08-23 440 AmazonAppFlow Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No scheduleEndTime API Reference The time at which the scheduled ﬂow ends. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-27T13:00:00-07:00. Type: Timestamp Required: No scheduleOﬀset Speciﬁes the optional oﬀset that is added to the time interval for a schedule-triggered ﬂow. Type: Long Valid Range: Minimum value of 0. Maximum value of 36000. Required: No scheduleStartTime The time at which the scheduled ﬂow starts. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-26T13:00:00-07:00. Type: Timestamp Required: No timezone Speciﬁes the time zone used when referring to the dates and times of a scheduled ﬂow, such as America/New_York. This time zone is only a descriptive label. It doesn't aﬀect how Amazon AppFlow interprets the timestamps that you specify to schedule the ﬂow. If you want to schedule a ﬂow by using times in a particular time zone, indicate the time zone as a UTC oﬀset in your timestamps. For example, the UTC oﬀsets for the America/New_York timezone are -04:00 EDT and -05:00 EST. Type: String Contents API Version 2020-08-23 441 AmazonAppFlow API Reference Length Constraints: Maximum length of 256. Pattern: .* Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 442 AmazonAppFlow API Reference ServiceNowConnectorProﬁleCredentials The connector-speciﬁc proﬁle credentials required when using ServiceNow. Contents oAuth2Credentials The OAuth 2.0 credentials required to authenticate the user. Type: OAuth2Credentials object Required: No password The password that corresponds to the user name. Type: String Length Constraints: Maximum length of 512.
amazon-appflow-api-068	amazon-appflow-api.pdf	68	AmazonAppFlow API Reference Length Constraints: Maximum length of 256. Pattern: .* Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 442 AmazonAppFlow API Reference ServiceNowConnectorProﬁleCredentials The connector-speciﬁc proﬁle credentials required when using ServiceNow. Contents oAuth2Credentials The OAuth 2.0 credentials required to authenticate the user. Type: OAuth2Credentials object Required: No password The password that corresponds to the user name. Type: String Length Constraints: Maximum length of 512. Pattern: .* Required: No username The name of the user. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: ServiceNowConnectorProﬁleCredentials API Version 2020-08-23 443 AmazonAppFlow • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 444 AmazonAppFlow API Reference ServiceNowConnectorProﬁleProperties The connector-speciﬁc proﬁle properties required when using ServiceNow. Contents instanceUrl The location of the ServiceNow resource. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ServiceNowConnectorProﬁleProperties API Version 2020-08-23 445 AmazonAppFlow API Reference ServiceNowMetadata The connector metadata speciﬁc to ServiceNow. Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ServiceNowMetadata API Version 2020-08-23 446 AmazonAppFlow API Reference ServiceNowSourceProperties The properties that are applied when ServiceNow is being used as a source. Contents object The object speciﬁed in the ServiceNow ﬂow source. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ServiceNowSourceProperties API Version 2020-08-23 447 AmazonAppFlow API Reference SingularConnectorProﬁleCredentials The connector-speciﬁc proﬁle credentials required when using Singular. Contents apiKey A unique alphanumeric identiﬁer used to authenticate a user, developer, or calling program to your API. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SingularConnectorProﬁleCredentials API Version 2020-08-23 448 AmazonAppFlow API Reference SingularConnectorProﬁleProperties The connector-speciﬁc proﬁle properties required when using Singular. Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SingularConnectorProﬁleProperties API Version 2020-08-23 449 AmazonAppFlow SingularMetadata The connector metadata speciﬁc to Singular. Contents API Reference The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SingularMetadata API Version 2020-08-23 450 AmazonAppFlow API Reference SingularSourceProperties The properties that are applied when Singular is being used as a source. Contents object The object speciﬁed in the Singular ﬂow source. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SingularSourceProperties API Version 2020-08-23 451 AmazonAppFlow API Reference SlackConnectorProﬁleCredentials The connector-speciﬁc proﬁle credentials required when using Slack. Contents clientId The identiﬁer for the client. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes clientSecret The client secret used by the OAuth client to authenticate to the authorization server. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes accessToken The credentials used to access protected Slack resources. Type: String Length Constraints: Maximum length of 4096. Pattern: \S+ Required: No oAuthRequest The OAuth requirement needed to request security tokens from the connector endpoint. SlackConnectorProﬁleCredentials API Version 2020-08-23 452 AmazonAppFlow API Reference Type: ConnectorOAuthRequest object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ •
amazon-appflow-api-069	amazon-appflow-api.pdf	69	Yes clientSecret The client secret used by the OAuth client to authenticate to the authorization server. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes accessToken The credentials used to access protected Slack resources. Type: String Length Constraints: Maximum length of 4096. Pattern: \S+ Required: No oAuthRequest The OAuth requirement needed to request security tokens from the connector endpoint. SlackConnectorProﬁleCredentials API Version 2020-08-23 452 AmazonAppFlow API Reference Type: ConnectorOAuthRequest object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 453 AmazonAppFlow API Reference SlackConnectorProﬁleProperties The connector-speciﬁc proﬁle properties required when using Slack. Contents instanceUrl The location of the Slack resource. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SlackConnectorProﬁleProperties API Version 2020-08-23 454 API Reference AmazonAppFlow SlackMetadata The connector metadata speciﬁc to Slack. Contents oAuthScopes The desired authorization scope for the Slack account. Type: Array of strings Length Constraints: Maximum length of 128. Pattern: \S+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SlackMetadata API Version 2020-08-23 455 AmazonAppFlow API Reference SlackSourceProperties The properties that are applied when Slack is being used as a source. Contents object The object speciﬁed in the Slack ﬂow source. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SlackSourceProperties API Version 2020-08-23 456 AmazonAppFlow API Reference SnowﬂakeConnectorProﬁleCredentials The connector-speciﬁc proﬁle credentials required when using Snowﬂake. Contents password The password that corresponds to the user name. Type: String Length Constraints: Maximum length of 512. Pattern: .* Required: Yes username The name of the user. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SnowﬂakeConnectorProﬁleCredentials API Version 2020-08-23 457 AmazonAppFlow API Reference SnowﬂakeConnectorProﬁleProperties The connector-speciﬁc proﬁle properties required when using Snowﬂake. Contents bucketName The name of the Amazon S3 bucket associated with Snowﬂake. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: \S+ Required: Yes stage The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowﬂake account. This is written in the following format: < Database>< Schema><Stage Name>. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes warehouse The name of the Snowﬂake warehouse. Type: String Length Constraints: Maximum length of 512. Pattern: [\s\w/!@#+=.-]* Required: Yes SnowﬂakeConnectorProﬁleProperties API Version 2020-08-23 458 API Reference AmazonAppFlow accountName The name of the account. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: No bucketPreﬁx The bucket path that refers to the Amazon S3 bucket associated with Snowﬂake. Type: String Length Constraints: Maximum length of 512. Pattern: .* Required: No privateLinkServiceName The Snowﬂake Private Link service name to be used for private data transfers. Type: String Length Constraints: Maximum length of 512. Pattern: ^$\|com.amazonaws.vpce.[\w/!:@#.\-]+ Required: No region The AWS Region of the Snowﬂake account. Type: String Length Constraints: Maximum length of 64. Pattern: \S+ Contents API Version 2020-08-23 459 AmazonAppFlow Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 460 AmazonAppFlow API Reference SnowﬂakeDestinationProperties The properties that are applied when Snowﬂake is being used as a destination. Contents intermediateBucketName The intermediate bucket that Amazon AppFlow uses when moving data into Snowﬂake. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: \S+ Required: Yes object The object speciﬁed in the Snowﬂake ﬂow destination. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes bucketPreﬁx The object key for the destination bucket in which Amazon AppFlow places the ﬁles. Type: String Length Constraints: Maximum length of 512. Pattern: .* Required: No errorHandlingConﬁg The settings that determine how Amazon AppFlow handles an error when placing data in
amazon-appflow-api-070	amazon-appflow-api.pdf	70	Snowﬂake is being used as a destination. Contents intermediateBucketName The intermediate bucket that Amazon AppFlow uses when moving data into Snowﬂake. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: \S+ Required: Yes object The object speciﬁed in the Snowﬂake ﬂow destination. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes bucketPreﬁx The object key for the destination bucket in which Amazon AppFlow places the ﬁles. Type: String Length Constraints: Maximum length of 512. Pattern: .* Required: No errorHandlingConﬁg The settings that determine how Amazon AppFlow handles an error when placing data in the Snowﬂake destination. For example, this setting would determine if the ﬂow should fail after SnowﬂakeDestinationProperties API Version 2020-08-23 461 AmazonAppFlow API Reference one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details. Type: ErrorHandlingConﬁg object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 462 API Reference AmazonAppFlow SnowﬂakeMetadata The connector metadata speciﬁc to Snowﬂake. Contents supportedRegions Speciﬁes the supported AWS Regions when using Snowﬂake. Type: Array of strings Length Constraints: Maximum length of 64. Pattern: \S+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SnowﬂakeMetadata API Version 2020-08-23 463 AmazonAppFlow API Reference SourceConnectorProperties Speciﬁes the information that is required to query a particular connector. Contents Amplitude Speciﬁes the information that is required for querying Amplitude. Type: AmplitudeSourceProperties object Required: No CustomConnector The properties that are applied when the custom connector is being used as a source. Type: CustomConnectorSourceProperties object Required: No Datadog Speciﬁes the information that is required for querying Datadog. Type: DatadogSourceProperties object Required: No Dynatrace Speciﬁes the information that is required for querying Dynatrace. Type: DynatraceSourceProperties object Required: No GoogleAnalytics Speciﬁes the information that is required for querying Google Analytics. Type: GoogleAnalyticsSourceProperties object Required: No SourceConnectorProperties API Version 2020-08-23 464 AmazonAppFlow InforNexus API Reference Speciﬁes the information that is required for querying Infor Nexus. Type: InforNexusSourceProperties object Required: No Marketo Speciﬁes the information that is required for querying Marketo. Type: MarketoSourceProperties object Required: No Pardot Speciﬁes the information that is required for querying Salesforce Pardot. Type: PardotSourceProperties object Required: No S3 Speciﬁes the information that is required for querying Amazon S3. Type: S3SourceProperties object Required: No Salesforce Speciﬁes the information that is required for querying Salesforce. Type: SalesforceSourceProperties object Required: No SAPOData The properties that are applied when using SAPOData as a ﬂow source. Type: SAPODataSourceProperties object Required: No Contents API Version 2020-08-23 465 AmazonAppFlow ServiceNow API Reference Speciﬁes the information that is required for querying ServiceNow. Type: ServiceNowSourceProperties object Required: No Singular Speciﬁes the information that is required for querying Singular. Type: SingularSourceProperties object Required: No Slack Speciﬁes the information that is required for querying Slack. Type: SlackSourceProperties object Required: No Trendmicro Speciﬁes the information that is required for querying Trend Micro. Type: TrendmicroSourceProperties object Required: No Veeva Speciﬁes the information that is required for querying Veeva. Type: VeevaSourceProperties object Required: No Zendesk Speciﬁes the information that is required for querying Zendesk. Type: ZendeskSourceProperties object Required: No Contents API Version 2020-08-23 466 AmazonAppFlow See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 467 AmazonAppFlow API Reference SourceFieldProperties The properties that can be applied to a ﬁeld when the connector is being used as a source. Contents isQueryable Indicates if the ﬁeld can be queried. Type: Boolean Required: No isRetrievable Indicates whether the ﬁeld can be returned in a search result. Type: Boolean Required: No isTimestampFieldForIncrementalQueries Indicates if this timestamp ﬁeld can be used for incremental queries. Type: Boolean Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SourceFieldProperties API Version 2020-08-23 468 AmazonAppFlow SourceFlowConﬁg API Reference Contains information about the conﬁguration of the source connector used in the ﬂow. Contents connectorType The type of connector, such as Salesforce, Amplitude, and so on. Type: String Valid Values: Salesforce \| Singular \| Slack \| Redshift \| S3 \| Marketo \| Googleanalytics \| Zendesk \| Servicenow \| Datadog \| Trendmicro \| Snowflake \| Dynatrace \| Infornexus \| Amplitude \| Veeva \| EventBridge \| LookoutMetrics \| Upsolver
amazon-appflow-api-071	amazon-appflow-api.pdf	71	the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SourceFieldProperties API Version 2020-08-23 468 AmazonAppFlow SourceFlowConﬁg API Reference Contains information about the conﬁguration of the source connector used in the ﬂow. Contents connectorType The type of connector, such as Salesforce, Amplitude, and so on. Type: String Valid Values: Salesforce \| Singular \| Slack \| Redshift \| S3 \| Marketo \| Googleanalytics \| Zendesk \| Servicenow \| Datadog \| Trendmicro \| Snowflake \| Dynatrace \| Infornexus \| Amplitude \| Veeva \| EventBridge \| LookoutMetrics \| Upsolver \| Honeycode \| CustomerProfiles \| SAPOData \| CustomConnector \| Pardot Required: Yes sourceConnectorProperties Speciﬁes the information that is required to query a particular source connector. Type: SourceConnectorProperties object Required: Yes apiVersion The API version of the connector when it's used as a source in the ﬂow. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: No connectorProﬁleName The name of the connector proﬁle. This name must be unique for each connector proﬁle in the AWS account. SourceFlowConﬁg API Version 2020-08-23 469 AmazonAppFlow Type: String Length Constraints: Maximum length of 256. Pattern: [\w/!@#+=.-]+ Required: No incrementalPullConﬁg API Reference Deﬁnes the conﬁguration for a scheduled incremental data pull. If a valid conﬁguration is provided, the ﬁelds speciﬁed in the conﬁguration are used when querying for the incremental data pull. Type: IncrementalPullConﬁg object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 470 AmazonAppFlow API Reference SuccessResponseHandlingConﬁg Determines how Amazon AppFlow handles the success response that it gets from the connector after placing data. For example, this setting would determine where to write the response from the destination connector upon a successful insert operation. Contents bucketName The name of the Amazon S3 bucket. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: \S+ Required: No bucketPreﬁx The Amazon S3 bucket preﬁx. Type: String Length Constraints: Maximum length of 512. Pattern: .* Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 SuccessResponseHandlingConﬁg API Version 2020-08-23 471 AmazonAppFlow • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 472 AmazonAppFlow API Reference SupportedFieldTypeDetails Contains details regarding all the supported FieldTypes and their corresponding filterOperators and supportedValues. Contents v1 The initial supported version for fieldType. If this is later changed to a diﬀerent version, v2 will be introduced. Type: FieldTypeDetails object Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SupportedFieldTypeDetails API Version 2020-08-23 473 AmazonAppFlow Task API Reference A class for modeling diﬀerent type of tasks. Task implementation varies based on the TaskType. Contents sourceFields The source ﬁelds to which a particular task is applied. Type: Array of strings Length Constraints: Maximum length of 2048. Pattern: .* Required: Yes taskType Speciﬁes the particular task implementation that Amazon AppFlow performs. Type: String Valid Values: Arithmetic \| Filter \| Map \| Map_all \| Mask \| Merge \| Passthrough \| Truncate \| Validate \| Partition Required: Yes connectorOperator The operation to be performed on the provided source ﬁelds. Type: ConnectorOperator object Required: No destinationField A ﬁeld in a destination connector, or a ﬁeld value against which Amazon AppFlow validates a source ﬁeld. Type: String Length Constraints: Maximum length of 256. Task API Version 2020-08-23 474 AmazonAppFlow Pattern: .* Required: No taskProperties API Reference A map used to store task-related information. The execution service looks for particular information based on the TaskType. Type: String to string map Valid Keys: VALUE \| VALUES \| DATA_TYPE \| UPPER_BOUND \| LOWER_BOUND \| SOURCE_DATA_TYPE \| DESTINATION_DATA_TYPE \| VALIDATION_ACTION \| MASK_VALUE \| MASK_LENGTH \| TRUNCATE_LENGTH \| MATH_OPERATION_FIELDS_ORDER \| CONCAT_FORMAT \| SUBFIELD_CATEGORY_MAP \| EXCLUDE_SOURCE_FIELDS_LIST \| INCLUDE_NEW_FIELDS \| ORDERED_PARTITION_KEYS_LIST Value Length Constraints: Maximum length of 2048. Value Pattern: .+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 475 AmazonAppFlow API Reference TrendmicroConnectorProﬁleCredentials The connector-speciﬁc proﬁle credentials required when using Trend Micro. Contents apiSecretKey The Secret Access Key portion of the credentials. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for
amazon-appflow-api-072	amazon-appflow-api.pdf	72	See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 475 AmazonAppFlow API Reference TrendmicroConnectorProﬁleCredentials The connector-speciﬁc proﬁle credentials required when using Trend Micro. Contents apiSecretKey The Secret Access Key portion of the credentials. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TrendmicroConnectorProﬁleCredentials API Version 2020-08-23 476 AmazonAppFlow API Reference TrendmicroConnectorProﬁleProperties The connector-speciﬁc proﬁle properties required when using Trend Micro. Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TrendmicroConnectorProﬁleProperties API Version 2020-08-23 477 AmazonAppFlow API Reference TrendmicroMetadata The connector metadata speciﬁc to Trend Micro. Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TrendmicroMetadata API Version 2020-08-23 478 AmazonAppFlow API Reference TrendmicroSourceProperties The properties that are applied when using Trend Micro as a ﬂow source. Contents object The object speciﬁed in the Trend Micro ﬂow source. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TrendmicroSourceProperties API Version 2020-08-23 479 AmazonAppFlow TriggerConﬁg API Reference The trigger settings that determine how and when Amazon AppFlow runs the speciﬁed ﬂow. Contents triggerType Speciﬁes the type of ﬂow trigger. This can be OnDemand, Scheduled, or Event. Type: String Valid Values: Scheduled \| Event \| OnDemand Required: Yes triggerProperties Speciﬁes the conﬁguration details of a schedule-triggered ﬂow as deﬁned by the user. Currently, these settings only apply to the Scheduled trigger type. Type: TriggerProperties object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TriggerConﬁg API Version 2020-08-23 480 AmazonAppFlow TriggerProperties API Reference Speciﬁes the conﬁguration details that control the trigger for a ﬂow. Currently, these settings only apply to the Scheduled trigger type. Contents Scheduled Speciﬁes the conﬁguration details of a schedule-triggered ﬂow as deﬁned by the user. Type: ScheduledTriggerProperties object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TriggerProperties API Version 2020-08-23 481 AmazonAppFlow API Reference UpsolverDestinationProperties The properties that are applied when Upsolver is used as a destination. Contents bucketName The Upsolver Amazon S3 bucket name in which Amazon AppFlow places the transferred data. Type: String Length Constraints: Minimum length of 16. Maximum length of 63. Pattern: ^(upsolver-appflow)\S* Required: Yes s3OutputFormatConﬁg The conﬁguration that determines how data is formatted when Upsolver is used as the ﬂow destination. Type: UpsolverS3OutputFormatConﬁg object Required: Yes bucketPreﬁx The object key for the destination Upsolver Amazon S3 bucket in which Amazon AppFlow places the ﬁles. Type: String Length Constraints: Maximum length of 512. Pattern: .* Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: UpsolverDestinationProperties API Version 2020-08-23 482 AmazonAppFlow • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-23 483 AmazonAppFlow UpsolverMetadata The connector metadata speciﬁc to Upsolver. Contents API Reference The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 UpsolverMetadata API Version 2020-08-23 484 AmazonAppFlow API Reference UpsolverS3OutputFormatConﬁg The conﬁguration that determines how Amazon AppFlow formats the ﬂow output data when Upsolver is used as the destination. Contents preﬁxConﬁg Speciﬁes elements that Amazon AppFlow includes in the ﬁle and folder names in the ﬂow destination. Type: PreﬁxConﬁg object Required: Yes aggregationConﬁg The aggregation settings that you can use to customize the output format of your ﬂow data. Type: AggregationConﬁg object Required:
amazon-appflow-api-073	amazon-appflow-api.pdf	73	API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 UpsolverMetadata API Version 2020-08-23 484 AmazonAppFlow API Reference UpsolverS3OutputFormatConﬁg The conﬁguration that determines how Amazon AppFlow formats the ﬂow output data when Upsolver is used as the destination. Contents preﬁxConﬁg Speciﬁes elements that Amazon AppFlow includes in the ﬁle and folder names in the ﬂow destination. Type: PreﬁxConﬁg object Required: Yes aggregationConﬁg The aggregation settings that you can use to customize the output format of your ﬂow data. Type: AggregationConﬁg object Required: No ﬁleType Indicates the ﬁle type that Amazon AppFlow places in the Upsolver Amazon S3 bucket. Type: String Valid Values: CSV \| JSON \| PARQUET Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 UpsolverS3OutputFormatConﬁg API Version 2020-08-23 485 AmazonAppFlow API Reference See Also API Version 2020-08-23 486 AmazonAppFlow API Reference VeevaConnectorProﬁleCredentials The connector-speciﬁc proﬁle credentials required when using Veeva. Contents password The password that corresponds to the user name. Type: String Length Constraints: Maximum length of 512. Pattern: .* Required: Yes username The name of the user. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 VeevaConnectorProﬁleCredentials API Version 2020-08-23 487 AmazonAppFlow API Reference VeevaConnectorProﬁleProperties The connector-speciﬁc proﬁle properties required when using Veeva. Contents instanceUrl The location of the Veeva resource. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 VeevaConnectorProﬁleProperties API Version 2020-08-23 488 AmazonAppFlow VeevaMetadata The connector metadata speciﬁc to Veeva. Contents API Reference The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 VeevaMetadata API Version 2020-08-23 489 AmazonAppFlow API Reference VeevaSourceProperties The properties that are applied when using Veeva as a ﬂow source. Contents object The object speciﬁed in the Veeva ﬂow source. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes documentType The document type speciﬁed in the Veeva document extract ﬂow. Type: String Length Constraints: Maximum length of 512. Pattern: [\s\w_-]+ Required: No includeAllVersions Boolean value to include All Versions of ﬁles in Veeva document extract ﬂow. Type: Boolean Required: No includeRenditions Boolean value to include ﬁle renditions in Veeva document extract ﬂow. Type: Boolean Required: No VeevaSourceProperties API Version 2020-08-23 490 AmazonAppFlow includeSourceFiles API Reference Boolean value to include source ﬁles in Veeva document extract ﬂow. Type: Boolean Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 491 AmazonAppFlow API Reference ZendeskConnectorProﬁleCredentials The connector-speciﬁc proﬁle credentials required when using Zendesk. Contents clientId The identiﬁer for the desired client. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes clientSecret The client secret used by the OAuth client to authenticate to the authorization server. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes accessToken The credentials used to access protected Zendesk resources. Type: String Length Constraints: Maximum length of 4096. Pattern: \S+ Required: No oAuthRequest The OAuth requirement needed to request security tokens from the connector endpoint. ZendeskConnectorProﬁleCredentials API Version 2020-08-23 492 AmazonAppFlow API Reference Type: ConnectorOAuthRequest object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 493 AmazonAppFlow API Reference ZendeskConnectorProﬁleProperties The connector-speciﬁc proﬁle properties required when using Zendesk. Contents instanceUrl The location of the Zendesk resource. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ZendeskConnectorProﬁleProperties API Version 2020-08-23 494 AmazonAppFlow API Reference ZendeskDestinationProperties The properties that are applied when Zendesk is used as a
amazon-appflow-api-074	amazon-appflow-api.pdf	74	• AWS SDK for Ruby V3 See Also API Version 2020-08-23 493 AmazonAppFlow API Reference ZendeskConnectorProﬁleProperties The connector-speciﬁc proﬁle properties required when using Zendesk. Contents instanceUrl The location of the Zendesk resource. Type: String Length Constraints: Maximum length of 256. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ZendeskConnectorProﬁleProperties API Version 2020-08-23 494 AmazonAppFlow API Reference ZendeskDestinationProperties The properties that are applied when Zendesk is used as a destination. Contents object The object speciﬁed in the Zendesk ﬂow destination. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes errorHandlingConﬁg The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the ﬂow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details. Type: ErrorHandlingConﬁg object Required: No idFieldNames A list of ﬁeld names that can be used as an ID ﬁeld when performing a write operation. Type: Array of strings Array Members: Minimum number of 0 items. Length Constraints: Maximum length of 128. Pattern: \S+ Required: No ZendeskDestinationProperties API Version 2020-08-23 495 AmazonAppFlow writeOperationType API Reference The possible write operations in the destination connector. When this value is not provided, this defaults to the INSERT operation. Type: String Valid Values: INSERT \| UPSERT \| UPDATE \| DELETE Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-08-23 496 API Reference AmazonAppFlow ZendeskMetadata The connector metadata speciﬁc to Zendesk. Contents oAuthScopes The desired authorization scope for the Zendesk account. Type: Array of strings Length Constraints: Maximum length of 128. Pattern: \S+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ZendeskMetadata API Version 2020-08-23 497 AmazonAppFlow API Reference ZendeskSourceProperties The properties that are applied when using Zendesk as a ﬂow source. Contents object The object speciﬁed in the Zendesk ﬂow source. Type: String Length Constraints: Maximum length of 512. Pattern: \S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ZendeskSourceProperties API Version 2020-08-23 498 AmazonAppFlow API Reference Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-speciﬁc parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. API Version 2020-08-23 499 AmazonAppFlow API Reference For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is speciﬁed in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Elements of an AWS API request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS
amazon-appflow-api-075	amazon-appflow-api.pdf	75	X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is speciﬁed in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Elements of an AWS API request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Speciﬁes the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. API Version 2020-08-23 500 AmazonAppFlow Type: string Required: Conditional X-Amz-SignedHeaders API Reference Speciﬁes all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional API Version 2020-08-23 501 AmazonAppFlow API Reference Common Errors This section lists the errors common to the API actions of all AWS services. For errors speciﬁc to an API action for this service, see the topic for that API action. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 ExpiredTokenException The security token included in the request is expired HTTP Status Code: 403 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 403 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 MalformedHttpRequestException Problems with the request at the HTTP level, e.g. we can't decompress the body according to the decompression algorithm speciﬁed by the content-encoding. HTTP Status Code: 400 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 401 OptInRequired The AWS access key ID needs a subscription for the service. API Version 2020-08-23 502 AmazonAppFlow HTTP Status Code: 403 RequestAbortedException API Reference Convenient exception that can be used when a request is aborted before a reply is sent back (e.g. client closed connection). HTTP Status Code: 400 RequestEntityTooLargeException Problems with the request at the HTTP level. The request entity is too large. HTTP Status Code: 413 RequestExpired The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 RequestTimeoutException Problems with the request at the HTTP level. Reading the Request timed out. HTTP Status Code: 408 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 UnrecognizedClientException The X.509 certiﬁcate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 API Version 2020-08-23 503 AmazonAppFlow UnknownOperationException API Reference The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 404 ValidationError The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 API Version 2020-08-23 504
amazon-braket-api-001	amazon-braket-api.pdf	1	API Reference Amazon Braket API Version 2019-09-01 Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon Braket API Reference Amazon Braket: API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. Amazon Braket Table of Contents API Reference Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 2 CancelJob ....................................................................................................................................................... 3 Request Syntax ........................................................................................................................................ 3 URI Request Parameters ........................................................................................................................ 3 Request Body ........................................................................................................................................... 3 Response Syntax ...................................................................................................................................... 3 Response Elements ................................................................................................................................. 3 Errors .......................................................................................................................................................... 4 See Also ..................................................................................................................................................... 5 CancelQuantumTask ..................................................................................................................................... 6 Request Syntax ........................................................................................................................................ 6 URI Request Parameters ........................................................................................................................ 6 Request Body ........................................................................................................................................... 6 Response Syntax ...................................................................................................................................... 7 Response Elements ................................................................................................................................. 7 Errors .......................................................................................................................................................... 7 See Also ..................................................................................................................................................... 8 CreateJob ..................................................................................................................................................... 10 Request Syntax ...................................................................................................................................... 10 URI Request Parameters ...................................................................................................................... 11 Request Body ......................................................................................................................................... 11 Response Syntax ................................................................................................................................... 14 Response Elements ............................................................................................................................... 14 Errors ....................................................................................................................................................... 15 See Also .................................................................................................................................................. 16 CreateQuantumTask .................................................................................................................................. 17 Request Syntax ...................................................................................................................................... 17 URI Request Parameters ...................................................................................................................... 17 Request Body ......................................................................................................................................... 17 Response Syntax ................................................................................................................................... 19 Response Elements ............................................................................................................................... 20 Errors ....................................................................................................................................................... 20 See Also .................................................................................................................................................. 21 API Version 2019-09-01 iii Amazon Braket API Reference GetDevice ..................................................................................................................................................... 22 Request Syntax ...................................................................................................................................... 22 URI Request Parameters ...................................................................................................................... 22 Request Body ......................................................................................................................................... 22 Response Syntax ................................................................................................................................... 22 Response Elements ............................................................................................................................... 23 Errors ....................................................................................................................................................... 24 Examples ................................................................................................................................................. 25 See Also .................................................................................................................................................. 26 GetJob ........................................................................................................................................................... 28 Request Syntax ...................................................................................................................................... 28 URI Request Parameters ...................................................................................................................... 28 Request Body ......................................................................................................................................... 28 Response Syntax ................................................................................................................................... 28 Response Elements ............................................................................................................................... 30 Errors ....................................................................................................................................................... 34 See Also .................................................................................................................................................. 34 GetQuantumTask ........................................................................................................................................ 36 Request Syntax ...................................................................................................................................... 36 URI Request Parameters ...................................................................................................................... 36 Request Body ......................................................................................................................................... 36 Response Syntax ................................................................................................................................... 36 Response Elements ............................................................................................................................... 37 Errors ....................................................................................................................................................... 39 See Also .................................................................................................................................................. 40 ListTagsForResource ................................................................................................................................... 41 Request Syntax ...................................................................................................................................... 41 URI Request Parameters ...................................................................................................................... 41 Request Body ......................................................................................................................................... 41 Response Syntax ................................................................................................................................... 41 Response Elements ............................................................................................................................... 41 Errors ....................................................................................................................................................... 42 See Also .................................................................................................................................................. 42 SearchDevices .............................................................................................................................................. 44 Request Syntax ...................................................................................................................................... 44 URI Request Parameters ...................................................................................................................... 44 API Version 2019-09-01 iv Amazon Braket API Reference Request Body ......................................................................................................................................... 44 Response Syntax ................................................................................................................................... 45 Response Elements ............................................................................................................................... 45 Errors ....................................................................................................................................................... 46 See Also .................................................................................................................................................. 46 SearchJobs ................................................................................................................................................... 48 Request Syntax ...................................................................................................................................... 48 URI Request Parameters ...................................................................................................................... 48 Request Body ......................................................................................................................................... 48 Response Syntax ................................................................................................................................... 49 Response Elements ............................................................................................................................... 49 Errors ....................................................................................................................................................... 50 See Also .................................................................................................................................................. 50 SearchQuantumTasks ................................................................................................................................ 52 Request Syntax ...................................................................................................................................... 52 URI Request Parameters ...................................................................................................................... 52 Request Body ......................................................................................................................................... 52 Response Syntax ................................................................................................................................... 53 Response Elements ............................................................................................................................... 53 Errors ....................................................................................................................................................... 54 See Also .................................................................................................................................................. 54 TagResource ................................................................................................................................................. 56 Request Syntax ...................................................................................................................................... 56 URI Request Parameters ...................................................................................................................... 56 Request Body ......................................................................................................................................... 56 Response Syntax ................................................................................................................................... 56 Response Elements ............................................................................................................................... 57 Errors ....................................................................................................................................................... 57 See Also .................................................................................................................................................. 57 UntagResource ............................................................................................................................................ 59 Request Syntax ...................................................................................................................................... 59 URI Request Parameters ...................................................................................................................... 59 Request Body ......................................................................................................................................... 59 Response Syntax ................................................................................................................................... 59 Response Elements ............................................................................................................................... 59 Errors ....................................................................................................................................................... 59 API Version 2019-09-01 v Amazon Braket API Reference See Also .................................................................................................................................................. 60 Data Types ..................................................................................................................................... 61 AlgorithmSpeciﬁcation .............................................................................................................................. 63 Contents .................................................................................................................................................. 63 See Also .................................................................................................................................................. 63 Association ................................................................................................................................................... 64 Contents .................................................................................................................................................. 64 See Also .................................................................................................................................................. 64 ContainerImage ........................................................................................................................................... 65 Contents .................................................................................................................................................. 65 See Also .................................................................................................................................................. 65 DataSource ................................................................................................................................................... 66 Contents .................................................................................................................................................. 66 See Also .................................................................................................................................................. 66 DeviceConﬁg ................................................................................................................................................ 67 Contents .................................................................................................................................................. 67 See Also .................................................................................................................................................. 67 DeviceQueueInfo ........................................................................................................................................ 68 Contents .................................................................................................................................................. 68 See Also .................................................................................................................................................. 68 DeviceSummary .......................................................................................................................................... 70 Contents .................................................................................................................................................. 70 See Also .................................................................................................................................................. 71 HybridJobQueueInfo .................................................................................................................................. 72 Contents .................................................................................................................................................. 72 See Also .................................................................................................................................................. 72 InputFileConﬁg ............................................................................................................................................ 74 Contents .................................................................................................................................................. 74 See Also .................................................................................................................................................. 74 InstanceConﬁg ............................................................................................................................................ 76 Contents .................................................................................................................................................. 76 See Also .................................................................................................................................................. 77 JobCheckpointConﬁg ................................................................................................................................. 78 Contents .................................................................................................................................................. 78 See Also .................................................................................................................................................. 78 JobEventDetails .......................................................................................................................................... 79 API Version 2019-09-01 vi Amazon Braket API Reference Contents .................................................................................................................................................. 79 See Also .................................................................................................................................................. 79 JobOutputDataConﬁg ............................................................................................................................... 81 Contents .................................................................................................................................................. 81 See Also .................................................................................................................................................. 81 JobStoppingCondition ............................................................................................................................... 82 Contents .................................................................................................................................................. 82 See Also .................................................................................................................................................. 82 JobSummary ................................................................................................................................................ 83 Contents .................................................................................................................................................. 83 See Also .................................................................................................................................................. 84 QuantumTaskQueueInfo ........................................................................................................................... 85 Contents .................................................................................................................................................. 85 See Also .................................................................................................................................................. 86 QuantumTaskSummary ............................................................................................................................. 87 Contents .................................................................................................................................................. 87 See Also .................................................................................................................................................. 88 S3DataSource .............................................................................................................................................. 90 Contents .................................................................................................................................................. 90 See Also .................................................................................................................................................. 90 ScriptModeConﬁg ....................................................................................................................................... 91 Contents .................................................................................................................................................. 91 See Also .................................................................................................................................................. 91 SearchDevicesFilter .................................................................................................................................... 93 Contents .................................................................................................................................................. 93 See Also .................................................................................................................................................. 93 SearchJobsFilter .......................................................................................................................................... 94 Contents .................................................................................................................................................. 94 See Also .................................................................................................................................................. 94 SearchQuantumTasksFilter ....................................................................................................................... 96 Contents .................................................................................................................................................. 96 See Also .................................................................................................................................................. 96 Common Parameters ..................................................................................................................... 98 Common Errors ............................................................................................................................ 101 API Version 2019-09-01 vii Amazon Braket Welcome API
amazon-braket-api-002	amazon-braket-api.pdf	2	See Also .................................................................................................................................................. 82 JobSummary ................................................................................................................................................ 83 Contents .................................................................................................................................................. 83 See Also .................................................................................................................................................. 84 QuantumTaskQueueInfo ........................................................................................................................... 85 Contents .................................................................................................................................................. 85 See Also .................................................................................................................................................. 86 QuantumTaskSummary ............................................................................................................................. 87 Contents .................................................................................................................................................. 87 See Also .................................................................................................................................................. 88 S3DataSource .............................................................................................................................................. 90 Contents .................................................................................................................................................. 90 See Also .................................................................................................................................................. 90 ScriptModeConﬁg ....................................................................................................................................... 91 Contents .................................................................................................................................................. 91 See Also .................................................................................................................................................. 91 SearchDevicesFilter .................................................................................................................................... 93 Contents .................................................................................................................................................. 93 See Also .................................................................................................................................................. 93 SearchJobsFilter .......................................................................................................................................... 94 Contents .................................................................................................................................................. 94 See Also .................................................................................................................................................. 94 SearchQuantumTasksFilter ....................................................................................................................... 96 Contents .................................................................................................................................................. 96 See Also .................................................................................................................................................. 96 Common Parameters ..................................................................................................................... 98 Common Errors ............................................................................................................................ 101 API Version 2019-09-01 vii Amazon Braket Welcome API Reference The Amazon Braket API Reference provides information about the operations and structures supported by Amazon Braket. To learn about the permissions required to call an Amazon Braket API action, see Actions, resources, and condition keys for Amazon Braket. Amazon Braket Python SDK and the AWS Command Line Interface can be used to make discovery and creation of API calls easier. For more information about Amazon Braket features, see What is Amazon Braket? and important terms and concepts in the Amazon Braket Developer Guide. In this guide: • Actions • Data Types • Common Parameters • Common Errors Available languages for AWS SDK: • .NET • C++ • Go API reference • Java • JavaScript • PHP • Python (Boto) • Ruby Code examples from the Amazon Braket Tutorials GitHub repository: • Amazon Braket Examples This document was last published on May 14, 2025. API Version 2019-09-01 1 Amazon Braket Actions The following actions are supported: • CancelJob • CancelQuantumTask • CreateJob • CreateQuantumTask • GetDevice • GetJob • GetQuantumTask • ListTagsForResource • SearchDevices • SearchJobs • SearchQuantumTasks • TagResource • UntagResource API Reference API Version 2019-09-01 2 API Reference Amazon Braket CancelJob Cancels an Amazon Braket hybrid job. Request Syntax PUT /job/jobArn/cancel HTTP/1.1 URI Request Parameters The request uses the following URI parameters. jobArn The ARN of the Amazon Braket hybrid job to cancel. Pattern: ^arn:aws[a-z\-]:braket:[a-z0-9\-]+:[0-9]{12}:job/.$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "cancellationStatus": "string", "jobArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CancelJob API Version 2019-09-01 3 API Reference Amazon Braket cancellationStatus The status of the hybrid job. Type: String Valid Values: CANCELLING \| CANCELLED jobArn The ARN of the Amazon Braket job. Type: String Pattern: ^arn:aws[a-z\-]:braket:[a-z0-9\-]+:[0-9]{12}:job/.$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient permissions to perform this action. HTTP Status Code: 403 ConﬂictException An error occurred due to a conﬂict. HTTP Status Code: 409 InternalServiceException The request failed because of an unknown error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource was not found. HTTP Status Code: 404 ThrottlingException The API throttling rate limit is exceeded. Errors API Version 2019-09-01 4 Amazon Braket HTTP Status Code: 429 ValidationException API Reference The input request failed to satisfy constraints expected by Amazon Braket. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2019-09-01 5 Amazon Braket API Reference CancelQuantumTask Cancels the speciﬁed task. Request Syntax PUT /quantum-task/quantumTaskArn/cancel HTTP/1.1 Content-type: application/json { "clientToken": "string" } URI Request Parameters The request uses the following URI parameters. quantumTaskArn The ARN of the quantum task to cancel. Length Constraints: Minimum length of 0. Maximum length of 256. Required: Yes Request Body The request accepts the following data in JSON format. clientToken The client token associated with the cancellation request. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes CancelQuantumTask API Version 2019-09-01 6 API Reference Amazon Braket Response Syntax HTTP/1.1 200 Content-type: application/json { "cancellationStatus": "string", "quantumTaskArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. cancellationStatus The status of the quantum task. Type: String Valid Values: CANCELLING \| CANCELLED quantumTaskArn The ARN of the quantum task. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient permissions to perform this action. HTTP Status Code: 403 Response Syntax API Version 2019-09-01 7 API Reference Amazon Braket
amazon-braket-api-003	amazon-braket-api.pdf	3	} Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. cancellationStatus The status of the quantum task. Type: String Valid Values: CANCELLING \| CANCELLED quantumTaskArn The ARN of the quantum task. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient permissions to perform this action. HTTP Status Code: 403 Response Syntax API Version 2019-09-01 7 API Reference Amazon Braket ConﬂictException An error occurred due to a conﬂict. HTTP Status Code: 409 InternalServiceException The request failed because of an unknown error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource was not found. HTTP Status Code: 404 ThrottlingException The API throttling rate limit is exceeded. HTTP Status Code: 429 ValidationException The input request failed to satisfy constraints expected by Amazon Braket. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2019-09-01 8 Amazon Braket • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2019-09-01 9 API Reference Amazon Braket CreateJob Creates an Amazon Braket hybrid job. Request Syntax POST /job HTTP/1.1 Content-type: application/json { "algorithmSpecification": { "containerImage": { "uri": "string" }, "scriptModeConfig": { "compressionType": "string", "entryPoint": "string", "s3Uri": "string" } }, "associations": [ { "arn": "string", "type": "string" } ], "checkpointConfig": { "localPath": "string", "s3Uri": "string" }, "clientToken": "string", "deviceConfig": { "device": "string" }, "hyperParameters": { "string" : "string" }, "inputDataConfig": [ { "channelName": "string", "contentType": "string", "dataSource": { "s3DataSource": { CreateJob API Version 2019-09-01 10 Amazon Braket API Reference "s3Uri": "string" } } } ], "instanceConfig": { "instanceCount": number, "instanceType": "string", "volumeSizeInGb": number }, "jobName": "string", "outputDataConfig": { "kmsKeyId": "string", "s3Path": "string" }, "roleArn": "string", "stoppingCondition": { "maxRuntimeInSeconds": number }, "tags": { "string" : "string" } } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. algorithmSpeciﬁcation Deﬁnition of the Amazon Braket job to be created. Speciﬁes the container image the job uses and information about the Python scripts used for entry and training. Type: AlgorithmSpeciﬁcation object Required: Yes associations The list of Amazon Braket resources associated with the hybrid job. URI Request Parameters API Version 2019-09-01 11 Amazon Braket API Reference Type: Array of Association objects Array Members: Minimum number of 0 items. Maximum number of 1 item. Required: No checkpointConﬁg Information about the output locations for hybrid job checkpoint data. Type: JobCheckpointConﬁg object Required: No clientToken The client token associated with this request that guarantees that the request is idempotent. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes deviceConﬁg The quantum processing unit (QPU) or simulator used to create an Amazon Braket hybrid job. Type: DeviceConﬁg object Required: Yes hyperParameters Algorithm-speciﬁc parameters used by an Amazon Braket hybrid job that inﬂuence the quality of the training job. The values are set with a map of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of the hyperparameter. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 100 items. Key Length Constraints: Minimum length of 1. Maximum length of 256. Value Length Constraints: Minimum length of 1. Maximum length of 2500. Value Pattern: ^.$ Request Body API Version 2019-09-01 12 Amazon Braket Required: No inputDataConﬁg API Reference A list of parameters that specify the name and type of input data and where it is located. Type: Array of InputFileConﬁg objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No instanceConﬁg Conﬁguration of the resource instances to use while running the hybrid job on Amazon Braket. Type: InstanceConﬁg object Required: Yes jobName The name of the Amazon Braket hybrid job. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: ^[a-zA-Z0-9](-[a-zA-Z0-9]){0,50}$ Required: Yes outputDataConﬁg The path to the S3 location where you want to store hybrid job artifacts and the encryption key used to store them. Type: JobOutputDataConﬁg object Required: Yes roleArn The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output results and hybrid job details to the
amazon-braket-api-004	amazon-braket-api.pdf	4	jobName The name of the Amazon Braket hybrid job. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: ^[a-zA-Z0-9](-[a-zA-Z0-9]){0,50}$ Required: Yes outputDataConﬁg The path to the S3 location where you want to store hybrid job artifacts and the encryption key used to store them. Type: JobOutputDataConﬁg object Required: Yes roleArn The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output results and hybrid job details to the users' s3 buckets. Request Body API Version 2019-09-01 13 Amazon Braket Type: String API Reference Pattern: ^arn:aws[a-z\-]:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ Required: Yes stoppingCondition The user-deﬁned criteria that speciﬁes when a hybrid job stops running. Type: JobStoppingCondition object Required: No tags Tags to be added to the hybrid job you're creating. Type: String to string map Required: No Response Syntax HTTP/1.1 201 Content-type: application/json { "jobArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. jobArn The ARN of the Amazon Braket hybrid job created. Type: String Response Syntax API Version 2019-09-01 14 Amazon Braket API Reference Pattern: ^arn:aws[a-z\-]:braket:[a-z0-9\-]+:[0-9]{12}:job/.$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient permissions to perform this action. HTTP Status Code: 403 ConﬂictException An error occurred due to a conﬂict. HTTP Status Code: 409 DeviceOﬄineException The speciﬁed device is currently oﬄine. HTTP Status Code: 424 DeviceRetiredException The speciﬁed device has been retired. HTTP Status Code: 410 InternalServiceException The request failed because of an unknown error. HTTP Status Code: 500 ServiceQuotaExceededException The request failed because a service quota is exceeded. HTTP Status Code: 402 ThrottlingException The API throttling rate limit is exceeded. HTTP Status Code: 429 Errors API Version 2019-09-01 15 Amazon Braket ValidationException API Reference The input request failed to satisfy constraints expected by Amazon Braket. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2019-09-01 16 Amazon Braket API Reference CreateQuantumTask Creates a quantum task. Request Syntax POST /quantum-task HTTP/1.1 Content-type: application/json { "action": "string", "associations": [ { "arn": "string", "type": "string" } ], "clientToken": "string", "deviceArn": "string", "deviceParameters": "string", "jobToken": "string", "outputS3Bucket": "string", "outputS3KeyPrefix": "string", "shots": number, "tags": { "string" : "string" } } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. action The action associated with the quantum task. Type: String CreateQuantumTask API Version 2019-09-01 17 Amazon Braket Required: Yes associations API Reference The list of Amazon Braket resources associated with the quantum task. Type: Array of Association objects Array Members: Minimum number of 0 items. Maximum number of 1 item. Required: No clientToken The client token associated with the request. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes deviceArn The ARN of the device to run the quantum task on. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes deviceParameters The parameters for the device to run the quantum task on. Type: String Length Constraints: Minimum length of 1. Maximum length of 48000. Required: No jobToken The token for an Amazon Braket hybrid job that associates it with the quantum task. Type: String Request Body API Version 2019-09-01 18 Amazon Braket API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Required: No outputS3Bucket The S3 bucket to store quantum task result ﬁles in. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Required: Yes outputS3KeyPreﬁx The key preﬁx for the location in the S3 bucket to store quantum task results in. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: Yes shots The number of shots to use for the quantum task. Type: Long Valid Range: Minimum value of 0. Required: Yes tags Tags to be added to the quantum task you're creating. Type: String to string map Required: No Response Syntax HTTP/1.1 201 Content-type: application/json Response Syntax API Version 2019-09-01 19 Amazon Braket API Reference { "quantumTaskArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service.
amazon-braket-api-005	amazon-braket-api.pdf	5	in. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: Yes shots The number of shots to use for the quantum task. Type: Long Valid Range: Minimum value of 0. Required: Yes tags Tags to be added to the quantum task you're creating. Type: String to string map Required: No Response Syntax HTTP/1.1 201 Content-type: application/json Response Syntax API Version 2019-09-01 19 Amazon Braket API Reference { "quantumTaskArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. quantumTaskArn The ARN of the quantum task created by the request. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient permissions to perform this action. HTTP Status Code: 403 DeviceOﬄineException The speciﬁed device is currently oﬄine. HTTP Status Code: 424 DeviceRetiredException The speciﬁed device has been retired. HTTP Status Code: 410 InternalServiceException The request failed because of an unknown error. Response Elements API Version 2019-09-01 20 Amazon Braket API Reference HTTP Status Code: 500 ServiceQuotaExceededException The request failed because a service quota is exceeded. HTTP Status Code: 402 ThrottlingException The API throttling rate limit is exceeded. HTTP Status Code: 429 ValidationException The input request failed to satisfy constraints expected by Amazon Braket. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2019-09-01 21 Amazon Braket GetDevice Retrieves the devices available in Amazon Braket. API Reference Note For backwards compatibility with older versions of BraketSchemas, OpenQASM information is omitted from GetDevice API calls. To get this information the user-agent needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK automatically reports this for you. If you do not see OpenQASM results in the GetDevice response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment variable to conﬁgure user-agent. See the code examples provided below for how to do this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs. Request Syntax GET /device/deviceArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. deviceArn The ARN of the device to retrieve. Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json GetDevice API Version 2019-09-01 22 Amazon Braket API Reference { "deviceArn": "string", "deviceCapabilities": "string", "deviceName": "string", "deviceQueueInfo": [ { "queue": "string", "queuePriority": "string", "queueSize": "string" } ], "deviceStatus": "string", "deviceType": "string", "providerName": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. deviceArn The ARN of the device. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. deviceCapabilities Details about the capabilities of the device. Type: String deviceName The name of the device. Type: String deviceQueueInfo The number of quantum tasks and hybrid jobs currently queued on the device. Response Elements API Version 2019-09-01 23 Amazon Braket API Reference Type: Array of DeviceQueueInfo objects deviceStatus The status of the device. Type: String Valid Values: ONLINE \| OFFLINE \| RETIRED deviceType The type of the device. Type: String Valid Values: QPU \| SIMULATOR providerName The name of the partner company for the device. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient permissions to perform this action. HTTP Status Code: 403 InternalServiceException The request failed because of an unknown error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource was not found. HTTP Status Code: 404 Errors API Version 2019-09-01 24 Amazon Braket ThrottlingException The API throttling rate limit is exceeded. HTTP Status Code: 429 ValidationException The input request failed to satisfy constraints expected by Amazon Braket. API Reference HTTP Status Code: 400 Examples Example To set AWS_EXECUTION_ENV environment variable to conﬁgure user-agent when using the AWS CLI SDK: % export AWS_EXECUTION_ENV="aws-cli BraketSchemas/1.8.0" # Or for single execution % AWS_EXECUTION_ENV="aws-cli BraketSchemas/1.8.0" aws braket <cmd> [options] Example To set AWS_EXECUTION_ENV environment variable to conﬁgure user-agent when using the Boto3: import boto3 import botocore client = boto3.client("braket", config=botocore.client.Config(user_agent_extra="BraketSchemas/1.8.0")) Example To set AWS_EXECUTION_ENV environment variable to conﬁgure user-agent when using the JavaScript/TypeScript (SDK v2):
amazon-braket-api-006	amazon-braket-api.pdf	6	Amazon Braket ThrottlingException The API throttling rate limit is exceeded. HTTP Status Code: 429 ValidationException The input request failed to satisfy constraints expected by Amazon Braket. API Reference HTTP Status Code: 400 Examples Example To set AWS_EXECUTION_ENV environment variable to conﬁgure user-agent when using the AWS CLI SDK: % export AWS_EXECUTION_ENV="aws-cli BraketSchemas/1.8.0" # Or for single execution % AWS_EXECUTION_ENV="aws-cli BraketSchemas/1.8.0" aws braket <cmd> [options] Example To set AWS_EXECUTION_ENV environment variable to conﬁgure user-agent when using the Boto3: import boto3 import botocore client = boto3.client("braket", config=botocore.client.Config(user_agent_extra="BraketSchemas/1.8.0")) Example To set AWS_EXECUTION_ENV environment variable to conﬁgure user-agent when using the JavaScript/TypeScript (SDK v2): import Braket from 'aws-sdk/clients/braket'; const client = new Braket({ region: 'us-west-2', credentials: AWS_CREDENTIALS, customUserAgent: 'BraketSchemas/1.8.0' }); Examples API Version 2019-09-01 25 Amazon Braket Example API Reference To set AWS_EXECUTION_ENV environment variable to conﬁgure user-agent when using the JavaScript/TypeScript (SDK v3): import { Braket } from '@aws-sdk/client-braket'; const client = new Braket({ region: 'us-west-2', credentials: AWS_CREDENTIALS, customUserAgent: 'BraketSchemas/1.8.0' }); Example To set AWS_EXECUTION_ENV environment variable to conﬁgure user-agent when using the Go SDK: os.Setenv("AWS_EXECUTION_ENV", "BraketGo BraketSchemas/1.8.0") mySession := session.Must(session.NewSession()) svc := braket.New(mySession) Example To set AWS_EXECUTION_ENV environment variable to conﬁgure user-agent when using the Java SDK: ClientConfiguration config = new ClientConfiguration(); config.setUserAgentSuffix("BraketSchemas/1.8.0"); BraketClient braketClient = BraketClientBuilder.standard().withClientConfiguration(config).build(); See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 See Also API Version 2019-09-01 26 Amazon Braket • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2019-09-01 27 Amazon Braket GetJob Retrieves the speciﬁed Amazon Braket hybrid job. Request Syntax API Reference GET /job/jobArn?additionalAttributeNames=additionalAttributeNames HTTP/1.1 URI Request Parameters The request uses the following URI parameters. additionalAttributeNames A list of attributes to return additional information for. Only the QueueInfo additional attribute name is currently supported. Valid Values: QueueInfo jobArn The ARN of the hybrid job to retrieve. Pattern: ^arn:aws[a-z\-]:braket:[a-z0-9\-]+:[0-9]{12}:job/.$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "algorithmSpecification": { "containerImage": { "uri": "string" }, "scriptModeConfig": { GetJob API Version 2019-09-01 28 Amazon Braket API Reference "compressionType": "string", "entryPoint": "string", "s3Uri": "string" } }, "associations": [ { "arn": "string", "type": "string" } ], "billableDuration": number, "checkpointConfig": { "localPath": "string", "s3Uri": "string" }, "createdAt": "string", "deviceConfig": { "device": "string" }, "endedAt": "string", "events": [ { "eventType": "string", "message": "string", "timeOfEvent": "string" } ], "failureReason": "string", "hyperParameters": { "string" : "string" }, "inputDataConfig": [ { "channelName": "string", "contentType": "string", "dataSource": { "s3DataSource": { "s3Uri": "string" } } } ], "instanceConfig": { Response Syntax API Version 2019-09-01 29 Amazon Braket API Reference "instanceCount": number, "instanceType": "string", "volumeSizeInGb": number }, "jobArn": "string", "jobName": "string", "outputDataConfig": { "kmsKeyId": "string", "s3Path": "string" }, "queueInfo": { "message": "string", "position": "string", "queue": "string" }, "roleArn": "string", "startedAt": "string", "status": "string", "stoppingCondition": { "maxRuntimeInSeconds": number }, "tags": { "string" : "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. algorithmSpeciﬁcation Deﬁnition of the Amazon Braket hybrid job created. Provides information about the container image used, and the Python scripts used for training. Type: AlgorithmSpeciﬁcation object associations The list of Amazon Braket resources associated with the hybrid job. Type: Array of Association objects Response Elements API Version 2019-09-01 30 Amazon Braket billableDuration API Reference The billable time for which the Amazon Braket hybrid job used to complete. Type: Integer checkpointConﬁg Information about the output locations for hybrid job checkpoint data. Type: JobCheckpointConﬁg object createdAt The time at which the Amazon Braket hybrid job was created. Type: Timestamp deviceConﬁg The primary device used by the Amazon Braket hybrid job. Type: DeviceConﬁg object endedAt The time at which the Amazon Braket hybrid job ended. Type: Timestamp events Details about the time and type of events occurred related to the Amazon Braket hybrid job. Type: Array of JobEventDetails objects Array Members: Minimum number of 0 items. Maximum number of 20 items. failureReason A description of the reason why an Amazon Braket hybrid job failed, if it failed. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Response Elements API Version 2019-09-01 31 Amazon Braket hyperParameters API Reference Algorithm-speciﬁc parameters used by an Amazon Braket hybrid job that inﬂuence the quality of the traiing job. The values are set with a map of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter. Type: String to string map Map Entries: Minimum number of 0
amazon-braket-api-007	amazon-braket-api.pdf	7	number of 20 items. failureReason A description of the reason why an Amazon Braket hybrid job failed, if it failed. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Response Elements API Version 2019-09-01 31 Amazon Braket hyperParameters API Reference Algorithm-speciﬁc parameters used by an Amazon Braket hybrid job that inﬂuence the quality of the traiing job. The values are set with a map of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 100 items. Key Length Constraints: Minimum length of 1. Maximum length of 256. Value Length Constraints: Minimum length of 1. Maximum length of 2500. Value Pattern: ^.$ inputDataConﬁg A list of parameters that specify the name and type of input data and where it is located. Type: Array of InputFileConﬁg objects instanceConﬁg The resource instances to use while running the hybrid job on Amazon Braket. Type: InstanceConﬁg object jobArn The ARN of the Amazon Braket hybrid job. Type: String Pattern: ^arn:aws[a-z\-]:braket:[a-z0-9\-]+:[0-9]{12}:job/.$ jobName The name of the Amazon Braket hybrid job. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: ^[a-zA-Z0-9](-[a-zA-Z0-9]){0,50}$ Response Elements API Version 2019-09-01 32 Amazon Braket outputDataConﬁg API Reference The path to the S3 location where hybrid job artifacts are stored and the encryption key used to store them there. Type: JobOutputDataConﬁg object queueInfo Queue information for the requested hybrid job. Only returned if QueueInfo is speciﬁed in the additionalAttributeNames" ﬁeld in the GetJob API request. Type: HybridJobQueueInfo object roleArn The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output results and other hybrid job details to the s3 buckets of a user. Type: String Pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ startedAt The time at which the Amazon Braket hybrid job was started. Type: Timestamp status The status of the Amazon Braket hybrid job. Type: String Valid Values: QUEUED \| RUNNING \| COMPLETED \| FAILED \| CANCELLING \| CANCELLED stoppingCondition The user-deﬁned criteria that speciﬁes when to stop a running hybrid job. Type: JobStoppingCondition object tags The tags associated with this hybrid job. Response Elements API Version 2019-09-01 33 Amazon Braket Type: String to string map Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient permissions to perform this action. HTTP Status Code: 403 InternalServiceException The request failed because of an unknown error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource was not found. HTTP Status Code: 404 ThrottlingException The API throttling rate limit is exceeded. HTTP Status Code: 429 ValidationException The input request failed to satisfy constraints expected by Amazon Braket. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Errors API Version 2019-09-01 34 API Reference Amazon Braket • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2019-09-01 35 Amazon Braket GetQuantumTask Retrieves the speciﬁed quantum task. Request Syntax API Reference GET /quantum-task/quantumTaskArn?additionalAttributeNames=additionalAttributeNames HTTP/1.1 URI Request Parameters The request uses the following URI parameters. additionalAttributeNames A list of attributes to return additional information for. Only the QueueInfo additional attribute name is currently supported. Valid Values: QueueInfo quantumTaskArn The ARN of the quantum task to retrieve. Length Constraints: Minimum length of 0. Maximum length of 256. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "associations": [ GetQuantumTask API Version 2019-09-01 36 API Reference Amazon Braket { "arn": "string", "type": "string" } ], "createdAt": "string", "deviceArn": "string", "deviceParameters": "string", "endedAt": "string", "failureReason": "string", "jobArn": "string", "outputS3Bucket": "string", "outputS3Directory": "string", "quantumTaskArn": "string", "queueInfo": { "message": "string", "position": "string", "queue": "string", "queuePriority": "string" }, "shots": number, "status": "string", "tags": { "string" : "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. associations The list of Amazon Braket resources associated with the quantum task. Type: Array of Association objects createdAt The time at which the quantum task was created. Type: Timestamp Response Elements API Version 2019-09-01 37 Amazon Braket deviceArn API Reference The ARN of the device the quantum task was run on. Type: String Length Constraints: Minimum length
amazon-braket-api-008	amazon-braket-api.pdf	8	"string", "queue": "string", "queuePriority": "string" }, "shots": number, "status": "string", "tags": { "string" : "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. associations The list of Amazon Braket resources associated with the quantum task. Type: Array of Association objects createdAt The time at which the quantum task was created. Type: Timestamp Response Elements API Version 2019-09-01 37 Amazon Braket deviceArn API Reference The ARN of the device the quantum task was run on. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. deviceParameters The parameters for the device on which the quantum task ran. Type: String endedAt The time at which the quantum task ended. Type: Timestamp failureReason The reason that a quantum task failed. Type: String jobArn The ARN of the Amazon Braket job associated with the quantum task. Type: String Pattern: ^arn:aws[a-z\-]:braket:[a-z0-9\-]+:[0-9]{12}:job/.$ outputS3Bucket The S3 bucket where quantum task results are stored. Type: String outputS3Directory The folder in the S3 bucket where quantum task results are stored. Type: String quantumTaskArn The ARN of the quantum task. Response Elements API Version 2019-09-01 38 Amazon Braket Type: String API Reference Length Constraints: Minimum length of 0. Maximum length of 256. queueInfo Queue information for the requested quantum task. Only returned if QueueInfo is speciﬁed in the additionalAttributeNames" ﬁeld in the GetQuantumTask API request. Type: QuantumTaskQueueInfo object shots The number of shots used in the quantum task. Type: Long status The status of the quantum task. Type: String Valid Values: CREATED \| QUEUED \| RUNNING \| COMPLETED \| FAILED \| CANCELLING \| CANCELLED tags The tags that belong to this quantum task. Type: String to string map Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient permissions to perform this action. HTTP Status Code: 403 InternalServiceException The request failed because of an unknown error. Errors API Version 2019-09-01 39 API Reference Amazon Braket HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource was not found. HTTP Status Code: 404 ThrottlingException The API throttling rate limit is exceeded. HTTP Status Code: 429 ValidationException The input request failed to satisfy constraints expected by Amazon Braket. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2019-09-01 40 Amazon Braket API Reference ListTagsForResource Shows the tags associated with this resource. Request Syntax GET /tags/resourceArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn Specify the resourceArn for the resource whose tags to display. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "tags": { "string" : "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ListTagsForResource API Version 2019-09-01 41 Amazon Braket tags API Reference Displays the key, value pairs of tags associated with this resource. Type: String to string map Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceException The request failed because of an unknown error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource was not found. HTTP Status Code: 404 ValidationException The input request failed to satisfy constraints expected by Amazon Braket. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin Errors API Version 2019-09-01 42 Amazon Braket • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2019-09-01 43 API Reference Amazon Braket SearchDevices Searches for devices using the speciﬁed ﬁlters. Request Syntax POST /devices HTTP/1.1 Content-type: application/json { "filters": [ { "name": "string", "values": [ "string" ] } ], "maxResults": number, "nextToken": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. ﬁlters Array of SearchDevicesFilter objects to use when searching for devices. Type: Array of SearchDevicesFilter objects Array Members: Minimum number of
amazon-braket-api-009	amazon-braket-api.pdf	9	PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2019-09-01 43 API Reference Amazon Braket SearchDevices Searches for devices using the speciﬁed ﬁlters. Request Syntax POST /devices HTTP/1.1 Content-type: application/json { "filters": [ { "name": "string", "values": [ "string" ] } ], "maxResults": number, "nextToken": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. ﬁlters Array of SearchDevicesFilter objects to use when searching for devices. Type: Array of SearchDevicesFilter objects Array Members: Minimum number of 0 items. Maximum number of 10 items. Required: Yes maxResults The maximum number of results to return in the response. Type: Integer SearchDevices API Version 2019-09-01 44 Amazon Braket API Reference Valid Range: Minimum value of 1. Maximum value of 100. Required: No nextToken A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended. Type: String Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "devices": [ { "deviceArn": "string", "deviceName": "string", "deviceStatus": "string", "deviceType": "string", "providerName": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. devices An array of DeviceSummary objects for devices that match the speciﬁed ﬁlter values. Type: Array of DeviceSummary objects Response Syntax API Version 2019-09-01 45 Amazon Braket nextToken API Reference A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue search where the previous request ended. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient permissions to perform this action. HTTP Status Code: 403 InternalServiceException The request failed because of an unknown error. HTTP Status Code: 500 ThrottlingException The API throttling rate limit is exceeded. HTTP Status Code: 429 ValidationException The input request failed to satisfy constraints expected by Amazon Braket. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Errors API Version 2019-09-01 46 API Reference Amazon Braket • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2019-09-01 47 Amazon Braket SearchJobs API Reference Searches for Amazon Braket hybrid jobs that match the speciﬁed ﬁlter values. Request Syntax POST /jobs HTTP/1.1 Content-type: application/json { "filters": [ { "name": "string", "operator": "string", "values": [ "string" ] } ], "maxResults": number, "nextToken": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. ﬁlters Array of SearchJobsFilter objects to use when searching for hybrid jobs. Type: Array of SearchJobsFilter objects Array Members: Minimum number of 0 items. Maximum number of 10 items. Required: Yes maxResults The maximum number of results to return in the response. SearchJobs API Version 2019-09-01 48 Amazon Braket Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. API Reference Required: No nextToken A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended. Type: String Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "jobs": [ { "createdAt": "string", "device": "string", "endedAt": "string", "jobArn": "string", "jobName": "string", "startedAt": "string", "status": "string", "tags": { "string" : "string" } } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2019-09-01 49 Amazon Braket jobs API Reference An array of JobSummary objects for devices that match the speciﬁed ﬁlter values. Type: Array of JobSummary objects nextToken A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue search where the previous request ended. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient permissions to perform this action. HTTP Status Code: 403 InternalServiceException The request failed because of an unknown error. HTTP Status Code: 500 ThrottlingException The API throttling rate limit is exceeded. HTTP Status Code: 429 ValidationException The input request failed to satisfy constraints expected by
amazon-braket-api-010	amazon-braket-api.pdf	10	objects nextToken A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue search where the previous request ended. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient permissions to perform this action. HTTP Status Code: 403 InternalServiceException The request failed because of an unknown error. HTTP Status Code: 500 ThrottlingException The API throttling rate limit is exceeded. HTTP Status Code: 429 ValidationException The input request failed to satisfy constraints expected by Amazon Braket. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Errors API Version 2019-09-01 50 API Reference Amazon Braket • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2019-09-01 51 Amazon Braket API Reference SearchQuantumTasks Searches for tasks that match the speciﬁed ﬁlter values. Request Syntax POST /quantum-tasks HTTP/1.1 Content-type: application/json { "filters": [ { "name": "string", "operator": "string", "values": [ "string" ] } ], "maxResults": number, "nextToken": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. ﬁlters Array of SearchQuantumTasksFilter objects to use when searching for quantum tasks. Type: Array of SearchQuantumTasksFilter objects Array Members: Minimum number of 0 items. Maximum number of 10 items. Required: Yes maxResults Maximum number of results to return in the response. Type: Integer SearchQuantumTasks API Version 2019-09-01 52 Amazon Braket API Reference Valid Range: Minimum value of 1. Maximum value of 100. Required: No nextToken A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended. Type: String Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "quantumTasks": [ { "createdAt": "string", "deviceArn": "string", "endedAt": "string", "outputS3Bucket": "string", "outputS3Directory": "string", "quantumTaskArn": "string", "shots": number, "status": "string", "tags": { "string" : "string" } } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2019-09-01 53 Amazon Braket nextToken API Reference A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue search where the previous request ended. Type: String quantumTasks An array of QuantumTaskSummary objects for quantum tasks that match the speciﬁed ﬁlters. Type: Array of QuantumTaskSummary objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient permissions to perform this action. HTTP Status Code: 403 InternalServiceException The request failed because of an unknown error. HTTP Status Code: 500 ThrottlingException The API throttling rate limit is exceeded. HTTP Status Code: 429 ValidationException The input request failed to satisfy constraints expected by Amazon Braket. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Errors API Version 2019-09-01 54 API Reference Amazon Braket • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2019-09-01 55 API Reference Amazon Braket TagResource Add a tag to the speciﬁed resource. Request Syntax POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. resourceArn Specify the resourceArn of the resource to which a tag will be added. Required: Yes Request Body The request accepts the following data in JSON format. tags Specify the tags to add to the resource. Tags can be speciﬁed as a key-value map. Type: String to string map Required: Yes Response Syntax HTTP/1.1 200 TagResource API Version 2019-09-01 56 Amazon Braket Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceException The request failed because of an unknown error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource was not found. HTTP Status Code: 404 ValidationException
amazon-braket-api-011	amazon-braket-api.pdf	11	in JSON format. tags Specify the tags to add to the resource. Tags can be speciﬁed as a key-value map. Type: String to string map Required: Yes Response Syntax HTTP/1.1 200 TagResource API Version 2019-09-01 56 Amazon Braket Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServiceException The request failed because of an unknown error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource was not found. HTTP Status Code: 404 ValidationException The input request failed to satisfy constraints expected by Amazon Braket. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python Response Elements API Version 2019-09-01 57 Amazon Braket • AWS SDK for Ruby V3 API Reference See Also API Version 2019-09-01 58 API Reference Amazon Braket UntagResource Remove tags from a resource. Request Syntax DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn Specify the resourceArn for the resource from which to remove the tags. Required: Yes tagKeys Specify the keys for the tags to remove from the resource. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. UntagResource API Version 2019-09-01 59 API Reference Amazon Braket InternalServiceException The request failed because of an unknown error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource was not found. HTTP Status Code: 404 ValidationException The input request failed to satisfy constraints expected by Amazon Braket. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2019-09-01 60 Amazon Braket Data Types API Reference The Braket API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • AlgorithmSpeciﬁcation • Association • ContainerImage • DataSource • DeviceConﬁg • DeviceQueueInfo • DeviceSummary • HybridJobQueueInfo • InputFileConﬁg • InstanceConﬁg • JobCheckpointConﬁg • JobEventDetails • JobOutputDataConﬁg • JobStoppingCondition • JobSummary • QuantumTaskQueueInfo • QuantumTaskSummary • S3DataSource • ScriptModeConﬁg • SearchDevicesFilter API Version 2019-09-01 61 Amazon Braket • SearchJobsFilter • SearchQuantumTasksFilter API Reference API Version 2019-09-01 62 Amazon Braket API Reference AlgorithmSpeciﬁcation Deﬁnes the Amazon Braket hybrid job to be created. Speciﬁes the container image the job uses and the paths to the Python scripts used for entry and training. Contents containerImage The container image used to create an Amazon Braket hybrid job. Type: ContainerImage object Required: No scriptModeConﬁg Conﬁgures the paths to the Python scripts used for entry and training. Type: ScriptModeConﬁg object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AlgorithmSpeciﬁcation API Version 2019-09-01 63 API Reference Amazon Braket Association The Amazon Braket resource and the association type. Contents arn The Amazon Braket resource arn. Type: String Pattern: ^arn:aws[a-z\-]:braket:[a-z0-9\-]:[0-9]{12}:.*$ Required: Yes type The association type for the speciﬁed Amazon Braket resource arn. Type: String Valid Values: RESERVATION_TIME_WINDOW_ARN Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Association API Version 2019-09-01 64 Amazon Braket ContainerImage The container image used to create an Amazon Braket hybrid job. API Reference Contents uri The URI locating the container image. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: \d{10,14}\.dkr\.ecr.[a-z0-9-]+\.amazonaws\.com\/.+(@sha256)?:.+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: •
amazon-braket-api-012	amazon-braket-api.pdf	12	Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Association API Version 2019-09-01 64 Amazon Braket ContainerImage The container image used to create an Amazon Braket hybrid job. API Reference Contents uri The URI locating the container image. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: \d{10,14}\.dkr\.ecr.[a-z0-9-]+\.amazonaws\.com\/.+(@sha256)?:.+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ContainerImage API Version 2019-09-01 65 Amazon Braket DataSource API Reference Information about the source of the input data used by the Amazon Braket hybrid job. Contents s3DataSource Amazon S3 path of the input data used by the hybrid job. Type: S3DataSource object Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DataSource API Version 2019-09-01 66 Amazon Braket DeviceConﬁg API Reference Conﬁgures the primary device used to create and run an Amazon Braket hybrid job. Contents device The primary device ARN used to create and run an Amazon Braket hybrid job. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DeviceConﬁg API Version 2019-09-01 67 Amazon Braket DeviceQueueInfo API Reference Information about quantum tasks and hybrid jobs queued on a device. Contents queue The name of the queue. Type: String Valid Values: QUANTUM_TASKS_QUEUE \| JOBS_QUEUE Required: Yes queueSize The number of hybrid jobs or quantum tasks in the queue for a given device. Type: String Required: Yes queuePriority Optional. Speciﬁes the priority of the queue. Quantum tasks in a priority queue are processed before the quantum tasks in a normal queue. Type: String Valid Values: Normal \| Priority Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 DeviceQueueInfo API Version 2019-09-01 68 Amazon Braket • AWS SDK for Ruby V3 API Reference See Also API Version 2019-09-01 69 API Reference Amazon Braket DeviceSummary Includes information about the device. Contents deviceArn The ARN of the device. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes deviceName The name of the device. Type: String Required: Yes deviceStatus The status of the device. Type: String Valid Values: ONLINE \| OFFLINE \| RETIRED Required: Yes deviceType The type of the device. Type: String Valid Values: QPU \| SIMULATOR Required: Yes providerName The provider of the device. DeviceSummary API Version 2019-09-01 70 Amazon Braket Type: String Required: Yes See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2019-09-01 71 Amazon Braket API Reference HybridJobQueueInfo Information about the queue for a speciﬁed hybrid job. Contents position Current position of the hybrid job in the jobs queue. Type: String Required: Yes queue The name of the queue. Type: String Valid Values: QUANTUM_TASKS_QUEUE \| JOBS_QUEUE Required: Yes message Optional. Provides more information about the queue position. For example, if the hybrid job is complete and no longer in the queue, the message ﬁeld contains that information. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 HybridJobQueueInfo API Version 2019-09-01 72 Amazon Braket API Reference See Also API Version 2019-09-01 73 Amazon Braket InputFileConﬁg API Reference A list of parameters that specify the input channels, type of input data, and where it is located. Contents channelName A named input source that an Amazon Braket hybrid job can consume. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[A-Za-z0-9\.\-_]+$ Required: Yes dataSource The location of the input data. Type: DataSource object Required: Yes contentType The MIME type of the data. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++
amazon-braket-api-013	amazon-braket-api.pdf	13	specify the input channels, type of input data, and where it is located. Contents channelName A named input source that an Amazon Braket hybrid job can consume. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[A-Za-z0-9\.\-_]+$ Required: Yes dataSource The location of the input data. Type: DataSource object Required: Yes contentType The MIME type of the data. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 InputFileConﬁg API Version 2019-09-01 74 Amazon Braket • AWS SDK for Ruby V3 API Reference See Also API Version 2019-09-01 75 Amazon Braket InstanceConﬁg API Reference Conﬁgures the resource instances to use while running the Amazon Braket hybrid job on Amazon Braket. Contents instanceType Conﬁgures the type of resource instances to use while running an Amazon Braket hybrid job. Type: String Valid Values: ml.m4.xlarge \| ml.m4.2xlarge \| ml.m4.4xlarge \| ml.m4.10xlarge \| ml.m4.16xlarge \| ml.g4dn.xlarge \| ml.g4dn.2xlarge \| ml.g4dn.4xlarge \| ml.g4dn.8xlarge \| ml.g4dn.12xlarge \| ml.g4dn.16xlarge \| ml.m5.large \| ml.m5.xlarge \| ml.m5.2xlarge \| ml.m5.4xlarge \| ml.m5.12xlarge \| ml.m5.24xlarge \| ml.c4.xlarge \| ml.c4.2xlarge \| ml.c4.4xlarge \| ml.c4.8xlarge \| ml.p2.xlarge \| ml.p2.8xlarge \| ml.p2.16xlarge \| ml.p3.2xlarge \| ml.p3.8xlarge \| ml.p3.16xlarge \| ml.p3dn.24xlarge \| ml.p4d.24xlarge \| ml.c5.xlarge \| ml.c5.2xlarge \| ml.c5.4xlarge \| ml.c5.9xlarge \| ml.c5.18xlarge \| ml.c5n.xlarge \| ml.c5n.2xlarge \| ml.c5n.4xlarge \| ml.c5n.9xlarge \| ml.c5n.18xlarge Required: Yes volumeSizeInGb The size of the storage volume, in GB, to provision. Type: Integer Valid Range: Minimum value of 1. Required: Yes instanceCount Conﬁgures the number of resource instances to use while running an Amazon Braket hybrid job on Amazon Braket. The default value is 1. Type: Integer InstanceConﬁg API Version 2019-09-01 76 Amazon Braket API Reference Valid Range: Minimum value of 1. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2019-09-01 77 Amazon Braket API Reference JobCheckpointConﬁg Contains information about the output locations for hybrid job checkpoint data. Contents s3Uri Identiﬁes the S3 path where you want Amazon Braket to store checkpoint data. For example, s3://bucket-name/key-name-prefix. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: ^(https\|s3)://([^/]+)/?(.)$ Required: Yes localPath (Optional) The local directory where checkpoint data is stored. The default directory is /opt/ braket/checkpoints/. Type: String Length Constraints: Minimum length of 1. Maximum length of 4096. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 JobCheckpointConﬁg API Version 2019-09-01 78 Amazon Braket JobEventDetails API Reference Details about the type and time events that occurred related to the Amazon Braket hybrid job. Contents eventType The type of event that occurred related to the Amazon Braket hybrid job. Type: String Valid Values: WAITING_FOR_PRIORITY \| QUEUED_FOR_EXECUTION \| STARTING_INSTANCE \| DOWNLOADING_DATA \| RUNNING \| DEPRIORITIZED_DUE_TO_INACTIVITY \| UPLOADING_RESULTS \| COMPLETED \| FAILED \| MAX_RUNTIME_EXCEEDED \| CANCELLED Required: No message A message describing the event that occurred related to the Amazon Braket hybrid job. Type: String Length Constraints: Minimum length of 0. Maximum length of 2500. Required: No timeOfEvent The time of the event that occurred related to the Amazon Braket hybrid job. Type: Timestamp Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ JobEventDetails API Version 2019-09-01 79 Amazon Braket • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2019-09-01 80 Amazon Braket API Reference JobOutputDataConﬁg Speciﬁes the path to the S3 location where you want to store hybrid job artifacts and the encryption key used to store them. Contents s3Path Identiﬁes the S3 path where you want Amazon Braket to store the hybrid job training artifacts. For example, s3://bucket-name/key-name-prefix. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: ^(https\|s3)://([^/]+)/?(.)$ Required: Yes kmsKeyId The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the hybrid job training artifacts at rest using Amazon S3 server-side encryption. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 JobOutputDataConﬁg API Version 2019-09-01 81 Amazon Braket API Reference JobStoppingCondition Speciﬁes limits for how long an Amazon Braket hybrid job can
amazon-braket-api-014	amazon-braket-api.pdf	14	Required: Yes kmsKeyId The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the hybrid job training artifacts at rest using Amazon S3 server-side encryption. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 JobOutputDataConﬁg API Version 2019-09-01 81 Amazon Braket API Reference JobStoppingCondition Speciﬁes limits for how long an Amazon Braket hybrid job can run. Contents maxRuntimeInSeconds The maximum length of time, in seconds, that an Amazon Braket hybrid job can run. Type: Integer Valid Range: Minimum value of 1. Maximum value of 432000. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 JobStoppingCondition API Version 2019-09-01 82 Amazon Braket JobSummary API Reference Provides summary information about an Amazon Braket hybrid job. Contents createdAt The time at which the Amazon Braket hybrid job was created. Type: Timestamp Required: Yes device The primary device used by an Amazon Braket hybrid job. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes jobArn The ARN of the Amazon Braket hybrid job. Type: String Pattern: ^arn:aws[a-z\-]:braket:[a-z0-9\-]+:[0-9]{12}:job/.$ Required: Yes jobName The name of the Amazon Braket hybrid job. Type: String Required: Yes status The status of the Amazon Braket hybrid job. JobSummary API Version 2019-09-01 83 Amazon Braket Type: String API Reference Valid Values: QUEUED \| RUNNING \| COMPLETED \| FAILED \| CANCELLING \| CANCELLED Required: Yes endedAt The time at which the Amazon Braket hybrid job ended. Type: Timestamp Required: No startedAt The time at which the Amazon Braket hybrid job was started. Type: Timestamp Required: No tags Displays the key, value pairs of tags associated with this hybrid job. Type: String to string map Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2019-09-01 84 Amazon Braket API Reference QuantumTaskQueueInfo The queue information for the speciﬁed quantum task. Contents position Current position of the quantum task in the quantum tasks queue. Type: String Required: Yes queue The name of the queue. Type: String Valid Values: QUANTUM_TASKS_QUEUE \| JOBS_QUEUE Required: Yes message Optional. Provides more information about the queue position. For example, if the quantum task is complete and no longer in the queue, the message ﬁeld contains that information. Type: String Required: No queuePriority Optional. Speciﬁes the priority of the queue. Quantum tasks in a priority queue are processed before the quantum tasks in a normal queue. Type: String Valid Values: Normal \| Priority Required: No QuantumTaskQueueInfo API Version 2019-09-01 85 Amazon Braket See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2019-09-01 86 Amazon Braket API Reference QuantumTaskSummary Includes information about a quantum task. Contents createdAt The time at which the quantum task was created. Type: Timestamp Required: Yes deviceArn The ARN of the device the quantum task ran on. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes outputS3Bucket The S3 bucket where the quantum task result ﬁle is stored. Type: String Required: Yes outputS3Directory The folder in the S3 bucket where the quantum task result ﬁle is stored. Type: String Required: Yes quantumTaskArn The ARN of the quantum task. Type: String QuantumTaskSummary API Version 2019-09-01 87 Amazon Braket API Reference Length Constraints: Minimum length of 0. Maximum length of 256. Required: Yes shots The shots used for the quantum task. Type: Long Required: Yes status The status of the quantum task. Type: String Valid Values: CREATED \| QUEUED \| RUNNING \| COMPLETED \| FAILED \| CANCELLING \| CANCELLED Required: Yes endedAt The time at which the quantum task ﬁnished. Type: Timestamp Required: No tags Displays the key, value pairs of tags associated with this quantum task. Type: String to string map Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ See Also API Version 2019-09-01 88 Amazon Braket • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2019-09-01 89 Amazon Braket S3DataSource API Reference Information about the Amazon S3 storage used by the
amazon-braket-api-015	amazon-braket-api.pdf	15	Yes endedAt The time at which the quantum task ﬁnished. Type: Timestamp Required: No tags Displays the key, value pairs of tags associated with this quantum task. Type: String to string map Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ See Also API Version 2019-09-01 88 Amazon Braket • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2019-09-01 89 Amazon Braket S3DataSource API Reference Information about the Amazon S3 storage used by the Amazon Braket hybrid job. Contents s3Uri Depending on the value speciﬁed for the S3DataType, identiﬁes either a key name preﬁx or a manifest that locates the S3 data source. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: ^(https\|s3)://([^/]+)/?(.)$ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 S3DataSource API Version 2019-09-01 90 Amazon Braket ScriptModeConﬁg API Reference Contains information about algorithm scripts used for the Amazon Braket hybrid job. Contents entryPoint The entry point in the algorithm scripts from where the execution begins in the hybrid job. Type: String Required: Yes s3Uri The URI that speciﬁes the S3 path to the algorithm scripts used by an Amazon Braket hybrid job. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: ^(https\|s3)://([^/]+)/?(.)$ Required: Yes compressionType The type of compression used to store the algorithm scripts in Amazon S3 storage. Type: String Valid Values: NONE \| GZIP Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ ScriptModeConﬁg API Version 2019-09-01 91 Amazon Braket • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2019-09-01 92 Amazon Braket SearchDevicesFilter The ﬁlter used to search for devices. Contents name API Reference The name of the device parameter to ﬁlter based on. Only deviceArn ﬁlter name is currently supported. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes values The values used to ﬁlter devices based on the ﬁlter name. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SearchDevicesFilter API Version 2019-09-01 93 Amazon Braket SearchJobsFilter A ﬁlter used to search for Amazon Braket hybrid jobs. Contents name API Reference The name of the hybrid job parameter to ﬁlter based on. Filter name can be either jobArn or createdAt. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes operator An operator to use for the ﬁlter. Type: String Valid Values: LT \| LTE \| EQUAL \| GT \| GTE \| BETWEEN \| CONTAINS Required: Yes values The values used to ﬁlter hybrid jobs based on the ﬁlter name and operator. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: SearchJobsFilter API Version 2019-09-01 94 Amazon Braket • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2019-09-01 95 Amazon Braket API Reference SearchQuantumTasksFilter A ﬁlter used to search for quantum tasks. Contents name The name of the quantum task parameter to ﬁlter based on. Filter name can be either quantumTaskArn, deviceArn, jobArn, status or createdAt. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes operator An operator to use for the ﬁlter. Type: String Valid Values: LT \| LTE \| EQUAL \| GT \| GTE \| BETWEEN Required: Yes values The values used to ﬁlter quantum tasks based on the ﬁlter name and operator. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: SearchQuantumTasksFilter API Version 2019-09-01 96 Amazon Braket • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version
amazon-braket-api-016	amazon-braket-api.pdf	16	\| GT \| GTE \| BETWEEN Required: Yes values The values used to ﬁlter quantum tasks based on the ﬁlter name and operator. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: SearchQuantumTasksFilter API Version 2019-09-01 96 Amazon Braket • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2019-09-01 97 Amazon Braket API Reference Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-speciﬁc parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. API Version 2019-09-01 98 Amazon Braket API Reference For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is speciﬁed in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Elements of an AWS API request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Speciﬁes the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. API Version 2019-09-01 99 Amazon Braket Type: string Required: Conditional X-Amz-SignedHeaders API Reference Speciﬁes all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional API Version 2019-09-01 100 Amazon Braket API Reference Common Errors This section lists the errors common to the API actions of all AWS services. For errors speciﬁc to an API action for this service, see the topic for that API action. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 ExpiredTokenException The security token included in the request is expired HTTP Status Code: 403 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 403 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 MalformedHttpRequestException Problems with the request at the HTTP level, e.g. we can't decompress the body according to the decompression algorithm speciﬁed by the content-encoding. HTTP Status Code: 400 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 401 OptInRequired The AWS access key ID needs a subscription for the service. API Version 2019-09-01 101 Amazon Braket HTTP Status Code: 403 RequestAbortedException API Reference Convenient exception that can be used when a request is aborted before a reply is sent back (e.g. client closed connection). HTTP Status Code: 400 RequestEntityTooLargeException Problems with the request at the HTTP level. The request entity is too large. HTTP Status Code: 413 RequestExpired The request reached the
amazon-braket-api-017	amazon-braket-api.pdf	17	to the decompression algorithm speciﬁed by the content-encoding. HTTP Status Code: 400 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 401 OptInRequired The AWS access key ID needs a subscription for the service. API Version 2019-09-01 101 Amazon Braket HTTP Status Code: 403 RequestAbortedException API Reference Convenient exception that can be used when a request is aborted before a reply is sent back (e.g. client closed connection). HTTP Status Code: 400 RequestEntityTooLargeException Problems with the request at the HTTP level. The request entity is too large. HTTP Status Code: 413 RequestExpired The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 RequestTimeoutException Problems with the request at the HTTP level. Reading the Request timed out. HTTP Status Code: 408 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 UnrecognizedClientException The X.509 certiﬁcate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 API Version 2019-09-01 102 Amazon Braket UnknownOperationException API Reference The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 404 ValidationError The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 API Version 2019-09-01 103
amazon-lightsail-api-reference-001	amazon-lightsail-api-reference.pdf	1	API Reference Amazon Lightsail API Version 2016-11-28 Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon Lightsail API Reference Amazon Lightsail: API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. Amazon Lightsail Table of Contents API Reference Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 2 AllocateStaticIp ............................................................................................................................................. 8 Request Syntax ........................................................................................................................................ 8 Request Parameters ................................................................................................................................ 8 Response Syntax ...................................................................................................................................... 8 Response Elements ................................................................................................................................. 9 Errors .......................................................................................................................................................... 9 See Also .................................................................................................................................................. 10 AttachCertiﬁcateToDistribution ............................................................................................................... 12 Request Syntax ...................................................................................................................................... 12 Request Parameters .............................................................................................................................. 12 Response Syntax ................................................................................................................................... 13 Response Elements ............................................................................................................................... 14 Errors ....................................................................................................................................................... 14 See Also .................................................................................................................................................. 15 AttachDisk .................................................................................................................................................... 17 Request Syntax ...................................................................................................................................... 17 Request Parameters .............................................................................................................................. 17 Response Syntax ................................................................................................................................... 18 Response Elements ............................................................................................................................... 19 Errors ....................................................................................................................................................... 19 See Also .................................................................................................................................................. 20 AttachInstancesToLoadBalancer .............................................................................................................. 22 Request Syntax ...................................................................................................................................... 22 Request Parameters .............................................................................................................................. 22 Response Syntax ................................................................................................................................... 23 Response Elements ............................................................................................................................... 23 Errors ....................................................................................................................................................... 24 See Also .................................................................................................................................................. 25 AttachLoadBalancerTlsCertiﬁcate ........................................................................................................... 26 Request Syntax ...................................................................................................................................... 26 Request Parameters .............................................................................................................................. 26 Response Syntax ................................................................................................................................... 27 API Version 2016-11-28 iii Amazon Lightsail API Reference Response Elements ............................................................................................................................... 27 Errors ....................................................................................................................................................... 28 See Also .................................................................................................................................................. 29 AttachStaticIp .............................................................................................................................................. 30 Request Syntax ...................................................................................................................................... 30 Request Parameters .............................................................................................................................. 30 Response Syntax ................................................................................................................................... 30 Response Elements ............................................................................................................................... 31 Errors ....................................................................................................................................................... 31 See Also .................................................................................................................................................. 33 CloseInstancePublicPorts .......................................................................................................................... 34 Request Syntax ...................................................................................................................................... 34 Request Parameters .............................................................................................................................. 34 Response Syntax ................................................................................................................................... 35 Response Elements ............................................................................................................................... 35 Errors ....................................................................................................................................................... 35 See Also .................................................................................................................................................. 37 CopySnapshot ............................................................................................................................................. 38 Request Syntax ...................................................................................................................................... 38 Request Parameters .............................................................................................................................. 38 Response Syntax ................................................................................................................................... 40 Response Elements ............................................................................................................................... 41 Errors ....................................................................................................................................................... 41 Examples ................................................................................................................................................. 42 See Also .................................................................................................................................................. 45 CreateBucket ............................................................................................................................................... 47 Request Syntax ...................................................................................................................................... 47 Request Parameters .............................................................................................................................. 47 Response Syntax ................................................................................................................................... 48 Response Elements ............................................................................................................................... 50 Errors ....................................................................................................................................................... 50 See Also .................................................................................................................................................. 51 CreateBucketAccessKey ............................................................................................................................. 53 Request Syntax ...................................................................................................................................... 53 Request Parameters .............................................................................................................................. 53 Response Syntax ................................................................................................................................... 54 API Version 2016-11-28 iv Amazon Lightsail API Reference Response Elements ............................................................................................................................... 54 Errors ....................................................................................................................................................... 55 See Also .................................................................................................................................................. 56 CreateCertiﬁcate ......................................................................................................................................... 57 Request Syntax ...................................................................................................................................... 57 Request Parameters .............................................................................................................................. 57 Response Syntax ................................................................................................................................... 58 Response Elements ............................................................................................................................... 61 Errors ....................................................................................................................................................... 61 See Also .................................................................................................................................................. 62 CreateCloudFormationStack ..................................................................................................................... 63 Request Syntax ...................................................................................................................................... 63 Request Parameters .............................................................................................................................. 63 Response Syntax ................................................................................................................................... 64 Response Elements ............................................................................................................................... 64 Errors ....................................................................................................................................................... 65 See Also .................................................................................................................................................. 66 CreateContactMethod ................................................................................................................................ 67 Request Syntax ...................................................................................................................................... 67 Request Parameters .............................................................................................................................. 67 Response Syntax ................................................................................................................................... 68 Response Elements ............................................................................................................................... 69 Errors ....................................................................................................................................................... 69 See Also .................................................................................................................................................. 70 CreateContainerService ............................................................................................................................. 72 Request Syntax ...................................................................................................................................... 72 Request Parameters .............................................................................................................................. 73 Response Syntax ................................................................................................................................... 76 Response Elements ............................................................................................................................... 78 Errors ....................................................................................................................................................... 78 Examples ................................................................................................................................................. 79 See Also .................................................................................................................................................. 81 CreateContainerServiceDeployment ....................................................................................................... 83 Request Syntax ...................................................................................................................................... 83 Request Parameters .............................................................................................................................. 84 Response Syntax ................................................................................................................................... 84 API Version 2016-11-28 v Amazon Lightsail API Reference Response Elements ............................................................................................................................... 87 Errors ....................................................................................................................................................... 87 See Also .................................................................................................................................................. 88 CreateContainerServiceRegistryLogin .................................................................................................... 89 Response Syntax ................................................................................................................................... 89 Response Elements ............................................................................................................................... 90 Errors ....................................................................................................................................................... 90 See Also .................................................................................................................................................. 91 CreateDisk .................................................................................................................................................... 92 Request Syntax ...................................................................................................................................... 92 Request Parameters .............................................................................................................................. 92 Response Syntax ................................................................................................................................... 94 Response Elements ............................................................................................................................... 94 Errors ....................................................................................................................................................... 95 See Also .................................................................................................................................................. 96 CreateDiskFromSnapshot .......................................................................................................................... 97 Request Syntax ...................................................................................................................................... 97 Request Parameters .............................................................................................................................. 97 Response Syntax ................................................................................................................................. 100 Response Elements ............................................................................................................................ 101 Errors ..................................................................................................................................................... 101 See Also ................................................................................................................................................ 102 CreateDiskSnapshot ................................................................................................................................. 104 Request Syntax .................................................................................................................................... 104 Request Parameters ........................................................................................................................... 105 Response Syntax ................................................................................................................................. 106 Response Elements ............................................................................................................................ 106 Errors ..................................................................................................................................................... 107 See Also ................................................................................................................................................ 108 CreateDistribution .................................................................................................................................... 109 Request Syntax .................................................................................................................................... 109 Request Parameters ........................................................................................................................... 110 Response Syntax ................................................................................................................................. 112 Response Elements ............................................................................................................................ 114 Errors ..................................................................................................................................................... 115 See Also ................................................................................................................................................ 116 API Version 2016-11-28 vi Amazon Lightsail API Reference CreateDomain ........................................................................................................................................... 117 Request Syntax .................................................................................................................................... 117 Request Parameters ........................................................................................................................... 117 Response Syntax ................................................................................................................................. 118 Response Elements ............................................................................................................................ 118 Errors ..................................................................................................................................................... 118 See Also ................................................................................................................................................ 120 CreateDomainEntry ................................................................................................................................. 121 Request Syntax .................................................................................................................................... 121 Request Parameters ........................................................................................................................... 121 Response Syntax ................................................................................................................................. 122 Response Elements ............................................................................................................................ 122 Errors ..................................................................................................................................................... 123 See Also ................................................................................................................................................ 124 CreateGUISessionAccessDetails ............................................................................................................. 125 Request Syntax .................................................................................................................................... 125 Request Parameters ........................................................................................................................... 125 Response Syntax ................................................................................................................................. 125 Response Elements ............................................................................................................................ 126 Errors ..................................................................................................................................................... 127 See Also ................................................................................................................................................ 128 CreateInstances ......................................................................................................................................... 129 Request Syntax .................................................................................................................................... 129 Request Parameters ........................................................................................................................... 129 Response Syntax ................................................................................................................................. 132 Response Elements ............................................................................................................................ 133 Errors ..................................................................................................................................................... 133 See Also ................................................................................................................................................ 135 CreateInstancesFromSnapshot .............................................................................................................. 136 Request Syntax .................................................................................................................................... 136 Request Parameters ........................................................................................................................... 137 Response Syntax ................................................................................................................................. 140 Response Elements ............................................................................................................................ 141 Errors ..................................................................................................................................................... 141 See Also
amazon-lightsail-api-reference-002	amazon-lightsail-api-reference.pdf	2	121 Request Syntax .................................................................................................................................... 121 Request Parameters ........................................................................................................................... 121 Response Syntax ................................................................................................................................. 122 Response Elements ............................................................................................................................ 122 Errors ..................................................................................................................................................... 123 See Also ................................................................................................................................................ 124 CreateGUISessionAccessDetails ............................................................................................................. 125 Request Syntax .................................................................................................................................... 125 Request Parameters ........................................................................................................................... 125 Response Syntax ................................................................................................................................. 125 Response Elements ............................................................................................................................ 126 Errors ..................................................................................................................................................... 127 See Also ................................................................................................................................................ 128 CreateInstances ......................................................................................................................................... 129 Request Syntax .................................................................................................................................... 129 Request Parameters ........................................................................................................................... 129 Response Syntax ................................................................................................................................. 132 Response Elements ............................................................................................................................ 133 Errors ..................................................................................................................................................... 133 See Also ................................................................................................................................................ 135 CreateInstancesFromSnapshot .............................................................................................................. 136 Request Syntax .................................................................................................................................... 136 Request Parameters ........................................................................................................................... 137 Response Syntax ................................................................................................................................. 140 Response Elements ............................................................................................................................ 141 Errors ..................................................................................................................................................... 141 See Also ................................................................................................................................................ 143 CreateInstanceSnapshot ......................................................................................................................... 144 API Version 2016-11-28 vii Amazon Lightsail API Reference Request Syntax .................................................................................................................................... 144 Request Parameters ........................................................................................................................... 144 Response Syntax ................................................................................................................................. 145 Response Elements ............................................................................................................................ 145 Errors ..................................................................................................................................................... 146 See Also ................................................................................................................................................ 147 CreateKeyPair ............................................................................................................................................ 148 Request Syntax .................................................................................................................................... 148 Request Parameters ........................................................................................................................... 148 Response Syntax ................................................................................................................................. 149 Response Elements ............................................................................................................................ 150 Errors ..................................................................................................................................................... 150 See Also ................................................................................................................................................ 152 CreateLoadBalancer ................................................................................................................................. 153 Request Syntax .................................................................................................................................... 153 Request Parameters ........................................................................................................................... 153 Response Syntax ................................................................................................................................. 156 Response Elements ............................................................................................................................ 156 Errors ..................................................................................................................................................... 157 See Also ................................................................................................................................................ 158 CreateLoadBalancerTlsCertiﬁcate ......................................................................................................... 159 Request Syntax .................................................................................................................................... 159 Request Parameters ........................................................................................................................... 159 Response Syntax ................................................................................................................................. 160 Response Elements ............................................................................................................................ 161 Errors ..................................................................................................................................................... 161 See Also ................................................................................................................................................ 163 CreateRelationalDatabase ...................................................................................................................... 164 Request Syntax .................................................................................................................................... 164 Request Parameters ........................................................................................................................... 164 Response Syntax ................................................................................................................................. 169 Response Elements ............................................................................................................................ 169 Errors ..................................................................................................................................................... 170 See Also ................................................................................................................................................ 171 CreateRelationalDatabaseFromSnapshot ............................................................................................ 172 Request Syntax .................................................................................................................................... 172 API Version 2016-11-28 viii Amazon Lightsail API Reference Request Parameters ........................................................................................................................... 172 Response Syntax ................................................................................................................................. 175 Response Elements ............................................................................................................................ 175 Errors ..................................................................................................................................................... 176 See Also ................................................................................................................................................ 177 CreateRelationalDatabaseSnapshot ..................................................................................................... 178 Request Syntax .................................................................................................................................... 178 Request Parameters ........................................................................................................................... 178 Response Syntax ................................................................................................................................. 179 Response Elements ............................................................................................................................ 180 Errors ..................................................................................................................................................... 180 See Also ................................................................................................................................................ 181 DeleteAlarm .............................................................................................................................................. 183 Request Syntax .................................................................................................................................... 183 Request Parameters ........................................................................................................................... 183 Response Syntax ................................................................................................................................. 183 Response Elements ............................................................................................................................ 184 Errors ..................................................................................................................................................... 184 See Also ................................................................................................................................................ 185 DeleteAutoSnapshot ................................................................................................................................ 187 Request Syntax .................................................................................................................................... 187 Request Parameters ........................................................................................................................... 187 Response Syntax ................................................................................................................................. 187 Response Elements ............................................................................................................................ 188 Errors ..................................................................................................................................................... 188 See Also ................................................................................................................................................ 189 DeleteBucket ............................................................................................................................................. 191 Request Syntax .................................................................................................................................... 191 Request Parameters ........................................................................................................................... 191 Response Syntax ................................................................................................................................. 192 Response Elements ............................................................................................................................ 193 Errors ..................................................................................................................................................... 193 See Also ................................................................................................................................................ 194 DeleteBucketAccessKey ........................................................................................................................... 195 Request Syntax .................................................................................................................................... 195 Request Parameters ........................................................................................................................... 195 API Version 2016-11-28 ix Amazon Lightsail API Reference Response Syntax ................................................................................................................................. 196 Response Elements ............................................................................................................................ 196 Errors ..................................................................................................................................................... 196 See Also ................................................................................................................................................ 197 DeleteCertiﬁcate ....................................................................................................................................... 199 Request Syntax .................................................................................................................................... 199 Request Parameters ........................................................................................................................... 199 Response Syntax ................................................................................................................................. 199 Response Elements ............................................................................................................................ 200 Errors ..................................................................................................................................................... 200 See Also ................................................................................................................................................ 201 DeleteContactMethod ............................................................................................................................. 203 Request Syntax .................................................................................................................................... 203 Request Parameters ........................................................................................................................... 203 Response Syntax ................................................................................................................................. 204 Response Elements ............................................................................................................................ 204 Errors ..................................................................................................................................................... 204 See Also ................................................................................................................................................ 206 DeleteContainerImage ............................................................................................................................ 207 Request Syntax .................................................................................................................................... 207 Request Parameters ........................................................................................................................... 207 Response Elements ............................................................................................................................ 208 Errors ..................................................................................................................................................... 208 See Also ................................................................................................................................................ 209 DeleteContainerService ........................................................................................................................... 210 Request Syntax .................................................................................................................................... 210 Request Parameters ........................................................................................................................... 210 Response Elements ............................................................................................................................ 210 Errors ..................................................................................................................................................... 210 See Also ................................................................................................................................................ 211 DeleteDisk .................................................................................................................................................. 213 Request Syntax .................................................................................................................................... 213 Request Parameters ........................................................................................................................... 213 Response Syntax ................................................................................................................................. 214 Response Elements ............................................................................................................................ 214 Errors ..................................................................................................................................................... 215 API Version 2016-11-28 x Amazon Lightsail API Reference See Also ................................................................................................................................................ 216 DeleteDiskSnapshot ................................................................................................................................. 217 Request Syntax .................................................................................................................................... 217 Request Parameters ........................................................................................................................... 217 Response Syntax ................................................................................................................................. 217 Response Elements ............................................................................................................................ 218 Errors ..................................................................................................................................................... 218 See Also ................................................................................................................................................ 220 DeleteDistribution .................................................................................................................................... 221 Request Syntax .................................................................................................................................... 221 Request Parameters ........................................................................................................................... 221 Response Syntax ................................................................................................................................. 221 Response Elements ............................................................................................................................ 222 Errors ..................................................................................................................................................... 222 See Also ................................................................................................................................................ 223 DeleteDomain ........................................................................................................................................... 225 Request Syntax .................................................................................................................................... 225 Request Parameters ........................................................................................................................... 225 Response Syntax ................................................................................................................................. 225 Response Elements ............................................................................................................................ 226 Errors ..................................................................................................................................................... 226 See Also ................................................................................................................................................ 227 DeleteDomainEntry ................................................................................................................................. 229 Request Syntax .................................................................................................................................... 229 Request Parameters ........................................................................................................................... 229 Response Syntax ................................................................................................................................. 230 Response Elements ............................................................................................................................ 230 Errors ..................................................................................................................................................... 230 See Also ................................................................................................................................................ 232 DeleteInstance .......................................................................................................................................... 233 Request Syntax .................................................................................................................................... 233 Request Parameters ........................................................................................................................... 233 Response Syntax ................................................................................................................................. 233 Response Elements ............................................................................................................................ 234 Errors ..................................................................................................................................................... 234 See Also ................................................................................................................................................ 236 API Version 2016-11-28 xi Amazon Lightsail API Reference DeleteInstanceSnapshot ......................................................................................................................... 237 Request Syntax .................................................................................................................................... 237 Request Parameters ........................................................................................................................... 237 Response Syntax ................................................................................................................................. 237 Response Elements ............................................................................................................................ 238 Errors ..................................................................................................................................................... 238 See Also ................................................................................................................................................ 239 DeleteKeyPair ............................................................................................................................................ 241 Request Syntax .................................................................................................................................... 241 Request Parameters ........................................................................................................................... 241 Response Syntax ................................................................................................................................. 242 Response Elements ............................................................................................................................ 242 Errors ..................................................................................................................................................... 243 See Also ................................................................................................................................................ 244 DeleteKnownHostKeys ............................................................................................................................ 245 Request Syntax .................................................................................................................................... 245 Request Parameters ........................................................................................................................... 245 Response Syntax ................................................................................................................................. 245 Response Elements ............................................................................................................................ 246 Errors ..................................................................................................................................................... 246 See Also ................................................................................................................................................ 248 DeleteLoadBalancer ................................................................................................................................. 249 Request Syntax .................................................................................................................................... 249 Request Parameters ........................................................................................................................... 249 Response Syntax ................................................................................................................................. 249 Response Elements ............................................................................................................................ 250 Errors ..................................................................................................................................................... 250 See Also ................................................................................................................................................ 251 DeleteLoadBalancerTlsCertiﬁcate ......................................................................................................... 253 Request Syntax .................................................................................................................................... 253 Request Parameters ........................................................................................................................... 253 Response Syntax ................................................................................................................................. 254 Response
amazon-lightsail-api-reference-003	amazon-lightsail-api-reference.pdf	3	..................................................................................................................................................... 238 See Also ................................................................................................................................................ 239 DeleteKeyPair ............................................................................................................................................ 241 Request Syntax .................................................................................................................................... 241 Request Parameters ........................................................................................................................... 241 Response Syntax ................................................................................................................................. 242 Response Elements ............................................................................................................................ 242 Errors ..................................................................................................................................................... 243 See Also ................................................................................................................................................ 244 DeleteKnownHostKeys ............................................................................................................................ 245 Request Syntax .................................................................................................................................... 245 Request Parameters ........................................................................................................................... 245 Response Syntax ................................................................................................................................. 245 Response Elements ............................................................................................................................ 246 Errors ..................................................................................................................................................... 246 See Also ................................................................................................................................................ 248 DeleteLoadBalancer ................................................................................................................................. 249 Request Syntax .................................................................................................................................... 249 Request Parameters ........................................................................................................................... 249 Response Syntax ................................................................................................................................. 249 Response Elements ............................................................................................................................ 250 Errors ..................................................................................................................................................... 250 See Also ................................................................................................................................................ 251 DeleteLoadBalancerTlsCertiﬁcate ......................................................................................................... 253 Request Syntax .................................................................................................................................... 253 Request Parameters ........................................................................................................................... 253 Response Syntax ................................................................................................................................. 254 Response Elements ............................................................................................................................ 254 Errors ..................................................................................................................................................... 255 See Also ................................................................................................................................................ 256 DeleteRelationalDatabase ...................................................................................................................... 257 API Version 2016-11-28 xii Amazon Lightsail API Reference Request Syntax .................................................................................................................................... 257 Request Parameters ........................................................................................................................... 257 Response Syntax ................................................................................................................................. 258 Response Elements ............................................................................................................................ 259 Errors ..................................................................................................................................................... 259 See Also ................................................................................................................................................ 260 DeleteRelationalDatabaseSnapshot ..................................................................................................... 262 Request Syntax .................................................................................................................................... 262 Request Parameters ........................................................................................................................... 262 Response Syntax ................................................................................................................................. 262 Response Elements ............................................................................................................................ 263 Errors ..................................................................................................................................................... 263 See Also ................................................................................................................................................ 264 DetachCertiﬁcateFromDistribution ....................................................................................................... 266 Request Syntax .................................................................................................................................... 266 Request Parameters ........................................................................................................................... 266 Response Syntax ................................................................................................................................. 266 Response Elements ............................................................................................................................ 267 Errors ..................................................................................................................................................... 267 See Also ................................................................................................................................................ 268 DetachDisk ................................................................................................................................................. 270 Request Syntax .................................................................................................................................... 270 Request Parameters ........................................................................................................................... 270 Response Syntax ................................................................................................................................. 270 Response Elements ............................................................................................................................ 271 Errors ..................................................................................................................................................... 271 See Also ................................................................................................................................................ 272 DetachInstancesFromLoadBalancer ...................................................................................................... 274 Request Syntax .................................................................................................................................... 274 Request Parameters ........................................................................................................................... 274 Response Syntax ................................................................................................................................. 275 Response Elements ............................................................................................................................ 275 Errors ..................................................................................................................................................... 275 See Also ................................................................................................................................................ 277 DetachStaticIp ........................................................................................................................................... 278 Request Syntax .................................................................................................................................... 278 API Version 2016-11-28 xiii Amazon Lightsail API Reference Request Parameters ........................................................................................................................... 278 Response Syntax ................................................................................................................................. 278 Response Elements ............................................................................................................................ 279 Errors ..................................................................................................................................................... 279 See Also ................................................................................................................................................ 280 DisableAddOn ........................................................................................................................................... 282 Request Syntax .................................................................................................................................... 282 Request Parameters ........................................................................................................................... 282 Response Syntax ................................................................................................................................. 282 Response Elements ............................................................................................................................ 283 Errors ..................................................................................................................................................... 283 See Also ................................................................................................................................................ 284 DownloadDefaultKeyPair ........................................................................................................................ 286 Response Syntax ................................................................................................................................. 286 Response Elements ............................................................................................................................ 286 Errors ..................................................................................................................................................... 286 See Also ................................................................................................................................................ 288 EnableAddOn ............................................................................................................................................ 289 Request Syntax .................................................................................................................................... 289 Request Parameters ........................................................................................................................... 289 Response Syntax ................................................................................................................................. 290 Response Elements ............................................................................................................................ 290 Errors ..................................................................................................................................................... 290 See Also ................................................................................................................................................ 292 ExportSnapshot ........................................................................................................................................ 293 Request Syntax .................................................................................................................................... 293 Request Parameters ........................................................................................................................... 293 Response Syntax ................................................................................................................................. 294 Response Elements ............................................................................................................................ 294 Errors ..................................................................................................................................................... 295 See Also ................................................................................................................................................ 296 GetActiveNames ....................................................................................................................................... 297 Request Syntax .................................................................................................................................... 297 Request Parameters ........................................................................................................................... 297 Response Syntax ................................................................................................................................. 297 Response Elements ............................................................................................................................ 297 API Version 2016-11-28 xiv Amazon Lightsail API Reference Errors ..................................................................................................................................................... 298 See Also ................................................................................................................................................ 299 GetAlarms .................................................................................................................................................. 301 Request Syntax .................................................................................................................................... 301 Request Parameters ........................................................................................................................... 301 Response Syntax ................................................................................................................................. 302 Response Elements ............................................................................................................................ 303 Errors ..................................................................................................................................................... 303 See Also ................................................................................................................................................ 304 GetAutoSnapshots ................................................................................................................................... 306 Request Syntax .................................................................................................................................... 306 Request Parameters ........................................................................................................................... 306 Response Syntax ................................................................................................................................. 306 Response Elements ............................................................................................................................ 307 Errors ..................................................................................................................................................... 307 See Also ................................................................................................................................................ 309 GetBlueprints ............................................................................................................................................ 310 Request Syntax .................................................................................................................................... 310 Request Parameters ........................................................................................................................... 310 Response Syntax ................................................................................................................................. 311 Response Elements ............................................................................................................................ 312 Errors ..................................................................................................................................................... 312 See Also ................................................................................................................................................ 313 GetBucketAccessKeys ............................................................................................................................... 315 Request Syntax .................................................................................................................................... 315 Request Parameters ........................................................................................................................... 315 Response Syntax ................................................................................................................................. 315 Response Elements ............................................................................................................................ 316 Errors ..................................................................................................................................................... 316 Examples ............................................................................................................................................... 317 See Also ................................................................................................................................................ 318 GetBucketBundles .................................................................................................................................... 320 Request Syntax .................................................................................................................................... 320 Request Parameters ........................................................................................................................... 320 Response Syntax ................................................................................................................................. 320 Response Elements ............................................................................................................................ 321 API Version 2016-11-28 xv Amazon Lightsail API Reference Errors ..................................................................................................................................................... 321 See Also ................................................................................................................................................ 322 GetBucketMetricData ............................................................................................................................... 323 Request Syntax .................................................................................................................................... 323 Request Parameters ........................................................................................................................... 323 Response Syntax ................................................................................................................................. 326 Response Elements ............................................................................................................................ 326 Errors ..................................................................................................................................................... 327 See Also ................................................................................................................................................ 328 GetBuckets ................................................................................................................................................. 329 Request Syntax .................................................................................................................................... 329 Request Parameters ........................................................................................................................... 329 Response Syntax ................................................................................................................................. 330 Response Elements ............................................................................................................................ 331 Errors ..................................................................................................................................................... 332 See Also ................................................................................................................................................ 333 GetBundles ................................................................................................................................................ 334 Request Syntax .................................................................................................................................... 334 Request Parameters ........................................................................................................................... 334 Response Syntax ................................................................................................................................. 335 Response Elements ............................................................................................................................ 336 Errors ..................................................................................................................................................... 336 See Also ................................................................................................................................................ 337 GetCertiﬁcates .......................................................................................................................................... 339 Request Syntax .................................................................................................................................... 339 Request Parameters ........................................................................................................................... 339 Response Syntax ................................................................................................................................. 340 Response Elements ............................................................................................................................ 342 Errors ..................................................................................................................................................... 343 See Also ................................................................................................................................................ 344 GetCloudFormationStackRecords ......................................................................................................... 345 Request Syntax .................................................................................................................................... 345 Request Parameters ........................................................................................................................... 345 Response Syntax ................................................................................................................................. 345 Response Elements ............................................................................................................................ 346 Errors ..................................................................................................................................................... 347 API Version 2016-11-28 xvi Amazon Lightsail API Reference See Also ................................................................................................................................................ 348 GetContactMethods ................................................................................................................................. 349 Request Syntax .................................................................................................................................... 349 Request Parameters ........................................................................................................................... 349 Response Syntax ................................................................................................................................. 349 Response Elements ............................................................................................................................ 350 Errors ..................................................................................................................................................... 350 See Also ................................................................................................................................................ 351 GetContainerAPIMetadata ...................................................................................................................... 353 Response Syntax ................................................................................................................................. 353 Response Elements ............................................................................................................................ 353 Errors ..................................................................................................................................................... 353 See Also ................................................................................................................................................ 354 GetContainerImages ................................................................................................................................ 355 Request Syntax .................................................................................................................................... 355 Request Parameters ........................................................................................................................... 355 Response Syntax ................................................................................................................................. 355 Response Elements ............................................................................................................................ 356 Errors ..................................................................................................................................................... 356 See Also ................................................................................................................................................ 357 GetContainerLog ...................................................................................................................................... 358 Request Syntax .................................................................................................................................... 358 Request Parameters ........................................................................................................................... 358 Response Syntax ................................................................................................................................. 360 Response Elements ............................................................................................................................ 361 Errors ..................................................................................................................................................... 361 See Also ................................................................................................................................................ 362 GetContainerServiceDeployments ........................................................................................................ 364 Request Syntax .................................................................................................................................... 364 Request Parameters ........................................................................................................................... 364 Response Syntax
amazon-lightsail-api-reference-004	amazon-lightsail-api-reference.pdf	4	........................................................................................................................... 349 Response Syntax ................................................................................................................................. 349 Response Elements ............................................................................................................................ 350 Errors ..................................................................................................................................................... 350 See Also ................................................................................................................................................ 351 GetContainerAPIMetadata ...................................................................................................................... 353 Response Syntax ................................................................................................................................. 353 Response Elements ............................................................................................................................ 353 Errors ..................................................................................................................................................... 353 See Also ................................................................................................................................................ 354 GetContainerImages ................................................................................................................................ 355 Request Syntax .................................................................................................................................... 355 Request Parameters ........................................................................................................................... 355 Response Syntax ................................................................................................................................. 355 Response Elements ............................................................................................................................ 356 Errors ..................................................................................................................................................... 356 See Also ................................................................................................................................................ 357 GetContainerLog ...................................................................................................................................... 358 Request Syntax .................................................................................................................................... 358 Request Parameters ........................................................................................................................... 358 Response Syntax ................................................................................................................................. 360 Response Elements ............................................................................................................................ 361 Errors ..................................................................................................................................................... 361 See Also ................................................................................................................................................ 362 GetContainerServiceDeployments ........................................................................................................ 364 Request Syntax .................................................................................................................................... 364 Request Parameters ........................................................................................................................... 364 Response Syntax ................................................................................................................................. 365 Response Elements ............................................................................................................................ 365 Errors ..................................................................................................................................................... 366 See Also ................................................................................................................................................ 367 GetContainerServiceMetricData ............................................................................................................ 368 Request Syntax .................................................................................................................................... 368 API Version 2016-11-28 xvii Amazon Lightsail API Reference Request Parameters ........................................................................................................................... 368 Response Syntax ................................................................................................................................. 370 Response Elements ............................................................................................................................ 371 Errors ..................................................................................................................................................... 371 See Also ................................................................................................................................................ 372 GetContainerServicePowers ................................................................................................................... 373 Response Syntax ................................................................................................................................. 373 Response Elements ............................................................................................................................ 373 Errors ..................................................................................................................................................... 373 See Also ................................................................................................................................................ 374 GetContainerServices .............................................................................................................................. 376 Request Syntax .................................................................................................................................... 376 Request Parameters ........................................................................................................................... 376 Response Syntax ................................................................................................................................. 376 Response Elements ............................................................................................................................ 379 Errors ..................................................................................................................................................... 379 See Also ................................................................................................................................................ 380 GetCostEstimate ....................................................................................................................................... 381 Request Syntax .................................................................................................................................... 381 Request Parameters ........................................................................................................................... 381 Response Syntax ................................................................................................................................. 382 Response Elements ............................................................................................................................ 383 Errors ..................................................................................................................................................... 383 See Also ................................................................................................................................................ 384 GetDisk ....................................................................................................................................................... 385 Request Syntax .................................................................................................................................... 385 Request Parameters ........................................................................................................................... 385 Response Syntax ................................................................................................................................. 385 Response Elements ............................................................................................................................ 386 Errors ..................................................................................................................................................... 386 See Also ................................................................................................................................................ 388 GetDisks ..................................................................................................................................................... 389 Request Syntax .................................................................................................................................... 389 Request Parameters ........................................................................................................................... 389 Response Syntax ................................................................................................................................. 389 Response Elements ............................................................................................................................ 390 API Version 2016-11-28 xviii Amazon Lightsail API Reference Errors ..................................................................................................................................................... 391 See Also ................................................................................................................................................ 392 GetDiskSnapshot ...................................................................................................................................... 393 Request Syntax .................................................................................................................................... 393 Request Parameters ........................................................................................................................... 393 Response Syntax ................................................................................................................................. 393 Response Elements ............................................................................................................................ 394 Errors ..................................................................................................................................................... 394 See Also ................................................................................................................................................ 395 GetDiskSnapshots .................................................................................................................................... 397 Request Syntax .................................................................................................................................... 397 Request Parameters ........................................................................................................................... 397 Response Syntax ................................................................................................................................. 397 Response Elements ............................................................................................................................ 398 Errors ..................................................................................................................................................... 399 See Also ................................................................................................................................................ 400 GetDistributionBundles ........................................................................................................................... 401 Response Syntax ................................................................................................................................. 401 Response Elements ............................................................................................................................ 401 Errors ..................................................................................................................................................... 401 See Also ................................................................................................................................................ 403 GetDistributionLatestCacheReset ......................................................................................................... 404 Request Syntax .................................................................................................................................... 404 Request Parameters ........................................................................................................................... 404 Response Syntax ................................................................................................................................. 404 Response Elements ............................................................................................................................ 404 Errors ..................................................................................................................................................... 405 See Also ................................................................................................................................................ 406 GetDistributionMetricData ..................................................................................................................... 407 Request Syntax .................................................................................................................................... 407 Request Parameters ........................................................................................................................... 407 Response Syntax ................................................................................................................................. 411 Response Elements ............................................................................................................................ 411 Errors ..................................................................................................................................................... 412 See Also ................................................................................................................................................ 413 GetDistributions ........................................................................................................................................ 414 API Version 2016-11-28 xix Amazon Lightsail API Reference Request Syntax .................................................................................................................................... 414 Request Parameters ........................................................................................................................... 414 Response Syntax ................................................................................................................................. 415 Response Elements ............................................................................................................................ 416 Errors ..................................................................................................................................................... 417 See Also ................................................................................................................................................ 418 GetDomain ................................................................................................................................................. 419 Request Syntax .................................................................................................................................... 419 Request Parameters ........................................................................................................................... 419 Response Syntax ................................................................................................................................. 419 Response Elements ............................................................................................................................ 420 Errors ..................................................................................................................................................... 420 See Also ................................................................................................................................................ 422 GetDomains ............................................................................................................................................... 423 Request Syntax .................................................................................................................................... 423 Request Parameters ........................................................................................................................... 423 Response Syntax ................................................................................................................................. 423 Response Elements ............................................................................................................................ 424 Errors ..................................................................................................................................................... 425 See Also ................................................................................................................................................ 426 GetExportSnapshotRecords .................................................................................................................... 428 Request Syntax .................................................................................................................................... 428 Request Parameters ........................................................................................................................... 428 Response Syntax ................................................................................................................................. 428 Response Elements ............................................................................................................................ 429 Errors ..................................................................................................................................................... 430 See Also ................................................................................................................................................ 431 GetInstance ................................................................................................................................................ 433 Request Syntax .................................................................................................................................... 433 Request Parameters ........................................................................................................................... 433 Response Syntax ................................................................................................................................. 433 Response Elements ............................................................................................................................ 436 Errors ..................................................................................................................................................... 436 See Also ................................................................................................................................................ 437 GetInstanceAccessDetails ........................................................................................................................ 439 Request Syntax .................................................................................................................................... 439 API Version 2016-11-28 xx Amazon Lightsail API Reference Request Parameters ........................................................................................................................... 439 Response Syntax ................................................................................................................................. 440 Response Elements ............................................................................................................................ 440 Errors ..................................................................................................................................................... 441 See Also ................................................................................................................................................ 442 GetInstanceMetricData ............................................................................................................................ 443 Request Syntax .................................................................................................................................... 443 Request Parameters ........................................................................................................................... 443 Response Syntax ................................................................................................................................. 447 Response Elements ............................................................................................................................ 448 Errors ..................................................................................................................................................... 448 See Also ................................................................................................................................................ 450 GetInstancePortStates ............................................................................................................................. 451 Request Syntax .................................................................................................................................... 451 Request Parameters ........................................................................................................................... 451 Response Syntax ................................................................................................................................. 451 Response Elements ............................................................................................................................ 452 Errors ..................................................................................................................................................... 452 See Also ................................................................................................................................................ 453 GetInstances .............................................................................................................................................. 455 Request Syntax .................................................................................................................................... 455 Request Parameters ........................................................................................................................... 455 Response Syntax ................................................................................................................................. 455 Response Elements ............................................................................................................................ 458 Errors ..................................................................................................................................................... 458 Examples ............................................................................................................................................... 460 See Also ................................................................................................................................................ 464 GetInstanceSnapshot ............................................................................................................................... 466 Request Syntax .................................................................................................................................... 466 Request Parameters ........................................................................................................................... 466 Response Syntax ................................................................................................................................. 466 Response Elements ............................................................................................................................ 468 Errors ..................................................................................................................................................... 468 See Also ................................................................................................................................................ 469 GetInstanceSnapshots ............................................................................................................................. 471 Request Syntax .................................................................................................................................... 471 API Version 2016-11-28 xxi Amazon Lightsail API Reference Request Parameters ........................................................................................................................... 471 Response Syntax ................................................................................................................................. 471 Response Elements ............................................................................................................................ 473 Errors ..................................................................................................................................................... 473 See Also ................................................................................................................................................ 475 GetInstanceState ...................................................................................................................................... 476 Request Syntax .................................................................................................................................... 476 Request Parameters ........................................................................................................................... 476 Response Syntax ................................................................................................................................. 476 Response Elements ............................................................................................................................ 476 Errors ..................................................................................................................................................... 477 See Also ................................................................................................................................................ 478 GetKeyPair ................................................................................................................................................. 479 Request Syntax .................................................................................................................................... 479 Request Parameters ........................................................................................................................... 479 Response Syntax ................................................................................................................................. 479 Response Elements ............................................................................................................................ 480 Errors ..................................................................................................................................................... 480 See Also ................................................................................................................................................ 481 GetKeyPairs ............................................................................................................................................... 483 Request Syntax .................................................................................................................................... 483 Request Parameters ........................................................................................................................... 483 Response Syntax ................................................................................................................................. 483 Response Elements ............................................................................................................................ 484 Errors ..................................................................................................................................................... 485 See Also ................................................................................................................................................ 486 GetLoadBalancer ...................................................................................................................................... 487 Request Syntax .................................................................................................................................... 487 Request Parameters ...........................................................................................................................
amazon-lightsail-api-reference-005	amazon-lightsail-api-reference.pdf	5	471 Response Elements ............................................................................................................................ 473 Errors ..................................................................................................................................................... 473 See Also ................................................................................................................................................ 475 GetInstanceState ...................................................................................................................................... 476 Request Syntax .................................................................................................................................... 476 Request Parameters ........................................................................................................................... 476 Response Syntax ................................................................................................................................. 476 Response Elements ............................................................................................................................ 476 Errors ..................................................................................................................................................... 477 See Also ................................................................................................................................................ 478 GetKeyPair ................................................................................................................................................. 479 Request Syntax .................................................................................................................................... 479 Request Parameters ........................................................................................................................... 479 Response Syntax ................................................................................................................................. 479 Response Elements ............................................................................................................................ 480 Errors ..................................................................................................................................................... 480 See Also ................................................................................................................................................ 481 GetKeyPairs ............................................................................................................................................... 483 Request Syntax .................................................................................................................................... 483 Request Parameters ........................................................................................................................... 483 Response Syntax ................................................................................................................................. 483 Response Elements ............................................................................................................................ 484 Errors ..................................................................................................................................................... 485 See Also ................................................................................................................................................ 486 GetLoadBalancer ...................................................................................................................................... 487 Request Syntax .................................................................................................................................... 487 Request Parameters ........................................................................................................................... 487 Response Syntax ................................................................................................................................. 487 Response Elements ............................................................................................................................ 488 Errors ..................................................................................................................................................... 489 See Also ................................................................................................................................................ 490 GetLoadBalancerMetricData .................................................................................................................. 491 Request Syntax .................................................................................................................................... 491 Request Parameters ........................................................................................................................... 491 API Version 2016-11-28 xxii Amazon Lightsail API Reference Response Syntax ................................................................................................................................. 496 Response Elements ............................................................................................................................ 496 Errors ..................................................................................................................................................... 497 See Also ................................................................................................................................................ 498 GetLoadBalancers ..................................................................................................................................... 499 Request Syntax .................................................................................................................................... 499 Request Parameters ........................................................................................................................... 499 Response Syntax ................................................................................................................................. 499 Response Elements ............................................................................................................................ 500 Errors ..................................................................................................................................................... 501 See Also ................................................................................................................................................ 502 GetLoadBalancerTlsCertiﬁcates ............................................................................................................. 504 Request Syntax .................................................................................................................................... 504 Request Parameters ........................................................................................................................... 504 Response Syntax ................................................................................................................................. 504 Response Elements ............................................................................................................................ 506 Errors ..................................................................................................................................................... 506 See Also ................................................................................................................................................ 507 GetLoadBalancerTlsPolicies .................................................................................................................... 509 Request Syntax .................................................................................................................................... 509 Request Parameters ........................................................................................................................... 509 Response Syntax ................................................................................................................................. 509 Response Elements ............................................................................................................................ 510 Errors ..................................................................................................................................................... 510 See Also ................................................................................................................................................ 511 GetOperation ............................................................................................................................................ 513 Request Syntax .................................................................................................................................... 513 Request Parameters ........................................................................................................................... 513 Response Syntax ................................................................................................................................. 513 Response Elements ............................................................................................................................ 514 Errors ..................................................................................................................................................... 514 See Also ................................................................................................................................................ 515 GetOperations ........................................................................................................................................... 517 Request Syntax .................................................................................................................................... 517 Request Parameters ........................................................................................................................... 517 Response Syntax ................................................................................................................................. 517 API Version 2016-11-28 xxiii Amazon Lightsail API Reference Response Elements ............................................................................................................................ 518 Errors ..................................................................................................................................................... 518 See Also ................................................................................................................................................ 520 GetOperationsForResource .................................................................................................................... 521 Request Syntax .................................................................................................................................... 521 Request Parameters ........................................................................................................................... 521 Response Syntax ................................................................................................................................. 521 Response Elements ............................................................................................................................ 522 Errors ..................................................................................................................................................... 523 See Also ................................................................................................................................................ 524 GetRegions ................................................................................................................................................ 526 Request Syntax .................................................................................................................................... 526 Request Parameters ........................................................................................................................... 526 Response Syntax ................................................................................................................................. 526 Response Elements ............................................................................................................................ 527 Errors ..................................................................................................................................................... 527 See Also ................................................................................................................................................ 529 GetRelationalDatabase ............................................................................................................................ 530 Request Syntax .................................................................................................................................... 530 Request Parameters ........................................................................................................................... 530 Response Syntax ................................................................................................................................. 530 Response Elements ............................................................................................................................ 532 Errors ..................................................................................................................................................... 532 See Also ................................................................................................................................................ 533 GetRelationalDatabaseBlueprints ......................................................................................................... 534 Request Syntax .................................................................................................................................... 534 Request Parameters ........................................................................................................................... 534 Response Syntax ................................................................................................................................. 534 Response Elements ............................................................................................................................ 535 Errors ..................................................................................................................................................... 535 See Also ................................................................................................................................................ 536 GetRelationalDatabaseBundles ............................................................................................................. 538 Request Syntax .................................................................................................................................... 538 Request Parameters ........................................................................................................................... 538 Response Syntax ................................................................................................................................. 539 Response Elements ............................................................................................................................ 539 API Version 2016-11-28 xxiv Amazon Lightsail API Reference Errors ..................................................................................................................................................... 540 See Also ................................................................................................................................................ 541 GetRelationalDatabaseEvents ................................................................................................................ 542 Request Syntax .................................................................................................................................... 542 Request Parameters ........................................................................................................................... 542 Response Syntax ................................................................................................................................. 543 Response Elements ............................................................................................................................ 543 Errors ..................................................................................................................................................... 544 See Also ................................................................................................................................................ 545 GetRelationalDatabaseLogEvents ......................................................................................................... 546 Request Syntax .................................................................................................................................... 546 Request Parameters ........................................................................................................................... 546 Response Syntax ................................................................................................................................. 548 Response Elements ............................................................................................................................ 548 Errors ..................................................................................................................................................... 549 See Also ................................................................................................................................................ 550 GetRelationalDatabaseLogStreams ...................................................................................................... 551 Request Syntax .................................................................................................................................... 551 Request Parameters ........................................................................................................................... 551 Response Syntax ................................................................................................................................. 551 Response Elements ............................................................................................................................ 551 Errors ..................................................................................................................................................... 552 See Also ................................................................................................................................................ 553 GetRelationalDatabaseMasterUserPassword ...................................................................................... 554 Request Syntax .................................................................................................................................... 554 Request Parameters ........................................................................................................................... 554 Response Syntax ................................................................................................................................. 555 Response Elements ............................................................................................................................ 555 Errors ..................................................................................................................................................... 555 See Also ................................................................................................................................................ 556 GetRelationalDatabaseMetricData ........................................................................................................ 558 Request Syntax .................................................................................................................................... 558 Request Parameters ........................................................................................................................... 558 Response Syntax ................................................................................................................................. 561 Response Elements ............................................................................................................................ 562 Errors ..................................................................................................................................................... 562 API Version 2016-11-28 xxv Amazon Lightsail API Reference See Also ................................................................................................................................................ 564 GetRelationalDatabaseParameters ....................................................................................................... 565 Request Syntax .................................................................................................................................... 565 Request Parameters ........................................................................................................................... 565 Response Syntax ................................................................................................................................. 566 Response Elements ............................................................................................................................ 566 Errors ..................................................................................................................................................... 567 See Also ................................................................................................................................................ 568 GetRelationalDatabases .......................................................................................................................... 569 Request Syntax .................................................................................................................................... 569 Request Parameters ........................................................................................................................... 569 Response Syntax ................................................................................................................................. 569 Response Elements ............................................................................................................................ 571 Errors ..................................................................................................................................................... 571 See Also ................................................................................................................................................ 572 GetRelationalDatabaseSnapshot ........................................................................................................... 574 Request Syntax .................................................................................................................................... 574 Request Parameters ........................................................................................................................... 574 Response Syntax ................................................................................................................................. 574 Response Elements ............................................................................................................................ 575 Errors ..................................................................................................................................................... 575 See Also ................................................................................................................................................ 576 GetRelationalDatabaseSnapshots ......................................................................................................... 578 Request Syntax .................................................................................................................................... 578 Request Parameters ........................................................................................................................... 578 Response Syntax ................................................................................................................................. 578 Response Elements ............................................................................................................................ 579 Errors ..................................................................................................................................................... 580 See Also ................................................................................................................................................ 581 GetSetupHistory ....................................................................................................................................... 582 Request Syntax .................................................................................................................................... 582 Request Parameters ........................................................................................................................... 582 Response Syntax ................................................................................................................................. 583 Response Elements ............................................................................................................................ 583 Errors ..................................................................................................................................................... 584 See Also ................................................................................................................................................ 585 API Version 2016-11-28 xxvi Amazon Lightsail API Reference GetStaticIp ................................................................................................................................................. 586 Request Syntax .................................................................................................................................... 586 Request Parameters ........................................................................................................................... 586 Response Syntax ................................................................................................................................. 586 Response Elements ............................................................................................................................ 587 Errors ..................................................................................................................................................... 587 See Also ................................................................................................................................................ 588 GetStaticIps ............................................................................................................................................... 590 Request Syntax .................................................................................................................................... 590 Request Parameters ........................................................................................................................... 590 Response Syntax ................................................................................................................................. 590 Response Elements ............................................................................................................................ 591 Errors ..................................................................................................................................................... 591 See Also ................................................................................................................................................ 593 ImportKeyPair ........................................................................................................................................... 594 Request Syntax .................................................................................................................................... 594 Request Parameters ........................................................................................................................... 594 Response Syntax ................................................................................................................................. 594 Response Elements ............................................................................................................................ 595 Errors ..................................................................................................................................................... 595 See Also ................................................................................................................................................ 596 IsVpcPeered ............................................................................................................................................... 598 Response Syntax ................................................................................................................................. 598 Response Elements ............................................................................................................................ 598 Errors ..................................................................................................................................................... 598 See Also ................................................................................................................................................ 599 OpenInstancePublicPorts .......................................................................................................................
amazon-lightsail-api-reference-006	amazon-lightsail-api-reference.pdf	6	API Reference GetStaticIp ................................................................................................................................................. 586 Request Syntax .................................................................................................................................... 586 Request Parameters ........................................................................................................................... 586 Response Syntax ................................................................................................................................. 586 Response Elements ............................................................................................................................ 587 Errors ..................................................................................................................................................... 587 See Also ................................................................................................................................................ 588 GetStaticIps ............................................................................................................................................... 590 Request Syntax .................................................................................................................................... 590 Request Parameters ........................................................................................................................... 590 Response Syntax ................................................................................................................................. 590 Response Elements ............................................................................................................................ 591 Errors ..................................................................................................................................................... 591 See Also ................................................................................................................................................ 593 ImportKeyPair ........................................................................................................................................... 594 Request Syntax .................................................................................................................................... 594 Request Parameters ........................................................................................................................... 594 Response Syntax ................................................................................................................................. 594 Response Elements ............................................................................................................................ 595 Errors ..................................................................................................................................................... 595 See Also ................................................................................................................................................ 596 IsVpcPeered ............................................................................................................................................... 598 Response Syntax ................................................................................................................................. 598 Response Elements ............................................................................................................................ 598 Errors ..................................................................................................................................................... 598 See Also ................................................................................................................................................ 599 OpenInstancePublicPorts ....................................................................................................................... 601 Request Syntax .................................................................................................................................... 601 Request Parameters ........................................................................................................................... 601 Response Syntax ................................................................................................................................. 602 Response Elements ............................................................................................................................ 602 Errors ..................................................................................................................................................... 603 See Also ................................................................................................................................................ 604 PeerVpc ...................................................................................................................................................... 605 Response Syntax ................................................................................................................................. 605 Response Elements ............................................................................................................................ 605 API Version 2016-11-28 xxvii Amazon Lightsail API Reference Errors ..................................................................................................................................................... 605 See Also ................................................................................................................................................ 607 PutAlarm .................................................................................................................................................... 608 Request Syntax .................................................................................................................................... 608 Request Parameters ........................................................................................................................... 608 Response Syntax ................................................................................................................................. 613 Response Elements ............................................................................................................................ 613 Errors ..................................................................................................................................................... 614 See Also ................................................................................................................................................ 615 PutInstancePublicPorts ........................................................................................................................... 616 Request Syntax .................................................................................................................................... 616 Request Parameters ........................................................................................................................... 616 Response Syntax ................................................................................................................................. 617 Response Elements ............................................................................................................................ 617 Errors ..................................................................................................................................................... 618 See Also ................................................................................................................................................ 619 RebootInstance ......................................................................................................................................... 620 Request Syntax .................................................................................................................................... 620 Request Parameters ........................................................................................................................... 620 Response Syntax ................................................................................................................................. 620 Response Elements ............................................................................................................................ 621 Errors ..................................................................................................................................................... 621 See Also ................................................................................................................................................ 622 RebootRelationalDatabase ..................................................................................................................... 624 Request Syntax .................................................................................................................................... 624 Request Parameters ........................................................................................................................... 624 Response Syntax ................................................................................................................................. 624 Response Elements ............................................................................................................................ 625 Errors ..................................................................................................................................................... 625 See Also ................................................................................................................................................ 626 RegisterContainerImage ......................................................................................................................... 628 Request Syntax .................................................................................................................................... 628 Request Parameters ........................................................................................................................... 628 Response Syntax ................................................................................................................................. 629 Response Elements ............................................................................................................................ 630 Errors ..................................................................................................................................................... 630 API Version 2016-11-28 xxviii Amazon Lightsail API Reference See Also ................................................................................................................................................ 631 ReleaseStaticIp .......................................................................................................................................... 632 Request Syntax .................................................................................................................................... 632 Request Parameters ........................................................................................................................... 632 Response Syntax ................................................................................................................................. 632 Response Elements ............................................................................................................................ 633 Errors ..................................................................................................................................................... 633 See Also ................................................................................................................................................ 634 ResetDistributionCache ........................................................................................................................... 636 Request Syntax .................................................................................................................................... 636 Request Parameters ........................................................................................................................... 636 Response Syntax ................................................................................................................................. 636 Response Elements ............................................................................................................................ 637 Errors ..................................................................................................................................................... 637 See Also ................................................................................................................................................ 639 SendContactMethodVeriﬁcation ........................................................................................................... 640 Request Syntax .................................................................................................................................... 640 Request Parameters ........................................................................................................................... 640 Response Syntax ................................................................................................................................. 641 Response Elements ............................................................................................................................ 641 Errors ..................................................................................................................................................... 641 See Also ................................................................................................................................................ 643 SetIpAddressType ..................................................................................................................................... 644 Request Syntax .................................................................................................................................... 644 Request Parameters ........................................................................................................................... 644 Response Syntax ................................................................................................................................. 646 Response Elements ............................................................................................................................ 646 Errors ..................................................................................................................................................... 647 See Also ................................................................................................................................................ 648 SetResourceAccessForBucket ................................................................................................................. 649 Request Syntax .................................................................................................................................... 649 Request Parameters ........................................................................................................................... 649 Response Syntax ................................................................................................................................. 650 Response Elements ............................................................................................................................ 650 Errors ..................................................................................................................................................... 651 See Also ................................................................................................................................................ 652 API Version 2016-11-28 xxix Amazon Lightsail API Reference SetupInstanceHttps ................................................................................................................................. 653 Request Syntax .................................................................................................................................... 653 Request Parameters ........................................................................................................................... 653 Response Syntax ................................................................................................................................. 654 Response Elements ............................................................................................................................ 655 Errors ..................................................................................................................................................... 655 See Also ................................................................................................................................................ 656 StartGUISession ........................................................................................................................................ 657 Request Syntax .................................................................................................................................... 657 Request Parameters ........................................................................................................................... 657 Response Syntax ................................................................................................................................. 657 Response Elements ............................................................................................................................ 658 Errors ..................................................................................................................................................... 658 See Also ................................................................................................................................................ 659 StartInstance ............................................................................................................................................. 661 Request Syntax .................................................................................................................................... 661 Request Parameters ........................................................................................................................... 661 Response Syntax ................................................................................................................................. 662 Response Elements ............................................................................................................................ 662 Errors ..................................................................................................................................................... 662 See Also ................................................................................................................................................ 664 StartRelationalDatabase ......................................................................................................................... 665 Request Syntax .................................................................................................................................... 665 Request Parameters ........................................................................................................................... 665 Response Syntax ................................................................................................................................. 665 Response Elements ............................................................................................................................ 666 Errors ..................................................................................................................................................... 666 See Also ................................................................................................................................................ 667 StopGUISession ........................................................................................................................................ 669 Request Syntax .................................................................................................................................... 669 Request Parameters ........................................................................................................................... 669 Response Syntax ................................................................................................................................. 669 Response Elements ............................................................................................................................ 670 Errors ..................................................................................................................................................... 670 See Also ................................................................................................................................................ 671 StopInstance .............................................................................................................................................. 672 API Version 2016-11-28 xxx Amazon Lightsail API Reference Request Syntax .................................................................................................................................... 672 Request Parameters ........................................................................................................................... 672 Response Syntax ................................................................................................................................. 673 Response Elements ............................................................................................................................ 673 Errors ..................................................................................................................................................... 674 See Also ................................................................................................................................................ 675 StopRelationalDatabase .......................................................................................................................... 676 Request Syntax .................................................................................................................................... 676 Request Parameters ........................................................................................................................... 676 Response Syntax ................................................................................................................................. 677 Response Elements ............................................................................................................................ 677 Errors ..................................................................................................................................................... 678 See Also ................................................................................................................................................ 679 TagResource .............................................................................................................................................. 680 Request Syntax .................................................................................................................................... 680 Request Parameters ........................................................................................................................... 680 Response Syntax ................................................................................................................................. 681 Response Elements ............................................................................................................................ 681 Errors ..................................................................................................................................................... 682 See Also ................................................................................................................................................ 683 TestAlarm ................................................................................................................................................... 684 Request Syntax .................................................................................................................................... 684 Request Parameters ........................................................................................................................... 684 Response Syntax ................................................................................................................................. 685 Response Elements ............................................................................................................................ 685 Errors ..................................................................................................................................................... 686 See Also ................................................................................................................................................ 687 UnpeerVpc ................................................................................................................................................. 688 Response Syntax ................................................................................................................................. 688 Response Elements ............................................................................................................................ 688 Errors ..................................................................................................................................................... 688 See Also ................................................................................................................................................ 690 UntagResource .......................................................................................................................................... 691 Request Syntax .................................................................................................................................... 691 Request Parameters ........................................................................................................................... 691 Response Syntax ................................................................................................................................. 692 API Version 2016-11-28 xxxi Amazon Lightsail API Reference Response Elements ............................................................................................................................ 692 Errors ..................................................................................................................................................... 693 See Also ................................................................................................................................................ 694 UpdateBucket ............................................................................................................................................ 695 Request Syntax .................................................................................................................................... 695 Request Parameters ........................................................................................................................... 695 Response Syntax ................................................................................................................................. 697 Response Elements ............................................................................................................................ 698 Errors ..................................................................................................................................................... 699 See Also ................................................................................................................................................ 700 UpdateBucketBundle ............................................................................................................................... 701 Request Syntax .................................................................................................................................... 701 Request Parameters ........................................................................................................................... 701 Response Syntax ................................................................................................................................. 702 Response Elements ............................................................................................................................ 702 Errors ..................................................................................................................................................... 703 See Also ................................................................................................................................................ 704 UpdateContainerService ......................................................................................................................... 705 Request Syntax .................................................................................................................................... 705 Request Parameters ........................................................................................................................... 705 Response Syntax ................................................................................................................................. 707 Response Elements ............................................................................................................................ 710 Errors ..................................................................................................................................................... 710 Examples ............................................................................................................................................... 711 See Also ................................................................................................................................................
amazon-lightsail-api-reference-007	amazon-lightsail-api-reference.pdf	7	692 API Version 2016-11-28 xxxi Amazon Lightsail API Reference Response Elements ............................................................................................................................ 692 Errors ..................................................................................................................................................... 693 See Also ................................................................................................................................................ 694 UpdateBucket ............................................................................................................................................ 695 Request Syntax .................................................................................................................................... 695 Request Parameters ........................................................................................................................... 695 Response Syntax ................................................................................................................................. 697 Response Elements ............................................................................................................................ 698 Errors ..................................................................................................................................................... 699 See Also ................................................................................................................................................ 700 UpdateBucketBundle ............................................................................................................................... 701 Request Syntax .................................................................................................................................... 701 Request Parameters ........................................................................................................................... 701 Response Syntax ................................................................................................................................. 702 Response Elements ............................................................................................................................ 702 Errors ..................................................................................................................................................... 703 See Also ................................................................................................................................................ 704 UpdateContainerService ......................................................................................................................... 705 Request Syntax .................................................................................................................................... 705 Request Parameters ........................................................................................................................... 705 Response Syntax ................................................................................................................................. 707 Response Elements ............................................................................................................................ 710 Errors ..................................................................................................................................................... 710 Examples ............................................................................................................................................... 711 See Also ................................................................................................................................................ 714 UpdateDistribution .................................................................................................................................. 715 Request Syntax .................................................................................................................................... 715 Request Parameters ........................................................................................................................... 716 Response Syntax ................................................................................................................................. 718 Response Elements ............................................................................................................................ 718 Errors ..................................................................................................................................................... 719 See Also ................................................................................................................................................ 720 UpdateDistributionBundle ...................................................................................................................... 721 Request Syntax .................................................................................................................................... 721 Request Parameters ........................................................................................................................... 721 Response Syntax ................................................................................................................................. 722 API Version 2016-11-28 xxxii Amazon Lightsail API Reference Response Elements ............................................................................................................................ 722 Errors ..................................................................................................................................................... 723 See Also ................................................................................................................................................ 724 UpdateDomainEntry ................................................................................................................................ 725 Request Syntax .................................................................................................................................... 725 Request Parameters ........................................................................................................................... 725 Response Syntax ................................................................................................................................. 726 Response Elements ............................................................................................................................ 726 Errors ..................................................................................................................................................... 727 See Also ................................................................................................................................................ 728 UpdateInstanceMetadataOptions ......................................................................................................... 729 Request Syntax .................................................................................................................................... 729 Request Parameters ........................................................................................................................... 729 Response Syntax ................................................................................................................................. 731 Response Elements ............................................................................................................................ 731 Errors ..................................................................................................................................................... 732 See Also ................................................................................................................................................ 733 UpdateLoadBalancerAttribute ............................................................................................................... 734 Request Syntax .................................................................................................................................... 734 Request Parameters ........................................................................................................................... 734 Response Syntax ................................................................................................................................. 735 Response Elements ............................................................................................................................ 736 Errors ..................................................................................................................................................... 736 See Also ................................................................................................................................................ 738 UpdateRelationalDatabase ..................................................................................................................... 739 Request Syntax .................................................................................................................................... 739 Request Parameters ........................................................................................................................... 739 Response Syntax ................................................................................................................................. 742 Response Elements ............................................................................................................................ 743 Errors ..................................................................................................................................................... 743 See Also ................................................................................................................................................ 744 UpdateRelationalDatabaseParameters ................................................................................................ 746 Request Syntax .................................................................................................................................... 746 Request Parameters ........................................................................................................................... 746 Response Syntax ................................................................................................................................. 747 Response Elements ............................................................................................................................ 747 API Version 2016-11-28 xxxiii Amazon Lightsail API Reference Errors ..................................................................................................................................................... 748 See Also ................................................................................................................................................ 749 Data Types ................................................................................................................................... 750 AccessKey ................................................................................................................................................... 755 Contents ............................................................................................................................................... 755 See Also ................................................................................................................................................ 756 AccessKeyLastUsed .................................................................................................................................. 758 Contents ............................................................................................................................................... 758 See Also ................................................................................................................................................ 759 AccessRules ................................................................................................................................................ 760 Contents ............................................................................................................................................... 760 See Also ................................................................................................................................................ 761 AccountLevelBpaSync .............................................................................................................................. 762 Contents ............................................................................................................................................... 762 See Also ................................................................................................................................................ 764 AddOn ........................................................................................................................................................ 765 Contents ............................................................................................................................................... 765 See Also ................................................................................................................................................ 766 AddOnRequest .......................................................................................................................................... 767 Contents ............................................................................................................................................... 767 See Also ................................................................................................................................................ 768 Alarm .......................................................................................................................................................... 769 Contents ............................................................................................................................................... 769 See Also ................................................................................................................................................ 774 AttachedDisk ............................................................................................................................................. 775 Contents ............................................................................................................................................... 775 See Also ................................................................................................................................................ 775 AutoSnapshotAddOnRequest ................................................................................................................ 776 Contents ............................................................................................................................................... 776 See Also ................................................................................................................................................ 777 AutoSnapshotDetails ............................................................................................................................... 778 Contents ............................................................................................................................................... 778 See Also ................................................................................................................................................ 778 AvailabilityZone ........................................................................................................................................ 780 Contents ............................................................................................................................................... 780 See Also ................................................................................................................................................ 780 API Version 2016-11-28 xxxiv Amazon Lightsail API Reference Blueprint .................................................................................................................................................... 781 Contents ............................................................................................................................................... 781 See Also ................................................................................................................................................ 783 Bucket ......................................................................................................................................................... 785 Contents ............................................................................................................................................... 785 See Also ................................................................................................................................................ 788 BucketAccessLogConﬁg ........................................................................................................................... 790 Contents ............................................................................................................................................... 790 See Also ................................................................................................................................................ 791 BucketBundle ............................................................................................................................................ 792 Contents ............................................................................................................................................... 792 See Also ................................................................................................................................................ 793 BucketState ............................................................................................................................................... 794 Contents ............................................................................................................................................... 794 See Also ................................................................................................................................................ 794 Bundle ........................................................................................................................................................ 795 Contents ............................................................................................................................................... 795 See Also ................................................................................................................................................ 797 CacheBehavior .......................................................................................................................................... 799 Contents ............................................................................................................................................... 799 See Also ................................................................................................................................................ 799 CacheBehaviorPerPath ............................................................................................................................ 800 Contents ............................................................................................................................................... 800 See Also ................................................................................................................................................ 801 CacheSettings ........................................................................................................................................... 802 Contents ............................................................................................................................................... 802 See Also ................................................................................................................................................ 804 Certiﬁcate .................................................................................................................................................. 805 Contents ............................................................................................................................................... 805 See Also ................................................................................................................................................ 810 CertiﬁcateSummary ................................................................................................................................. 811 Contents ............................................................................................................................................... 811 See Also ................................................................................................................................................ 812 CloudFormationStackRecord .................................................................................................................. 813 Contents ............................................................................................................................................... 813 See Also ................................................................................................................................................ 815 API Version 2016-11-28 xxxv Amazon Lightsail API Reference CloudFormationStackRecordSourceInfo .............................................................................................. 816 Contents ............................................................................................................................................... 816 See Also ................................................................................................................................................ 816 ContactMethod ......................................................................................................................................... 818 Contents ............................................................................................................................................... 818 See Also ................................................................................................................................................ 820 Container ................................................................................................................................................... 821 Contents ............................................................................................................................................... 821 See Also ................................................................................................................................................ 822 ContainerImage ........................................................................................................................................ 823 Contents ............................................................................................................................................... 823 See Also ................................................................................................................................................ 823 ContainerService ...................................................................................................................................... 824 Contents ............................................................................................................................................... 824 See Also ................................................................................................................................................ 829 ContainerServiceDeployment ................................................................................................................ 830 Contents ............................................................................................................................................... 830 See Also ................................................................................................................................................ 831 ContainerServiceDeploymentRequest .................................................................................................. 832 Contents ............................................................................................................................................... 832 See Also ................................................................................................................................................ 832 ContainerServiceECRImagePullerRole .................................................................................................. 833 Contents ............................................................................................................................................... 833 See Also ................................................................................................................................................ 833 ContainerServiceECRImagePullerRoleRequest ................................................................................... 834 Contents ............................................................................................................................................... 834 See Also ................................................................................................................................................ 834 ContainerServiceEndpoint ...................................................................................................................... 835 Contents ............................................................................................................................................... 835 See Also ................................................................................................................................................ 835 ContainerServiceHealthCheckConﬁg .................................................................................................... 836 Contents ............................................................................................................................................... 836 See Also ................................................................................................................................................ 837 ContainerServiceLogEvent ..................................................................................................................... 838 Contents ............................................................................................................................................... 838 See Also ................................................................................................................................................ 838 API Version 2016-11-28 xxxvi Amazon Lightsail API Reference ContainerServicePower ........................................................................................................................... 839 Contents ............................................................................................................................................... 839 See Also ................................................................................................................................................ 840 ContainerServiceRegistryLogin .............................................................................................................. 841 Contents ............................................................................................................................................... 841 See Also ................................................................................................................................................ 842 ContainerServiceStateDetail .................................................................................................................. 843 Contents ............................................................................................................................................... 843 See Also ................................................................................................................................................ 844 CookieObject ............................................................................................................................................. 845 Contents ............................................................................................................................................... 845 See Also ................................................................................................................................................ 845 CostEstimate ............................................................................................................................................. 846 Contents ............................................................................................................................................... 846 See Also ................................................................................................................................................ 846 DestinationInfo ......................................................................................................................................... 847 Contents ............................................................................................................................................... 847 See Also ................................................................................................................................................ 847 Disk .............................................................................................................................................................. 848 Contents ............................................................................................................................................... 848 See Also ................................................................................................................................................ 852 DiskInfo ...................................................................................................................................................... 853 Contents ............................................................................................................................................... 853 See Also ................................................................................................................................................ 853 DiskMap ...................................................................................................................................................... 855 Contents ............................................................................................................................................... 855 See Also ................................................................................................................................................ 855 DiskSnapshot ............................................................................................................................................ 856 Contents ............................................................................................................................................... 856 See Also ................................................................................................................................................ 859 DiskSnapshotInfo ..................................................................................................................................... 860 Contents ............................................................................................................................................... 860 See Also ................................................................................................................................................ 860 DistributionBundle ................................................................................................................................... 861 Contents ............................................................................................................................................... 861 See Also ................................................................................................................................................ 862 API Version 2016-11-28
amazon-lightsail-api-reference-008	amazon-lightsail-api-reference.pdf	8	Contents ............................................................................................................................................... 843 See Also ................................................................................................................................................ 844 CookieObject ............................................................................................................................................. 845 Contents ............................................................................................................................................... 845 See Also ................................................................................................................................................ 845 CostEstimate ............................................................................................................................................. 846 Contents ............................................................................................................................................... 846 See Also ................................................................................................................................................ 846 DestinationInfo ......................................................................................................................................... 847 Contents ............................................................................................................................................... 847 See Also ................................................................................................................................................ 847 Disk .............................................................................................................................................................. 848 Contents ............................................................................................................................................... 848 See Also ................................................................................................................................................ 852 DiskInfo ...................................................................................................................................................... 853 Contents ............................................................................................................................................... 853 See Also ................................................................................................................................................ 853 DiskMap ...................................................................................................................................................... 855 Contents ............................................................................................................................................... 855 See Also ................................................................................................................................................ 855 DiskSnapshot ............................................................................................................................................ 856 Contents ............................................................................................................................................... 856 See Also ................................................................................................................................................ 859 DiskSnapshotInfo ..................................................................................................................................... 860 Contents ............................................................................................................................................... 860 See Also ................................................................................................................................................ 860 DistributionBundle ................................................................................................................................... 861 Contents ............................................................................................................................................... 861 See Also ................................................................................................................................................ 862 API Version 2016-11-28 xxxvii Amazon Lightsail API Reference DnsRecordCreationState ......................................................................................................................... 863 Contents ............................................................................................................................................... 863 See Also ................................................................................................................................................ 864 Domain ....................................................................................................................................................... 865 Contents ............................................................................................................................................... 865 See Also ................................................................................................................................................ 867 DomainEntry ............................................................................................................................................. 868 Contents ............................................................................................................................................... 868 See Also ................................................................................................................................................ 870 DomainValidationRecord ........................................................................................................................ 871 Contents ............................................................................................................................................... 871 See Also ................................................................................................................................................ 872 EndpointRequest ...................................................................................................................................... 873 Contents ............................................................................................................................................... 873 See Also ................................................................................................................................................ 873 EstimateByTime ........................................................................................................................................ 874 Contents ............................................................................................................................................... 874 See Also ................................................................................................................................................ 875 ExportSnapshotRecord ............................................................................................................................ 876 Contents ............................................................................................................................................... 876 See Also ................................................................................................................................................ 877 ExportSnapshotRecordSourceInfo ........................................................................................................ 879 Contents ............................................................................................................................................... 879 See Also ................................................................................................................................................ 880 HeaderObject ............................................................................................................................................ 881 Contents ............................................................................................................................................... 881 See Also ................................................................................................................................................ 882 HostKeyAttributes .................................................................................................................................... 883 Contents ............................................................................................................................................... 883 See Also ................................................................................................................................................ 884 InputOrigin ................................................................................................................................................ 886 Contents ............................................................................................................................................... 886 See Also ................................................................................................................................................ 887 Instance ...................................................................................................................................................... 888 Contents ............................................................................................................................................... 888 See Also ................................................................................................................................................ 892 API Version 2016-11-28 xxxviii Amazon Lightsail API Reference InstanceAccessDetails .............................................................................................................................. 893 Contents ............................................................................................................................................... 893 See Also ................................................................................................................................................ 895 InstanceEntry ............................................................................................................................................ 896 Contents ............................................................................................................................................... 896 See Also ................................................................................................................................................ 898 InstanceHardware ..................................................................................................................................... 899 Contents ............................................................................................................................................... 899 See Also ................................................................................................................................................ 899 InstanceHealthSummary ........................................................................................................................ 900 Contents ............................................................................................................................................... 900 See Also ................................................................................................................................................ 901 InstanceMetadataOptions ...................................................................................................................... 903 Contents ............................................................................................................................................... 903 See Also ................................................................................................................................................ 904 InstanceNetworking ................................................................................................................................. 906 Contents ............................................................................................................................................... 906 See Also ................................................................................................................................................ 906 InstancePortInfo ....................................................................................................................................... 907 Contents ............................................................................................................................................... 907 See Also ................................................................................................................................................ 911 InstancePortState ..................................................................................................................................... 912 Contents ............................................................................................................................................... 912 See Also ................................................................................................................................................ 915 InstanceSnapshot ..................................................................................................................................... 916 Contents ............................................................................................................................................... 916 See Also ................................................................................................................................................ 919 InstanceSnapshotInfo .............................................................................................................................. 920 Contents ............................................................................................................................................... 920 See Also ................................................................................................................................................ 920 InstanceState ............................................................................................................................................ 922 Contents ............................................................................................................................................... 922 See Also ................................................................................................................................................ 922 KeyPair ........................................................................................................................................................ 923 Contents ............................................................................................................................................... 923 See Also ................................................................................................................................................ 924 API Version 2016-11-28 xxxix Amazon Lightsail API Reference LightsailDistribution ................................................................................................................................ 926 Contents ............................................................................................................................................... 926 See Also ................................................................................................................................................ 930 LoadBalancer ............................................................................................................................................. 931 Contents ............................................................................................................................................... 931 See Also ................................................................................................................................................ 935 LoadBalancerTlsCertiﬁcate ..................................................................................................................... 936 Contents ............................................................................................................................................... 936 See Also ................................................................................................................................................ 942 LoadBalancerTlsCertiﬁcateDnsRecordCreationState ......................................................................... 943 Contents ............................................................................................................................................... 943 See Also ................................................................................................................................................ 943 LoadBalancerTlsCertiﬁcateDomainValidationOption ........................................................................ 944 Contents ............................................................................................................................................... 944 See Also ................................................................................................................................................ 944 LoadBalancerTlsCertiﬁcateDomainValidationRecord ........................................................................ 945 Contents ............................................................................................................................................... 945 See Also ................................................................................................................................................ 946 LoadBalancerTlsCertiﬁcateRenewalSummary .................................................................................... 947 Contents ............................................................................................................................................... 947 See Also ................................................................................................................................................ 948 LoadBalancerTlsCertiﬁcateSummary ................................................................................................... 949 Contents ............................................................................................................................................... 949 See Also ................................................................................................................................................ 949 LoadBalancerTlsPolicy ............................................................................................................................. 950 Contents ............................................................................................................................................... 950 See Also ................................................................................................................................................ 951 LogEvent .................................................................................................................................................... 952 Contents ............................................................................................................................................... 952 See Also ................................................................................................................................................ 952 MetricDatapoint ........................................................................................................................................ 953 Contents ............................................................................................................................................... 953 See Also ................................................................................................................................................ 954 MonitoredResourceInfo ........................................................................................................................... 955 Contents ............................................................................................................................................... 955 See Also ................................................................................................................................................ 956 API Version 2016-11-28 xl Amazon Lightsail API Reference MonthlyTransfer ....................................................................................................................................... 957 Contents ............................................................................................................................................... 957 See Also ................................................................................................................................................ 957 NameServersUpdateState ...................................................................................................................... 958 Contents ............................................................................................................................................... 958 See Also ................................................................................................................................................ 958 Operation ................................................................................................................................................... 960 Contents ............................................................................................................................................... 960 See Also ................................................................................................................................................ 963 Origin .......................................................................................................................................................... 964 Contents ............................................................................................................................................... 964 See Also ................................................................................................................................................ 965 PasswordData ............................................................................................................................................ 966 Contents ............................................................................................................................................... 966 See Also ................................................................................................................................................ 967 PendingMaintenanceAction ................................................................................................................... 968 Contents ............................................................................................................................................... 968 See Also ................................................................................................................................................ 968 PendingModiﬁedRelationalDatabaseValues ....................................................................................... 970 Contents ............................................................................................................................................... 970 See Also ................................................................................................................................................ 970 PortInfo ...................................................................................................................................................... 971 Contents ............................................................................................................................................... 971 See Also ................................................................................................................................................ 974 PrivateRegistryAccess .............................................................................................................................. 975 Contents ............................................................................................................................................... 975 See Also ................................................................................................................................................ 975 PrivateRegistryAccessRequest ............................................................................................................... 976 Contents ............................................................................................................................................... 976 See Also ................................................................................................................................................ 976 QueryStringObject ................................................................................................................................... 977 Contents ............................................................................................................................................... 977 See Also ................................................................................................................................................ 977 R53HostedZoneDeletionState ............................................................................................................... 978 Contents ............................................................................................................................................... 978 See Also ................................................................................................................................................ 978 API Version 2016-11-28 xli Amazon Lightsail API Reference Region ......................................................................................................................................................... 980 Contents ............................................................................................................................................... 980 See Also ................................................................................................................................................ 981 RegisteredDomainDelegationInfo ......................................................................................................... 982 Contents ............................................................................................................................................... 982 See Also ................................................................................................................................................ 983 RelationalDatabase .................................................................................................................................. 984 Contents ............................................................................................................................................... 984 See Also ................................................................................................................................................ 989 RelationalDatabaseBlueprint ................................................................................................................. 990 Contents ............................................................................................................................................... 990 See Also ................................................................................................................................................ 991 RelationalDatabaseBundle ..................................................................................................................... 992 Contents ............................................................................................................................................... 992 See Also ................................................................................................................................................ 993 RelationalDatabaseEndpoint .................................................................................................................. 994 Contents ............................................................................................................................................... 994 See Also ................................................................................................................................................ 994 RelationalDatabaseEvent ........................................................................................................................ 995 Contents ............................................................................................................................................... 995 See Also ................................................................................................................................................ 995 RelationalDatabaseHardware ................................................................................................................. 997 Contents ............................................................................................................................................... 997 See Also ................................................................................................................................................ 997 RelationalDatabaseParameter ............................................................................................................... 998 Contents ............................................................................................................................................... 998 See Also ................................................................................................................................................ 999 RelationalDatabaseSnapshot ............................................................................................................... 1000 Contents ............................................................................................................................................. 1000 See Also .............................................................................................................................................. 1003 RenewalSummary .................................................................................................................................. 1004 Contents ............................................................................................................................................. 1004 See Also .............................................................................................................................................. 1005 ResourceBudgetEstimate ...................................................................................................................... 1006 Contents ............................................................................................................................................. 1006 See Also .............................................................................................................................................. 1007 API Version 2016-11-28 xlii Amazon Lightsail API Reference ResourceLocation ................................................................................................................................... 1008 Contents ............................................................................................................................................. 1008 See Also .............................................................................................................................................. 1008 ResourceReceivingAccess ...................................................................................................................... 1009 Contents ............................................................................................................................................. 1009 See Also .............................................................................................................................................. 1009 ResourceRecord ...................................................................................................................................... 1010 Contents ............................................................................................................................................. 1010 See Also .............................................................................................................................................. 1010 Session ..................................................................................................................................................... 1011 Contents ............................................................................................................................................. 1011 See Also .............................................................................................................................................. 1011 SetupExecutionDetails .......................................................................................................................... 1013 Contents ............................................................................................................................................. 1013 See Also .............................................................................................................................................. 1014 SetupHistory ........................................................................................................................................... 1015 Contents .............................................................................................................................................
amazon-lightsail-api-reference-009	amazon-lightsail-api-reference.pdf	9	Contents ............................................................................................................................................... 998 See Also ................................................................................................................................................ 999 RelationalDatabaseSnapshot ............................................................................................................... 1000 Contents ............................................................................................................................................. 1000 See Also .............................................................................................................................................. 1003 RenewalSummary .................................................................................................................................. 1004 Contents ............................................................................................................................................. 1004 See Also .............................................................................................................................................. 1005 ResourceBudgetEstimate ...................................................................................................................... 1006 Contents ............................................................................................................................................. 1006 See Also .............................................................................................................................................. 1007 API Version 2016-11-28 xlii Amazon Lightsail API Reference ResourceLocation ................................................................................................................................... 1008 Contents ............................................................................................................................................. 1008 See Also .............................................................................................................................................. 1008 ResourceReceivingAccess ...................................................................................................................... 1009 Contents ............................................................................................................................................. 1009 See Also .............................................................................................................................................. 1009 ResourceRecord ...................................................................................................................................... 1010 Contents ............................................................................................................................................. 1010 See Also .............................................................................................................................................. 1010 Session ..................................................................................................................................................... 1011 Contents ............................................................................................................................................. 1011 See Also .............................................................................................................................................. 1011 SetupExecutionDetails .......................................................................................................................... 1013 Contents ............................................................................................................................................. 1013 See Also .............................................................................................................................................. 1014 SetupHistory ........................................................................................................................................... 1015 Contents ............................................................................................................................................. 1015 See Also .............................................................................................................................................. 1016 SetupHistoryResource ........................................................................................................................... 1017 Contents ............................................................................................................................................. 1017 See Also .............................................................................................................................................. 1018 SetupRequest .......................................................................................................................................... 1019 Contents ............................................................................................................................................. 1019 See Also .............................................................................................................................................. 1020 StaticIp ..................................................................................................................................................... 1021 Contents ............................................................................................................................................. 1021 See Also .............................................................................................................................................. 1023 StopInstanceOnIdleRequest ................................................................................................................ 1024 Contents ............................................................................................................................................. 1024 See Also .............................................................................................................................................. 1024 Tag ............................................................................................................................................................ 1025 Contents ............................................................................................................................................. 1025 See Also .............................................................................................................................................. 1025 TimePeriod .............................................................................................................................................. 1026 Contents ............................................................................................................................................. 1026 See Also .............................................................................................................................................. 1026 API Version 2016-11-28 xliii Amazon Lightsail API Reference Lightsail for Research actions .................................................................................................. 1027 Object storage actions .............................................................................................................. 1031 Common Parameters ................................................................................................................. 1034 Common Errors .......................................................................................................................... 1037 API Version 2016-11-28 xliv Amazon Lightsail Welcome API Reference Amazon Lightsail is the easiest way to get started with Amazon Web Services (AWS) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, storage buckets, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price. You can manage your Lightsail resources using the Lightsail console, Lightsail API, AWS Command Line Interface (AWS CLI), or SDKs. For more information about Lightsail concepts and tasks, see the Amazon Lightsail Developer Guide. This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported AWS Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and Quotas in the AWS General Reference. This document was last published on May 14, 2025. API Version 2016-11-28 1 Amazon Lightsail Actions The following actions are supported: • AllocateStaticIp • AttachCertiﬁcateToDistribution • AttachDisk • AttachInstancesToLoadBalancer • AttachLoadBalancerTlsCertiﬁcate • AttachStaticIp • CloseInstancePublicPorts • CopySnapshot • CreateBucket • CreateBucketAccessKey • CreateCertiﬁcate • CreateCloudFormationStack • CreateContactMethod • CreateContainerService • CreateContainerServiceDeployment • CreateContainerServiceRegistryLogin • CreateDisk • CreateDiskFromSnapshot • CreateDiskSnapshot • CreateDistribution • CreateDomain • CreateDomainEntry • CreateGUISessionAccessDetails • CreateInstances • CreateInstancesFromSnapshot • CreateInstanceSnapshot • CreateKeyPair API Reference API Version 2016-11-28 2 Amazon Lightsail • CreateLoadBalancer • CreateLoadBalancerTlsCertiﬁcate • CreateRelationalDatabase • CreateRelationalDatabaseFromSnapshot • CreateRelationalDatabaseSnapshot • DeleteAlarm • DeleteAutoSnapshot • DeleteBucket • DeleteBucketAccessKey • DeleteCertiﬁcate • DeleteContactMethod • DeleteContainerImage • DeleteContainerService • DeleteDisk • DeleteDiskSnapshot • DeleteDistribution • DeleteDomain • DeleteDomainEntry • DeleteInstance • DeleteInstanceSnapshot • DeleteKeyPair • DeleteKnownHostKeys • DeleteLoadBalancer • DeleteLoadBalancerTlsCertiﬁcate • DeleteRelationalDatabase • DeleteRelationalDatabaseSnapshot • DetachCertiﬁcateFromDistribution • DetachDisk • DetachInstancesFromLoadBalancer • DetachStaticIp API Reference API Version 2016-11-28 3 Amazon Lightsail • DisableAddOn • DownloadDefaultKeyPair • EnableAddOn • ExportSnapshot • GetActiveNames • GetAlarms • GetAutoSnapshots • GetBlueprints • GetBucketAccessKeys • GetBucketBundles • GetBucketMetricData • GetBuckets • GetBundles • GetCertiﬁcates • GetCloudFormationStackRecords • GetContactMethods • GetContainerAPIMetadata • GetContainerImages • GetContainerLog • GetContainerServiceDeployments • GetContainerServiceMetricData • GetContainerServicePowers • GetContainerServices • GetCostEstimate • GetDisk • GetDisks • GetDiskSnapshot • GetDiskSnapshots • GetDistributionBundles • GetDistributionLatestCacheReset API Reference API Version 2016-11-28 4 Amazon Lightsail • GetDistributionMetricData • GetDistributions • GetDomain • GetDomains • GetExportSnapshotRecords • GetInstance • GetInstanceAccessDetails • GetInstanceMetricData • GetInstancePortStates • GetInstances • GetInstanceSnapshot • GetInstanceSnapshots • GetInstanceState • GetKeyPair • GetKeyPairs • GetLoadBalancer • GetLoadBalancerMetricData • GetLoadBalancers • GetLoadBalancerTlsCertiﬁcates • GetLoadBalancerTlsPolicies • GetOperation • GetOperations • GetOperationsForResource • GetRegions • GetRelationalDatabase • GetRelationalDatabaseBlueprints • GetRelationalDatabaseBundles • GetRelationalDatabaseEvents • GetRelationalDatabaseLogEvents • GetRelationalDatabaseLogStreams API Reference API Version 2016-11-28 5 Amazon Lightsail API Reference • GetRelationalDatabaseMasterUserPassword • GetRelationalDatabaseMetricData • GetRelationalDatabaseParameters • GetRelationalDatabases • GetRelationalDatabaseSnapshot • GetRelationalDatabaseSnapshots • GetSetupHistory • GetStaticIp • GetStaticIps • ImportKeyPair • IsVpcPeered • OpenInstancePublicPorts • PeerVpc • PutAlarm • PutInstancePublicPorts • RebootInstance • RebootRelationalDatabase • RegisterContainerImage • ReleaseStaticIp • ResetDistributionCache • SendContactMethodVeriﬁcation • SetIpAddressType • SetResourceAccessForBucket • SetupInstanceHttps • StartGUISession • StartInstance • StartRelationalDatabase • StopGUISession • StopInstance • StopRelationalDatabase API Version 2016-11-28 6 Amazon Lightsail • TagResource • TestAlarm • UnpeerVpc • UntagResource • UpdateBucket • UpdateBucketBundle • UpdateContainerService • UpdateDistribution • UpdateDistributionBundle • UpdateDomainEntry • UpdateInstanceMetadataOptions • UpdateLoadBalancerAttribute • UpdateRelationalDatabase • UpdateRelationalDatabaseParameters API Reference API Version 2016-11-28 7 API Reference Amazon Lightsail AllocateStaticIp Allocates a static IP address. Request Syntax { "staticIpName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. staticIpName The name of the static IP address. Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax
amazon-lightsail-api-reference-010	amazon-lightsail-api-reference.pdf	10	StopInstance • StopRelationalDatabase API Version 2016-11-28 6 Amazon Lightsail • TagResource • TestAlarm • UnpeerVpc • UntagResource • UpdateBucket • UpdateBucketBundle • UpdateContainerService • UpdateDistribution • UpdateDistributionBundle • UpdateDomainEntry • UpdateInstanceMetadataOptions • UpdateLoadBalancerAttribute • UpdateRelationalDatabase • UpdateRelationalDatabaseParameters API Reference API Version 2016-11-28 7 API Reference Amazon Lightsail AllocateStaticIp Allocates a static IP address. Request Syntax { "staticIpName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. staticIpName The name of the static IP address. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", AllocateStaticIp API Version 2016-11-28 8 Amazon Lightsail API Reference "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 9 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2016-11-28 10 Amazon Lightsail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 11 Amazon Lightsail API Reference AttachCertiﬁcateToDistribution Attaches an SSL/TLS certiﬁcate to your Amazon Lightsail content delivery network (CDN) distribution. After the certiﬁcate is attached, your distribution accepts HTTPS traﬃc for all of the domains that are associated with the certiﬁcate. Use the CreateCertificate action to create a certiﬁcate that you can attach to your distribution. Important Only certiﬁcates created in the us-east-1 AWS Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region. Request Syntax { "certificateName": "string", "distributionName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. certiﬁcateName The name of the certiﬁcate to attach to a distribution. Only certiﬁcates with a status of ISSUED can be attached to a distribution. Use the GetCertificates action to get a list of certiﬁcate names that you can specify. AttachCertiﬁcateToDistribution API Version 2016-11-28 12 Amazon Lightsail Note API Reference This is the name of the certiﬁcate resource type and is used only to reference the certiﬁcate in other API actions. It can be diﬀerent than the domain name of the certiﬁcate. For example, your certiﬁcate name might be WordPress-Blog- Certificate and the domain name of the certiﬁcate might be example.com. Type: String Pattern: \w[\w\-]\w Required: Yes distributionName The name of the distribution that the certiﬁcate will be attached to. Use the GetDistributions action to get a list of distribution names that you can specify. Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax { "operation": { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", Response Syntax API Version 2016-11-28 13 Amazon Lightsail API Reference "resourceType": "string", "status": "string", "statusChangedAt": number } } Response Elements If the action is successful, the service sends back
amazon-lightsail-api-reference-011	amazon-lightsail-api-reference.pdf	11	might be example.com. Type: String Pattern: \w[\w\-]\w Required: Yes distributionName The name of the distribution that the certiﬁcate will be attached to. Use the GetDistributions action to get a list of distribution names that you can specify. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "operation": { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", Response Syntax API Version 2016-11-28 13 Amazon Lightsail API Reference "resourceType": "string", "status": "string", "statusChangedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operation An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Operation object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. Response Elements API Version 2016-11-28 14 Amazon Lightsail HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. API Reference HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 15 Amazon Lightsail API Reference See Also API Version 2016-11-28 16 Amazon Lightsail AttachDisk API Reference Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the speciﬁed disk name. The attach disk operation supports tag-based access control via resource tags applied to the resource identiﬁed by disk name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "autoMounting": boolean, "diskName": "string", "diskPath": "string", "instanceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. autoMounting A Boolean value used to determine the automatic mounting of a storage volume to a virtual computer. The default value is False. Important This value only applies to Lightsail for Research resources. Type: Boolean Required: No diskName The unique Lightsail disk name (my-disk). AttachDisk API Version 2016-11-28 17 API Reference Amazon Lightsail Type: String Pattern: \w[\w\-]\w Required: Yes diskPath The disk path to expose to the instance (/dev/xvdf). Type: String Pattern: .\S.* Required: Yes instanceName The name of the Lightsail instance where you want to utilize the storage disk. Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", Response Syntax API Version 2016-11-28 18 Amazon Lightsail API Reference "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 19 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration
amazon-lightsail-api-reference-012	amazon-lightsail-api-reference.pdf	12	common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 19 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2016-11-28 20 Amazon Lightsail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 21 Amazon Lightsail API Reference AttachInstancesToLoadBalancer Attaches one or more Lightsail instances to a load balancer. After some time, the instances are attached to the load balancer and the health check status is available. The attach instances to load balancer operation supports tag-based access control via resource tags applied to the resource identiﬁed by load balancer name. For more information, see the Lightsail Developer Guide. Request Syntax { "instanceNames": [ "string" ], "loadBalancerName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. instanceNames An array of strings representing the instance name(s) you want to attach to your load balancer. An instance must be running before you can attach it to your load balancer. There are no additional limits on the number of instances you can attach to your load balancer, aside from the limit of Lightsail instances you can create in your account (20). Type: Array of strings Pattern: \w[\w\-]\w Required: Yes loadBalancerName The name of the load balancer. AttachInstancesToLoadBalancer API Version 2016-11-28 22 API Reference Amazon Lightsail Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Response Syntax API Version 2016-11-28 23 Amazon Lightsail Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. Errors API Version 2016-11-28 24 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK
amazon-lightsail-api-reference-013	amazon-lightsail-api-reference.pdf	13	ServiceException A general service exception. Errors API Version 2016-11-28 24 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 25 Amazon Lightsail API Reference AttachLoadBalancerTlsCertiﬁcate Attaches a Transport Layer Security (TLS) certiﬁcate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). Once you create and validate your certiﬁcate, you can attach it to your load balancer. You can also use this API to rotate the certiﬁcates on your account. Use the AttachLoadBalancerTlsCertificate action with the non-attached certiﬁcate, and it will replace the existing one and become the attached certiﬁcate. The AttachLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identiﬁed by load balancer name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "certificateName": "string", "loadBalancerName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. certiﬁcateName The name of your SSL/TLS certiﬁcate. Type: String Pattern: \w[\w\-]\w Required: Yes loadBalancerName The name of the load balancer to which you want to associate the SSL/TLS certiﬁcate. Type: String AttachLoadBalancerTlsCertiﬁcate API Version 2016-11-28 26 API Reference Amazon Lightsail Pattern: \w[\w\-]\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. These SSL/TLS certiﬁcates are only usable by Lightsail load balancers. You can't get the certiﬁcate and use it for another purpose. Response Syntax API Version 2016-11-28 27 Amazon Lightsail API Reference Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 Errors API Version 2016-11-28 28 Amazon Lightsail ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 29 Amazon Lightsail AttachStaticIp API Reference Attaches a static IP address to a speciﬁc Amazon Lightsail instance. Request Syntax { "instanceName": "string", "staticIpName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. instanceName The instance name to which you want to attach the static IP address. Type: String Pattern: \w[\w\-]\w Required: Yes staticIpName The name of the static IP. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { AttachStaticIp API Version 2016-11-28 30 API Reference Amazon Lightsail "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string",
amazon-lightsail-api-reference-014	amazon-lightsail-api-reference.pdf	14	{ "instanceName": "string", "staticIpName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. instanceName The instance name to which you want to attach the static IP address. Type: String Pattern: \w[\w\-]\w Required: Yes staticIpName The name of the static IP. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { AttachStaticIp API Version 2016-11-28 30 API Reference Amazon Lightsail "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. Response Elements API Version 2016-11-28 31 Amazon Lightsail HTTP Status Code: 400 AccountSetupInProgressException API Reference Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 Errors API Version 2016-11-28 32 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 33 Amazon Lightsail API Reference CloseInstancePublicPorts Closes ports for a speciﬁc Amazon Lightsail instance. The CloseInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identiﬁed by instanceName. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "instanceName": "string", "portInfo": { "cidrListAliases": [ "string" ], "cidrs": [ "string" ], "fromPort": number, "ipv6Cidrs": [ "string" ], "protocol": "string", "toPort": number } } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. instanceName The name of the instance for which to close ports. Type: String Pattern: \w[\w\-]*\w Required: Yes portInfo An object to describe the ports to close for the speciﬁed instance. Type: PortInfo object CloseInstancePublicPorts API Version 2016-11-28 34 API Reference Amazon Lightsail Required: Yes Response Syntax { "operation": { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operation An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Operation object Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2016-11-28 35 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP
amazon-lightsail-api-reference-015	amazon-lightsail-api-reference.pdf	15	cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 Errors API Version 2016-11-28 36 Amazon Lightsail UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 37 Amazon Lightsail CopySnapshot API Reference Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one AWS Region to another in Amazon Lightsail. When copying a manual snapshot, be sure to deﬁne the source region, source snapshot name, and target snapshot name parameters. When copying an automatic snapshot, be sure to deﬁne the source region, source resource name, target snapshot name, and either the restore date or the use latest restorable auto snapshot parameters. Request Syntax { "restoreDate": "string", "sourceRegion": "string", "sourceResourceName": "string", "sourceSnapshotName": "string", "targetSnapshotName": "string", "useLatestRestorableAutoSnapshot": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. restoreDate The date of the source automatic snapshot to copy. Use the get auto snapshots operation to identify the dates of the available automatic snapshots. Constraints: • Must be speciﬁed in YYYY-MM-DD format. CopySnapshot API Version 2016-11-28 38 Amazon Lightsail API Reference • This parameter cannot be deﬁned together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive. • Deﬁne this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide. Type: String Required: No sourceRegion The AWS Region where the source manual or automatic snapshot is located. Type: String Valid Values: us-east-1 \| us-east-2 \| us-west-1 \| us-west-2 \| eu-west-1 \| eu-west-2 \| eu-west-3 \| eu-central-1 \| ca-central-1 \| ap-south-1 \| ap- southeast-1 \| ap-southeast-2 \| ap-northeast-1 \| ap-northeast-2 \| eu- north-1 Required: Yes sourceResourceName The name of the source instance or disk from which the source automatic snapshot was created. Constraint: • Deﬁne this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide. Type: String Required: No sourceSnapshotName The name of the source manual snapshot to copy. Constraint: • Deﬁne this parameter only when copying a manual snapshot as another manual snapshot. Type: String Pattern: \w[\w\-]\w Request Parameters API Version 2016-11-28 39 Amazon Lightsail Required: No targetSnapshotName The name of the new manual snapshot to be created as a copy. API Reference Type: String Pattern: \w[\w\-]\w Required: Yes useLatestRestorableAutoSnapshot A Boolean value to indicate whether to use the latest available automatic snapshot of the speciﬁed source instance or disk. Constraints: • This parameter cannot be deﬁned together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive. • Deﬁne this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide. Type: Boolean Required: No Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", Response Syntax API Version 2016-11-28 40 Amazon Lightsail API Reference "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the
amazon-lightsail-api-reference-016	amazon-lightsail-api-reference.pdf	16	information, see the Amazon Lightsail Developer Guide. Type: Boolean Required: No Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", Response Syntax API Version 2016-11-28 40 Amazon Lightsail API Reference "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 41 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 Examples In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when Examples API Version 2016-11-28 42 Amazon Lightsail API Reference you conﬁgure the tools. When you use these tools, you don't need to learn how to sign requests yourself. Copy an automatic snapshot The following example creates a new manual snapshot named CopiedAutoSnapshot-2019-09-25 as a copy of the existing automatic snapshot named 2019-09-25 from the WordPress-1 instance in the us-west-2 AWS Region. Sample Request POST / HTTP/1.1 Host: lightsail.us-west-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: Lightsail_20161128.CopySnapshot Content-Type: application/x-amz-json-1.1 User-Agent: AGENT X-Amz-Date: 20190927T194244Z Authorization: AUTHPARAMS Content-Length: 150 { "sourceResourceName": "WordPress-1", "restoreDate": "2019-09-25", "targetSnapshotName": "CopiedAutoSnapshot-2019-09-25", "sourceRegion": "us-west-2" } Sample Response HTTP/1.1 200 OK Server: Server Date: Fri, 27 Sep 2019 19:42:46 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 380 x-amzn-RequestId: 69449102-9023-431e-8a00-7EXAMPLE6970 Connection: keep-alive { "operations": [{ "createdAt": 1.56961336589E9, "id": "0710de23-b848-4146-887d-ec12093c049d", Examples API Version 2016-11-28 43 Amazon Lightsail API Reference "isTerminal": false, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "operationDetails": "us-west-2:WordPress-1", "operationType": "CopySnapshot", "resourceName": "CopiedAutoSnapshot-2019-09-25", "resourceType": "InstanceSnapshot", "status": "Started", "statusChangedAt": 1.56961336589E9 }] } Copy a manual snapshot The following example creates a new manual snapshot named CopiedManualSnapshot-2019-09-25 as a copy of the existing manual snapshot named WordPress-1-1569608575 in the us-west-2 AWS Region. Sample Request POST / HTTP/1.1 Host: lightsail.us-west-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: Lightsail_20161128.CopySnapshot Content-Type: application/x-amz-json-1.1 User-Agent: AGENT X-Amz-Date: 20190927T195200Z Authorization: AUTHPARAMS Content-Length: 134 { "sourceSnapshotName": "WordPress-1-1569608575", "targetSnapshotName": "CopiedManualSnapshot-2019-09-25", "sourceRegion": "us-west-2" } Sample Response HTTP/1.1 200 OK Server: Server Examples API Version 2016-11-28 44 Amazon Lightsail API Reference Date: Fri, 27 Sep 2019 19:52:01 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 395 x-amzn-RequestId: 5e3e211b-0afe-439e-bead-8EXAMPLEb3c8 Connection: keep-alive { "operations": [{ "createdAt": 1.569613921044E9, "id": "0d4f2d2a-78ce-44d1-82fe-33588af9afa0", "isTerminal": false, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "operationDetails": "us-west-2:WordPress-1-1569608575", "operationType": "CopySnapshot", "resourceName": "CopiedManualSnapshot-2019-09-25", "resourceType": "InstanceSnapshot", "status": "Started", "statusChangedAt": 1.569613921044E9 }] } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 45 Amazon Lightsail API Reference See Also API Version 2016-11-28 46 Amazon Lightsail CreateBucket Creates an Amazon Lightsail bucket. API Reference A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such as data and its descriptive metadata. For more information about buckets, see Buckets in Amazon Lightsail in
amazon-lightsail-api-reference-017	amazon-lightsail-api-reference.pdf	17	for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 45 Amazon Lightsail API Reference See Also API Version 2016-11-28 46 Amazon Lightsail CreateBucket Creates an Amazon Lightsail bucket. API Reference A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such as data and its descriptive metadata. For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide. Request Syntax { "bucketName": "string", "bundleId": "string", "enableObjectVersioning": boolean, "tags": [ { "key": "string", "value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. bucketName The name for the bucket. For more information about bucket names, see Bucket naming rules in Amazon Lightsail in the Amazon Lightsail Developer Guide. Type: String Length Constraints: Minimum length of 3. Maximum length of 54. Pattern: ^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$ Required: Yes CreateBucket API Version 2016-11-28 47 Amazon Lightsail bundleId The ID of the bundle to use for the bucket. API Reference A bucket bundle speciﬁes the monthly cost, storage space, and data transfer quota for a bucket. Use the GetBucketBundles action to get a list of bundle IDs that you can specify. Use the UpdateBucketBundle action to change the bundle after the bucket is created. Type: String Pattern: .\S. Required: Yes enableObjectVersioning A Boolean value that indicates whether to enable versioning of objects in the bucket. For more information about versioning, see Enabling and suspending object versioning in a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide. Type: Boolean Required: No tags The tag keys and optional values to add to the bucket during creation. Use the TagResource action to tag the bucket after it's created. Type: Array of Tag objects Required: No Response Syntax { "bucket": { "ableToUpdateBundle": boolean, "accessLogConfig": { "destination": "string", "enabled": boolean, "prefix": "string" Response Syntax API Version 2016-11-28 48 API Reference Amazon Lightsail }, "accessRules": { "allowPublicOverrides": boolean, "getObject": "string" }, "arn": "string", "bundleId": "string", "createdAt": number, "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "objectVersioning": "string", "readonlyAccessAccounts": [ "string" ], "resourcesReceivingAccess": [ { "name": "string", "resourceType": "string" } ], "resourceType": "string", "state": { "code": "string", "message": "string" }, "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ], "url": "string" }, "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", Response Syntax API Version 2016-11-28 49 Amazon Lightsail API Reference "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. bucket An object that describes the bucket that is created. Type: Bucket object operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 Response Elements API Version 2016-11-28 50 Amazon Lightsail InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 See Also API Version 2016-11-28 51 Amazon Lightsail • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 52 Amazon Lightsail API Reference CreateBucketAccessKey Creates a new access key for the speciﬁed Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key. Access keys grant full programmatic access to the speciﬁed bucket and its objects. You can
amazon-lightsail-api-reference-018	amazon-lightsail-api-reference.pdf	18	• AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 See Also API Version 2016-11-28 51 Amazon Lightsail • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 52 Amazon Lightsail API Reference CreateBucketAccessKey Creates a new access key for the speciﬁed Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key. Access keys grant full programmatic access to the speciﬁed bucket and its objects. You can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a speciﬁc bucket. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide. Important The secretAccessKey value is returned only in response to the CreateBucketAccessKey action. You can get a secret access key only when you ﬁrst create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key. Request Syntax { "bucketName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. bucketName The name of the bucket that the new access key will belong to, and grant access to. Type: String Length Constraints: Minimum length of 3. Maximum length of 54. Pattern: ^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$ CreateBucketAccessKey API Version 2016-11-28 53 API Reference Amazon Lightsail Required: Yes Response Syntax { "accessKey": { "accessKeyId": "string", "createdAt": number, "lastUsed": { "lastUsedDate": number, "region": "string", "serviceName": "string" }, "secretAccessKey": "string", "status": "string" }, "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2016-11-28 54 Amazon Lightsail accessKey An object that describes the access key that is created. Type: AccessKey object operations API Reference An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 Errors API Version 2016-11-28 55 Amazon Lightsail ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 56 Amazon Lightsail CreateCertiﬁcate API Reference Creates an SSL/TLS certiﬁcate for an Amazon Lightsail content delivery network (CDN) distribution and a container service. After the certiﬁcate is valid, use the AttachCertificateToDistribution action to use the certiﬁcate and its domains with your distribution. Or use the UpdateContainerService action to use the certiﬁcate and its domains with your container service. Important Only certiﬁcates created in the us-east-1 AWS Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region. Request Syntax { "certificateName": "string", "domainName": "string", "subjectAlternativeNames": [ "string" ], "tags": [ { "key": "string", "value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. certiﬁcateName The name for the certiﬁcate. CreateCertiﬁcate API Version 2016-11-28 57 API Reference Amazon Lightsail Type: String Required: Yes
amazon-lightsail-api-reference-019	amazon-lightsail-api-reference.pdf	19	Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region. Request Syntax { "certificateName": "string", "domainName": "string", "subjectAlternativeNames": [ "string" ], "tags": [ { "key": "string", "value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. certiﬁcateName The name for the certiﬁcate. CreateCertiﬁcate API Version 2016-11-28 57 API Reference Amazon Lightsail Type: String Required: Yes domainName The domain name (example.com) for the certiﬁcate. Type: String Required: Yes subjectAlternativeNames An array of strings that specify the alternate domains (example2.com) and subdomains (blog.example.com) for the certiﬁcate. You can specify a maximum of nine alternate domains (in addition to the primary domain name). Wildcard domain entries (*.example.com) are not supported. Type: Array of strings Required: No tags The tag keys and optional values to add to the certiﬁcate during create. Use the TagResource action to tag a resource after it's created. Type: Array of Tag objects Required: No Response Syntax { "certificate": { "certificateArn": "string", "certificateDetail": { "arn": "string", "createdAt": number, "domainName": "string", "domainValidationRecords": [ Response Syntax API Version 2016-11-28 58 API Reference Amazon Lightsail { "dnsRecordCreationState": { "code": "string", "message": "string" }, "domainName": "string", "resourceRecord": { "name": "string", "type": "string", "value": "string" }, "validationStatus": "string" } ], "eligibleToRenew": "string", "inUseResourceCount": number, "issuedAt": number, "issuerCA": "string", "keyAlgorithm": "string", "name": "string", "notAfter": number, "notBefore": number, "renewalSummary": { "domainValidationRecords": [ { "dnsRecordCreationState": { "code": "string", "message": "string" }, "domainName": "string", "resourceRecord": { "name": "string", "type": "string", "value": "string" }, "validationStatus": "string" } ], "renewalStatus": "string", "renewalStatusReason": "string", "updatedAt": number }, "requestFailureReason": "string", "revocationReason": "string", Response Syntax API Version 2016-11-28 59 Amazon Lightsail API Reference "revokedAt": number, "serialNumber": "string", "status": "string", "subjectAlternativeNames": [ "string" ], "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ] }, "certificateName": "string", "domainName": "string", "tags": [ { "key": "string", "value": "string" } ] }, "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Syntax API Version 2016-11-28 60 Amazon Lightsail Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. certiﬁcate An object that describes the certiﬁcate created. Type: CertiﬁcateSummary object operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. Response Elements API Version 2016-11-28 61 Amazon Lightsail HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. API Reference HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 62 Amazon Lightsail API Reference CreateCloudFormationStack Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS CloudFormation stack created. Use the get cloud formation stack records operation to get a list of the CloudFormation stacks created. Important Wait until after your new Amazon EC2 instance is created before running the create cloud formation stack operation again with the same export snapshot record. Request Syntax { "instances": [ { "availabilityZone": "string", "instanceType": "string", "portInfoSource": "string", "sourceName": "string", "userData": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The
amazon-lightsail-api-reference-020	amazon-lightsail-api-reference.pdf	20	Lightsail snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS CloudFormation stack created. Use the get cloud formation stack records operation to get a list of the CloudFormation stacks created. Important Wait until after your new Amazon EC2 instance is created before running the create cloud formation stack operation again with the same export snapshot record. Request Syntax { "instances": [ { "availabilityZone": "string", "instanceType": "string", "portInfoSource": "string", "sourceName": "string", "userData": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. instances An array of parameters that will be used to create the new Amazon EC2 instance. You can only pass one instance entry at a time in this array. You will get an invalid parameter error if you pass more than one instance entry in this array. Type: Array of InstanceEntry objects CreateCloudFormationStack API Version 2016-11-28 63 API Reference Amazon Lightsail Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Response Syntax API Version 2016-11-28 64 Amazon Lightsail Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. Errors API Version 2016-11-28 65 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 66 Amazon Lightsail API Reference CreateContactMethod Creates an email or SMS text message contact method. A contact method is used to send you notiﬁcations about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notiﬁcations in Amazon Lightsail. Request Syntax { "contactEndpoint": "string", "protocol": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. contactEndpoint The destination of the contact method, such as an email address or a mobile phone number. Use the E.164 format when specifying a mobile phone number. E.164 is a standard for the phone number structure used for international telecommunication. Phone numbers that follow this format can have a maximum of 15 digits, and they are preﬁxed with the plus character (+) and the country code. For example, a U.S. phone number in E.164 format would be speciﬁed as +1XXX5550100. For more information, see E.164 on Wikipedia. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes protocol The protocol of the contact method, such as Email or SMS (text messaging). CreateContactMethod API Version 2016-11-28 67 Amazon Lightsail API Reference The SMS protocol is supported only in the following AWS Regions. • US East (N. Virginia) (us-east-1) • US West (Oregon) (us-west-2) • Europe (Ireland) (eu-west-1) • Asia Paciﬁc (Tokyo) (ap-northeast-1) • Asia
amazon-lightsail-api-reference-021	amazon-lightsail-api-reference.pdf	21	with the plus character (+) and the country code. For example, a U.S. phone number in E.164 format would be speciﬁed as +1XXX5550100. For more information, see E.164 on Wikipedia. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes protocol The protocol of the contact method, such as Email or SMS (text messaging). CreateContactMethod API Version 2016-11-28 67 Amazon Lightsail API Reference The SMS protocol is supported only in the following AWS Regions. • US East (N. Virginia) (us-east-1) • US West (Oregon) (us-west-2) • Europe (Ireland) (eu-west-1) • Asia Paciﬁc (Tokyo) (ap-northeast-1) • Asia Paciﬁc (Singapore) (ap-southeast-1) • Asia Paciﬁc (Sydney) (ap-southeast-2) For a list of countries/regions where SMS text messages can be sent, and the latest AWS Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer Guide. For more information about notiﬁcations in Amazon Lightsail, see Notiﬁcations in Amazon Lightsail. Type: String Valid Values: Email \| SMS Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", Response Syntax API Version 2016-11-28 68 Amazon Lightsail API Reference "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. Response Elements API Version 2016-11-28 69 Amazon Lightsail HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. API Reference HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 70 Amazon Lightsail API Reference See Also API Version 2016-11-28 71 Amazon Lightsail API Reference CreateContainerService Creates an Amazon Lightsail container service. A Lightsail container service is a compute resource to which you can deploy containers. For more information, see Container services in Amazon Lightsail in the Lightsail Dev Guide. Request Syntax { "deployment": { "containers": { "string" : { "command": [ "string" ], "environment": { "string" : "string" }, "image": "string", "ports": { "string" : "string" } } }, "publicEndpoint": { "containerName": "string", "containerPort": number, "healthCheck": { "healthyThreshold": number, "intervalSeconds": number, "path": "string", "successCodes": "string", "timeoutSeconds": number, "unhealthyThreshold": number } } }, "power": "string", "privateRegistryAccess": { "ecrImagePullerRole": { "isActive": boolean } }, "publicDomainNames": { CreateContainerService API Version 2016-11-28 72 Amazon Lightsail API Reference "string" : [ "string" ] }, "scale": number, "serviceName": "string", "tags": [ { "key": "string", "value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. deployment An object that describes a deployment for the container service. A deployment speciﬁes the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also speciﬁes the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check conﬁguration. Type: ContainerServiceDeploymentRequest object Required: No power The power speciﬁcation for the container service. The power speciﬁes the amount of memory, vCPUs, and base monthly cost of each node of the container service. The power and scale of a container service makes up its conﬁgured capacity. To
amazon-lightsail-api-reference-022	amazon-lightsail-api-reference.pdf	22	container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also speciﬁes the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check conﬁguration. Type: ContainerServiceDeploymentRequest object Required: No power The power speciﬁcation for the container service. The power speciﬁes the amount of memory, vCPUs, and base monthly cost of each node of the container service. The power and scale of a container service makes up its conﬁgured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service. Use the GetContainerServicePowers action to get a list of power options that you can specify using this parameter, and their base monthly cost. Request Parameters API Version 2016-11-28 73 Amazon Lightsail Type: String API Reference Valid Values: nano \| micro \| small \| medium \| large \| xlarge Required: Yes privateRegistryAccess An object to describe the conﬁguration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories. For more information, see Conﬁguring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide. Type: PrivateRegistryAccessRequest object Required: No publicDomainNames The public domain names to use with the container service, such as example.com and www.example.com. You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container conﬁgured as the public endpoint of your container service. If you don't specify public domain names, then you can use the default domain of the container service. Important You must create and validate an SSL/TLS certiﬁcate before you can use public domain names with your container service. Use the CreateCertificate action to create a certiﬁcate for the public domain names you want to use with your container service. You can specify public domain names using a string to array map as shown in the example later on this page. Type: String to array of strings map Request Parameters API Version 2016-11-28 74 Amazon Lightsail Required: No scale API Reference The scale speciﬁcation for the container service. The scale speciﬁes the allocated compute nodes of the container service. The power and scale of a container service makes up its conﬁgured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service. Type: Integer Valid Range: Minimum value of 1. Maximum value of 20. Required: Yes serviceName The name for the container service. The name that you specify for your container service will make up part of its default domain. The default domain of a container service is typically https:// <ServiceName>.<RandomGUID>.<AWSRegion>.cs.amazonlightsail.com. If the name of your container service is container-service-1, and it's located in the US East (Ohio) AWS Region (us-east-2), then the domain for your container service will be like the following example: https://container-service-1.ur4EXAMPLE2uq.us- east-2.cs.amazonlightsail.com The following are the requirements for container service names: • Must be unique within each AWS Region in your Lightsail account. • Must contain 1 to 63 characters. • Must contain only alphanumeric characters and hyphens. • A hyphen (-) can separate words but cannot be at the start or end of the name. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: ^[a-z0-9]{1,2}\|[a-z0-9][a-z0-9-]+[a-z0-9]$ Required: Yes Request Parameters API Version 2016-11-28 75 Amazon Lightsail tags API Reference The tag keys and optional values to add to the container service during create. Use the TagResource action to tag a resource after it's created. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide. Type: Array of Tag objects Required: No Response Syntax { "containerService": { "arn": "string", "containerServiceName": "string", "createdAt": number, "currentDeployment": { "containers": { "string" : { "command": [ "string" ], "environment": { "string" : "string" }, "image": "string", "ports": { "string" : "string" } } }, "createdAt": number, "publicEndpoint": { "containerName": "string", "containerPort": number, "healthCheck": { "healthyThreshold": number, "intervalSeconds": number, "path": "string", "successCodes": "string", "timeoutSeconds": number, "unhealthyThreshold": number Response Syntax API Version 2016-11-28 76 API Reference Amazon Lightsail } }, "state": "string", "version": number }, "isDisabled": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "nextDeployment": { "containers": { "string" : { "command": [ "string" ], "environment": { "string" : "string" }, "image": "string", "ports": { "string" : "string" } } }, "createdAt": number, "publicEndpoint": { "containerName": "string", "containerPort": number, "healthCheck": { "healthyThreshold": number, "intervalSeconds": number, "path": "string", "successCodes": "string", "timeoutSeconds": number, "unhealthyThreshold": number } }, "state": "string", "version": number }, "power": "string", "powerId": "string", "principalArn": "string",
amazon-lightsail-api-reference-023	amazon-lightsail-api-reference.pdf	23	"healthyThreshold": number, "intervalSeconds": number, "path": "string", "successCodes": "string", "timeoutSeconds": number, "unhealthyThreshold": number Response Syntax API Version 2016-11-28 76 API Reference Amazon Lightsail } }, "state": "string", "version": number }, "isDisabled": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "nextDeployment": { "containers": { "string" : { "command": [ "string" ], "environment": { "string" : "string" }, "image": "string", "ports": { "string" : "string" } } }, "createdAt": number, "publicEndpoint": { "containerName": "string", "containerPort": number, "healthCheck": { "healthyThreshold": number, "intervalSeconds": number, "path": "string", "successCodes": "string", "timeoutSeconds": number, "unhealthyThreshold": number } }, "state": "string", "version": number }, "power": "string", "powerId": "string", "principalArn": "string", "privateDomainName": "string", "privateRegistryAccess": { Response Syntax API Version 2016-11-28 77 Amazon Lightsail API Reference "ecrImagePullerRole": { "isActive": boolean, "principalArn": "string" } }, "publicDomainNames": { "string" : [ "string" ] }, "resourceType": "string", "scale": number, "state": "string", "stateDetail": { "code": "string", "message": "string" }, "tags": [ { "key": "string", "value": "string" } ], "url": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. containerService An object that describes a container service. Type: ContainerService object Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2016-11-28 78 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 Examples In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference. Examples API Version 2016-11-28 79 Amazon Lightsail API Reference You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you conﬁgure the tools. When you use these tools, you don't need to learn how to sign requests yourself. Create container service The following example creates a new container service named container-service-1 in the us-west-2 AWS Region. It also speciﬁes the example.com, applications.example.com, www.example.com, and containers.example.com public domains of the example-com SSL/ TLS certiﬁcate. Sample Request POST / HTTP/1.1 Host: lightsail.us-west-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: Lightsail_20161128.CreateContainerService Content-Type: application/x-amz-json-1.1 User-Agent: AGENT X-Amz-Date: 20201022T175000Z Authorization: AUTHPARAMS Content-Length: 195 { "serviceName": "container-service-1", "power": "nano", "scale": 1, "publicDomainNames": { "example-com": [ "example.com", "applications.example.com", "www.example.com", "containers.example.com" ] } } Sample Response HTTP/1.1 200 OK Examples API Version 2016-11-28 80 Amazon Lightsail Server: Server Date: Thu, 22 Oct 2020 17:50:03 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 689 x-amzn-RequestId: 0459d37f-f6a7-4786-bc26-9EXAMPLEea99 Connection: keep-alive { "containerService": { API Reference "arn": "arn:aws:lightsail:us-west-2:111122223333:ContainerService/9059c34a- f681-482f-b41d-0EXAMPLEc85e", "containerServiceName": "container-service-1", "createdAt": 1.603389001E9, "isDisabled": false, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "power": "nano", "powerId": "nano-1", "principalArn": "", "privateDomainName": "container-service-1.service.local", "publicDomainNames": { "example-com": [ "example.com", "applications.example.com", "www.example.com", "containers.example.com" ] }, "resourceType": "ContainerService", "scale": 1, "state": "PENDING", "tags": [], "url": "https://container-service-1.ur1EXAMPLE2uq.us- west-2.cs.amazonlightsail.com/" } } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2016-11-28 81 API Reference Amazon Lightsail • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 82 Amazon Lightsail API Reference CreateContainerServiceDeployment Creates a deployment for your Amazon Lightsail container service. A deployment speciﬁes the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also speciﬁes the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check conﬁguration. You can deploy containers to your container service using container images from a public registry such as Amazon ECR Public,
amazon-lightsail-api-reference-024	amazon-lightsail-api-reference.pdf	24	82 Amazon Lightsail API Reference CreateContainerServiceDeployment Creates a deployment for your Amazon Lightsail container service. A deployment speciﬁes the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also speciﬁes the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check conﬁguration. You can deploy containers to your container service using container images from a public registry such as Amazon ECR Public, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Amazon Lightsail Developer Guide. Request Syntax { "containers": { "string" : { "command": [ "string" ], "environment": { "string" : "string" }, "image": "string", "ports": { "string" : "string" } } }, "publicEndpoint": { "containerName": "string", "containerPort": number, "healthCheck": { "healthyThreshold": number, "intervalSeconds": number, "path": "string", "successCodes": "string", "timeoutSeconds": number, "unhealthyThreshold": number } }, "serviceName": "string" CreateContainerServiceDeployment API Version 2016-11-28 83 Amazon Lightsail } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. containers An object that describes the settings of the containers that will be launched on the container service. Type: String to Container object map Key Length Constraints: Minimum length of 1. Maximum length of 53. Key Pattern: ^[a-z0-9]{1,2}\|[a-z0-9][a-z0-9-]+[a-z0-9]$ Required: No publicEndpoint An object that describes the settings of the public endpoint for the container service. Type: EndpointRequest object Required: No serviceName The name of the container service for which to create the deployment. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: ^[a-z0-9]{1,2}\|[a-z0-9][a-z0-9-]+[a-z0-9]$ Required: Yes Response Syntax { "containerService": { Request Parameters API Version 2016-11-28 84 Amazon Lightsail API Reference "arn": "string", "containerServiceName": "string", "createdAt": number, "currentDeployment": { "containers": { "string" : { "command": [ "string" ], "environment": { "string" : "string" }, "image": "string", "ports": { "string" : "string" } } }, "createdAt": number, "publicEndpoint": { "containerName": "string", "containerPort": number, "healthCheck": { "healthyThreshold": number, "intervalSeconds": number, "path": "string", "successCodes": "string", "timeoutSeconds": number, "unhealthyThreshold": number } }, "state": "string", "version": number }, "isDisabled": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "nextDeployment": { "containers": { "string" : { "command": [ "string" ], "environment": { "string" : "string" }, Response Syntax API Version 2016-11-28 85 Amazon Lightsail API Reference "image": "string", "ports": { "string" : "string" } } }, "createdAt": number, "publicEndpoint": { "containerName": "string", "containerPort": number, "healthCheck": { "healthyThreshold": number, "intervalSeconds": number, "path": "string", "successCodes": "string", "timeoutSeconds": number, "unhealthyThreshold": number } }, "state": "string", "version": number }, "power": "string", "powerId": "string", "principalArn": "string", "privateDomainName": "string", "privateRegistryAccess": { "ecrImagePullerRole": { "isActive": boolean, "principalArn": "string" } }, "publicDomainNames": { "string" : [ "string" ] }, "resourceType": "string", "scale": number, "state": "string", "stateDetail": { "code": "string", "message": "string" }, "tags": [ { Response Syntax API Version 2016-11-28 86 Amazon Lightsail API Reference "key": "string", "value": "string" } ], "url": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. containerService An object that describes a container service. Type: ContainerService object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. Response Elements API Version 2016-11-28 87 Amazon Lightsail HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. API Reference HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 88 Amazon Lightsail API Reference CreateContainerServiceRegistryLogin Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine.
amazon-lightsail-api-reference-025	amazon-lightsail-api-reference.pdf	25	API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 88 Amazon Lightsail API Reference CreateContainerServiceRegistryLogin Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials. Note You can only push container images to the container service registry of your Lightsail account. You cannot pull container images or perform any other container image management actions on the container service registry. After you push your container images to the container image registry of your Lightsail account, use the RegisterContainerImage action to register the pushed images to a speciﬁc Lightsail container service. Note This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide. Response Syntax { "registryLogin": { "expiresAt": number, "password": "string", "registry": "string", "username": "string" } } CreateContainerServiceRegistryLogin API Version 2016-11-28 89 Amazon Lightsail Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. registryLogin An object that describes the log in information for the container service registry of your Lightsail account. Type: ContainerServiceRegistryLogin object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. Response Elements API Version 2016-11-28 90 Amazon Lightsail HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 91 Amazon Lightsail CreateDisk API Reference Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a). The create disk operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "addOns": [ { "addOnType": "string", "autoSnapshotAddOnRequest": { "snapshotTimeOfDay": "string" }, "stopInstanceOnIdleRequest": { "duration": "string", "threshold": "string" } } ], "availabilityZone": "string", "diskName": "string", "sizeInGb": number, "tags": [ { "key": "string", "value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CreateDisk API Version 2016-11-28 92 Amazon Lightsail addOns API Reference An array of objects that represent the add-ons to enable for the new disk. Type: Array of AddOnRequest objects Required: No availabilityZone The Availability Zone where you want to create the disk (us-east-2a). Use the same Availability Zone as the Lightsail instance to which you want to attach the disk. Use the get regions operation to list the Availability Zones where Lightsail is currently available. Type: String Pattern: .\S. Required: Yes diskName The unique Lightsail disk name (my-disk). Type: String Pattern: \w[\w\-]*\w Required: Yes sizeInGb The size of the disk in GB (32). Type: Integer Required: Yes tags The tag keys and optional values to add to the resource during create. Request Parameters API Version 2016-11-28
amazon-lightsail-api-reference-026	amazon-lightsail-api-reference.pdf	26	of AddOnRequest objects Required: No availabilityZone The Availability Zone where you want to create the disk (us-east-2a). Use the same Availability Zone as the Lightsail instance to which you want to attach the disk. Use the get regions operation to list the Availability Zones where Lightsail is currently available. Type: String Pattern: .\S. Required: Yes diskName The unique Lightsail disk name (my-disk). Type: String Pattern: \w[\w\-]\w Required: Yes sizeInGb The size of the disk in GB (32). Type: Integer Required: Yes tags The tag keys and optional values to add to the resource during create. Request Parameters API Version 2016-11-28 93 Amazon Lightsail API Reference Use the TagResource action to tag a resource after it's created. Type: Array of Tag objects Required: No Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Response Syntax API Version 2016-11-28 94 Amazon Lightsail Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. Errors API Version 2016-11-28 95 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 96 Amazon Lightsail API Reference CreateDiskFromSnapshot Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a). The create disk from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identiﬁed by disk snapshot name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "addOns": [ { "addOnType": "string", "autoSnapshotAddOnRequest": { "snapshotTimeOfDay": "string" }, "stopInstanceOnIdleRequest": { "duration": "string", "threshold": "string" } } ], "availabilityZone": "string", "diskName": "string", "diskSnapshotName": "string", "restoreDate": "string", "sizeInGb": number, "sourceDiskName": "string", "tags": [ { "key": "string", "value": "string" } ], "useLatestRestorableAutoSnapshot": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. CreateDiskFromSnapshot API Version 2016-11-28 97 Amazon Lightsail API Reference The request accepts the following data in JSON format. addOns An array of objects that represent the add-ons to enable for the new disk. Type: Array of AddOnRequest objects Required: No availabilityZone The Availability Zone where you want to create the disk (us-east-2a). Choose the same Availability Zone as the Lightsail instance where you want to create the disk. Use the GetRegions operation to list the Availability Zones where Lightsail is currently available. Type: String Pattern: .\S.* Required: Yes diskName The unique Lightsail disk name (my-disk). Type: String Pattern: \w[\w\-]\w Required: Yes diskSnapshotName The name of the disk snapshot (my-snapshot) from which to create the new storage disk. Constraint: • This parameter cannot be deﬁned together with the source disk name parameter. The disk snapshot name and source disk name parameters are mutually exclusive. Type: String Pattern: \w[\w\-]\w Request Parameters API Version 2016-11-28 98 Amazon Lightsail Required: No restoreDate API Reference The date of the automatic snapshot to use for the new disk. Use the get auto snapshots operation to identify
amazon-lightsail-api-reference-027	amazon-lightsail-api-reference.pdf	27	currently available. Type: String Pattern: .\S. Required: Yes diskName The unique Lightsail disk name (my-disk). Type: String Pattern: \w[\w\-]\w Required: Yes diskSnapshotName The name of the disk snapshot (my-snapshot) from which to create the new storage disk. Constraint: • This parameter cannot be deﬁned together with the source disk name parameter. The disk snapshot name and source disk name parameters are mutually exclusive. Type: String Pattern: \w[\w\-]\w Request Parameters API Version 2016-11-28 98 Amazon Lightsail Required: No restoreDate API Reference The date of the automatic snapshot to use for the new disk. Use the get auto snapshots operation to identify the dates of the available automatic snapshots. Constraints: • Must be speciﬁed in YYYY-MM-DD format. • This parameter cannot be deﬁned together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive. • Deﬁne this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide. Type: String Required: No sizeInGb The size of the disk in GB (32). Type: Integer Required: Yes sourceDiskName The name of the source disk from which the source automatic snapshot was created. Constraints: • This parameter cannot be deﬁned together with the disk snapshot name parameter. The source disk name and disk snapshot name parameters are mutually exclusive. • Deﬁne this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide. Type: String Required: No Request Parameters API Version 2016-11-28 99 Amazon Lightsail tags API Reference The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created. Type: Array of Tag objects Required: No useLatestRestorableAutoSnapshot A Boolean value to indicate whether to use the latest available automatic snapshot. Constraints: • This parameter cannot be deﬁned together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive. • Deﬁne this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide. Type: Boolean Required: No Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", Response Syntax API Version 2016-11-28 100 Amazon Lightsail API Reference "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 101 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2016-11-28 102 Amazon Lightsail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 103 Amazon Lightsail API Reference CreateDiskSnapshot Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance. You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot
amazon-lightsail-api-reference-028	amazon-lightsail-api-reference.pdf	28	• AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 103 Amazon Lightsail API Reference CreateDiskSnapshot Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance. You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any ﬁle systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all ﬁle writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending. You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just deﬁne the instance name parameter when issuing the snapshot command, and a snapshot of the deﬁned instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk. The create disk snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "diskName": "string", "diskSnapshotName": "string", "instanceName": "string", "tags": [ { "key": "string", "value": "string" } ] } CreateDiskSnapshot API Version 2016-11-28 104 Amazon Lightsail Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. diskName The unique name of the source disk (Disk-Virginia-1). Note This parameter cannot be deﬁned together with the instance name parameter. The disk name and instance name parameters are mutually exclusive. Type: String Pattern: \w[\w\-]\w Required: No diskSnapshotName The name of the destination disk snapshot (my-disk-snapshot) based on the source disk. Type: String Pattern: \w[\w\-]\w Required: Yes instanceName The unique name of the source instance (Amazon_Linux-512MB-Virginia-1). When this is deﬁned, a snapshot of the instance's system volume is created. Note This parameter cannot be deﬁned together with the disk name parameter. The instance name and disk name parameters are mutually exclusive. Request Parameters API Version 2016-11-28 105 Amazon Lightsail Type: String Pattern: \w[\w\-]*\w Required: No tags The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created. API Reference Type: Array of Tag objects Required: No Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Syntax API Version 2016-11-28 106 Amazon Lightsail API Reference The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. Errors API Version 2016-11-28 107 Amazon Lightsail HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. API Reference HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception
amazon-lightsail-api-reference-029	amazon-lightsail-api-reference.pdf	29	user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. Errors API Version 2016-11-28 107 Amazon Lightsail HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. API Reference HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 108 Amazon Lightsail CreateDistribution API Reference Creates an Amazon Lightsail content delivery network (CDN) distribution. A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see Content delivery networks in Amazon Lightsail. Request Syntax { "bundleId": "string", "cacheBehaviors": [ { "behavior": "string", "path": "string" } ], "cacheBehaviorSettings": { "allowedHTTPMethods": "string", "cachedHTTPMethods": "string", "defaultTTL": number, "forwardedCookies": { "cookiesAllowList": [ "string" ], "option": "string" }, "forwardedHeaders": { "headersAllowList": [ "string" ], "option": "string" }, "forwardedQueryStrings": { "option": boolean, "queryStringsAllowList": [ "string" ] }, "maximumTTL": number, "minimumTTL": number }, "certificateName": "string", "defaultCacheBehavior": { "behavior": "string" }, "distributionName": "string", "ipAddressType": "string", CreateDistribution API Version 2016-11-28 109 API Reference Amazon Lightsail "origin": { "name": "string", "protocolPolicy": "string", "regionName": "string", "responseTimeout": number }, "tags": [ { "key": "string", "value": "string" } ], "viewerMinimumTlsProtocolVersion": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. bundleId The bundle ID to use for the distribution. A distribution bundle describes the speciﬁcations of your distribution, such as the monthly cost and monthly network transfer quota. Use the GetDistributionBundles action to get a list of distribution bundle IDs that you can specify. Type: String Required: Yes cacheBehaviors An array of objects that describe the per-path cache behavior for the distribution. Type: Array of CacheBehaviorPerPath objects Required: No cacheBehaviorSettings An object that describes the cache behavior settings for the distribution. Request Parameters API Version 2016-11-28 110 Amazon Lightsail Type: CacheSettings object Required: No certiﬁcateName API Reference The name of the SSL/TLS certiﬁcate that you want to attach to the distribution. Use the GetCertiﬁcates action to get a list of certiﬁcate names that you can specify. Type: String Pattern: \w[\w\-]\w Required: No defaultCacheBehavior An object that describes the default cache behavior for the distribution. Type: CacheBehavior object Required: Yes distributionName The name for the distribution. Type: String Pattern: \w[\w\-]\w Required: Yes ipAddressType The IP address type for the distribution. The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. The default value is dualstack. Type: String Valid Values: dualstack \| ipv4 \| ipv6 Required: No Request Parameters API Version 2016-11-28 111 Amazon Lightsail origin API Reference An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer. The distribution pulls, caches, and serves content from the origin. Type: InputOrigin object Required: Yes tags The tag keys and optional values to add to the distribution during create. Use the TagResource action to tag a resource after it's created. Type: Array of Tag objects Required: No viewerMinimumTlsProtocolVersion The minimum TLS protocol version for the SSL/TLS certiﬁcate. Type: String Valid Values: TLSv1.1_2016 \| TLSv1.2_2018 \| TLSv1.2_2019 \| TLSv1.2_2021 Required: No Response Syntax { "distribution": { "ableToUpdateBundle": boolean, "alternativeDomainNames": [ "string" ], "arn": "string", "bundleId": "string", "cacheBehaviors": [ { "behavior": "string", "path": "string" } ], Response Syntax API Version 2016-11-28 112 Amazon Lightsail API Reference "cacheBehaviorSettings": { "allowedHTTPMethods": "string", "cachedHTTPMethods": "string", "defaultTTL": number, "forwardedCookies": { "cookiesAllowList": [ "string" ], "option": "string" }, "forwardedHeaders": { "headersAllowList": [ "string" ], "option": "string" }, "forwardedQueryStrings": { "option": boolean, "queryStringsAllowList": [ "string" ] }, "maximumTTL": number, "minimumTTL": number }, "certificateName": "string", "createdAt": number, "defaultCacheBehavior": { "behavior": "string" }, "domainName": "string", "ipAddressType": "string", "isEnabled": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "origin": { "name": "string", "protocolPolicy": "string", "regionName": "string", "resourceType": "string", "responseTimeout": number }, "originPublicDNS": "string", "resourceType": "string", "status": "string", "supportCode": "string", "tags": [ Response Syntax API Version 2016-11-28 113 Amazon Lightsail API Reference { "key": "string", "value": "string" } ], "viewerMinimumTlsProtocolVersion":
amazon-lightsail-api-reference-030	amazon-lightsail-api-reference.pdf	30	"string", "defaultTTL": number, "forwardedCookies": { "cookiesAllowList": [ "string" ], "option": "string" }, "forwardedHeaders": { "headersAllowList": [ "string" ], "option": "string" }, "forwardedQueryStrings": { "option": boolean, "queryStringsAllowList": [ "string" ] }, "maximumTTL": number, "minimumTTL": number }, "certificateName": "string", "createdAt": number, "defaultCacheBehavior": { "behavior": "string" }, "domainName": "string", "ipAddressType": "string", "isEnabled": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "origin": { "name": "string", "protocolPolicy": "string", "regionName": "string", "resourceType": "string", "responseTimeout": number }, "originPublicDNS": "string", "resourceType": "string", "status": "string", "supportCode": "string", "tags": [ Response Syntax API Version 2016-11-28 113 Amazon Lightsail API Reference { "key": "string", "value": "string" } ], "viewerMinimumTlsProtocolVersion": "string" }, "operation": { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. distribution An object that describes the distribution created. Type: LightsailDistribution object operation An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Operation object Response Elements API Version 2016-11-28 114 Amazon Lightsail Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. Errors API Version 2016-11-28 115 Amazon Lightsail HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 116 Amazon Lightsail CreateDomain API Reference Creates a domain resource for the speciﬁed domain (example.com). The create domain operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "domainName": "string", "tags": [ { "key": "string", "value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. domainName The domain name to manage (example.com). Type: String Required: Yes tags The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created. Type: Array of Tag objects Required: No CreateDomain API Version 2016-11-28 117 API Reference Amazon Lightsail Response Syntax { "operation": { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operation An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Operation object Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2016-11-28 118 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when
amazon-lightsail-api-reference-031	amazon-lightsail-api-reference.pdf	31	throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 Errors API Version 2016-11-28 119 Amazon Lightsail UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 120 Amazon Lightsail CreateDomainEntry API Reference Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT). The create domain entry operation supports tag-based access control via resource tags applied to the resource identiﬁed by domain name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "domainEntry": { "id": "string", "isAlias": boolean, "name": "string", "options": { "string" : "string" }, "target": "string", "type": "string" }, "domainName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. domainEntry An array of key-value pairs containing information about the domain entry request. Type: DomainEntry object Required: Yes domainName The domain name (example.com) for which you want to create the domain entry. CreateDomainEntry API Version 2016-11-28 121 API Reference Amazon Lightsail Type: String Required: Yes Response Syntax { "operation": { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operation An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Operation object Response Syntax API Version 2016-11-28 122 Amazon Lightsail Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. Errors API Version 2016-11-28 123 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 124 Amazon Lightsail API Reference CreateGUISessionAccessDetails Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based Amazon DCV session to the virtual computer's application. The
amazon-lightsail-api-reference-032	amazon-lightsail-api-reference.pdf	32	see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 124 Amazon Lightsail API Reference CreateGUISessionAccessDetails Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based Amazon DCV session to the virtual computer's application. The secondary URL initiates a web-based Amazon DCV session to the virtual computer's operating session. Use StartGUISession to open the session. Request Syntax { "resourceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. resourceName The resource name. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "failureReason": "string", "percentageComplete": number, "resourceName": "string", "sessions": [ { CreateGUISessionAccessDetails API Version 2016-11-28 125 Amazon Lightsail API Reference "isPrimary": boolean, "name": "string", "url": "string" } ], "status": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. failureReason The reason the operation failed. Type: String percentageComplete The percentage of completion for the operation. Type: Integer resourceName The resource name. Type: String Pattern: \w[\w\-]\w sessions Returns information about the speciﬁed Amazon DCV GUI session. Type: Array of Session objects status The status of the operation. Type: String Response Elements API Version 2016-11-28 126 Amazon Lightsail API Reference Valid Values: startExpired \| notStarted \| started \| starting \| stopped \| stopping \| settingUpInstance \| failedInstanceCreation \| failedStartingGUISession \| failedStoppingGUISession Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. Errors API Version 2016-11-28 127 Amazon Lightsail HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 128 Amazon Lightsail CreateInstances Creates one or more Amazon Lightsail instances. API Reference The create instances operation supports tag-based access control via request tags. For more information, see the Lightsail Developer Guide. Request Syntax { "addOns": [ { "addOnType": "string", "autoSnapshotAddOnRequest": { "snapshotTimeOfDay": "string" }, "stopInstanceOnIdleRequest": { "duration": "string", "threshold": "string" } } ], "availabilityZone": "string", "blueprintId": "string", "bundleId": "string", "customImageName": "string", "instanceNames": [ "string" ], "ipAddressType": "string", "keyPairName": "string", "tags": [ { "key": "string", "value": "string" } ], "userData": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. CreateInstances API Version 2016-11-28 129 Amazon Lightsail API Reference The request accepts the following data in JSON format. addOns An array of objects representing the add-ons to enable for the new instance. Type: Array of AddOnRequest objects Required: No availabilityZone The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones parameter to your request. Type: String Required: Yes blueprintId The ID for a virtual private server image (app_wordpress_x_x or app_lamp_x_x). Use the get blueprints operation to return a list of available images (or blueprints). Note Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases. Type: String Pattern: .\S. Required: Yes bundleId The bundle of speciﬁcation information for your virtual private server (or instance), including the pricing plan (medium_x_x). Request Parameters API Version
amazon-lightsail-api-reference-033	amazon-lightsail-api-reference.pdf	33	Required: Yes blueprintId The ID for a virtual private server image (app_wordpress_x_x or app_lamp_x_x). Use the get blueprints operation to return a list of available images (or blueprints). Note Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases. Type: String Pattern: .\S. Required: Yes bundleId The bundle of speciﬁcation information for your virtual private server (or instance), including the pricing plan (medium_x_x). Request Parameters API Version 2016-11-28 130 Amazon Lightsail Type: String Pattern: .\S. Required: Yes customImageName API Reference This parameter has been deprecated. (Discontinued) The name for your custom image. Note In releases prior to June 12, 2017, this parameter was ignored by the API. It is now discontinued. Type: String Pattern: \w[\w\-]\w Required: No instanceNames The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: ["MyFirstInstance","MySecondInstance"] Type: Array of strings Required: Yes ipAddressType The IP address type for the instance. The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6. The default value is dualstack. Type: String Request Parameters API Version 2016-11-28 131 Amazon Lightsail API Reference Valid Values: dualstack \| ipv4 \| ipv6 Required: No keyPairName The name of your key pair. Type: String Pattern: \w[\w\-]\w Required: No tags The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created. Type: Array of Tag objects Required: No userData A launch script you can create that conﬁgures a server with additional user data. For example, you might want to run apt-get -y update. Note Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail Developer Guide. Type: String Required: No Response Syntax { Response Syntax API Version 2016-11-28 132 API Reference Amazon Lightsail "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. Response Elements API Version 2016-11-28 133 Amazon Lightsail HTTP Status Code: 400 AccountSetupInProgressException API Reference Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 Errors API Version 2016-11-28 134 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 135 Amazon Lightsail API Reference CreateInstancesFromSnapshot Creates one or more new instances from a manual or automatic snapshot of an instance. The create instances from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identiﬁed by instance snapshot name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "addOns": [ { "addOnType": "string", "autoSnapshotAddOnRequest": { "snapshotTimeOfDay": "string" }, "stopInstanceOnIdleRequest": { "duration": "string", "threshold": "string" } } ], "attachedDiskMapping": { "string" :

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.