id
stringlengths 8
78
| source
stringclasses 743
values | chunk_id
int64 1
5.05k
| text
stringlengths 593
49.7k
|
|---|---|---|---|
amazon-lightsail-api-reference-134 | amazon-lightsail-api-reference.pdf | 134 | API Version 2016-11-28 678 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-specific 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 679 Amazon Lightsail TagResource API Reference Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Amazon Lightsail Developer Guide. The tag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "resourceArn": "string", "resourceName": "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. resourceArn The Amazon Resource Name (ARN) of the resource to which you want to add a tag. Type: String Pattern: ^arn:(aws[^:]*):([a-zA-Z0-9-]+):([a-z0-9-]+):([0-9]+):([a-zA-Z]+)/ ([a-zA-Z0-9-]+)$ Required: No resourceName The name of the resource to which you are adding tags. TagResource API Version 2016-11-28 680 API Reference Amazon Lightsail Type: String Pattern: \w[\w\-]*\w Required: Yes tags The tag key and optional value. Type: Array of Tag objects 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. Response Syntax API Version 2016-11-28 681 Amazon Lightsail 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 affected 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 field. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot find a resource. HTTP Status Code: 400 Errors API Version 2016-11-28 682 Amazon Lightsail OperationFailureException API Reference 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-specific 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 683 Amazon Lightsail TestAlarm API Reference Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (Email and/or SMS) configured for the alarm. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail. Request Syntax { "alarmName": "string", "state": "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. alarmName The name of the alarm to test. Type: String Pattern: \w[\w\-]*\w |
amazon-lightsail-api-reference-135 | amazon-lightsail-api-reference.pdf | 135 | protocol (Email and/or SMS) configured for the alarm. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail. Request Syntax { "alarmName": "string", "state": "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. alarmName The name of the alarm to test. Type: String Pattern: \w[\w\-]*\w Required: Yes state The alarm state to test. An alarm has the following possible states that can be tested: • ALARM - The metric is outside of the defined threshold. • INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state. TestAlarm API Version 2016-11-28 684 Amazon Lightsail API Reference • OK - The metric is within the defined threshold. Type: String Valid Values: OK | ALARM | INSUFFICIENT_DATA 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 affected by the request. Response Syntax API Version 2016-11-28 685 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 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot find 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 686 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-specific 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 687 API Reference Amazon Lightsail UnpeerVpc Unpeers the Lightsail VPC from the user's default VPC. 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 affected by the request. Type: Operation object Errors For information about the errors that are common to all actions, see Common Errors. UnpeerVpc API Version 2016-11-28 688 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 field. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot find 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: |
amazon-lightsail-api-reference-136 | amazon-lightsail-api-reference.pdf | 136 | 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 field. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot find 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 689 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-specific 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 690 Amazon Lightsail UntagResource API Reference Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource. The untag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "resourceArn": "string", "resourceName": "string", "tagKeys": [ "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. resourceArn The Amazon Resource Name (ARN) of the resource from which you want to remove a tag. Type: String Pattern: ^arn:(aws[^:]*):([a-zA-Z0-9-]+):([a-z0-9-]+):([0-9]+):([a-zA-Z]+)/ ([a-zA-Z0-9-]+)$ Required: No resourceName The name of the resource from which you are removing a tag. Type: String Pattern: \w[\w\-]*\w Required: Yes UntagResource API Version 2016-11-28 691 Amazon Lightsail tagKeys The tag keys to delete from the specified resource. API Reference Type: Array of strings 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 affected by the request. Response Syntax API Version 2016-11-28 692 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 field. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot find 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 693 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-specific 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 694 Amazon Lightsail UpdateBucket Updates an existing Amazon Lightsail bucket. API Reference Use this action to update the configuration of an existing bucket, such as versioning, public accessibility, and the AWS accounts that can access the bucket. Request Syntax { "accessLogConfig": { "destination": "string", "enabled": boolean, "prefix": "string" }, "accessRules": { "allowPublicOverrides": boolean, "getObject": "string" }, "bucketName": "string", "readonlyAccessAccounts": [ "string" ], "versioning": "string" } Request Parameters For information about the parameters that |
amazon-lightsail-api-reference-137 | amazon-lightsail-api-reference.pdf | 137 | • 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 694 Amazon Lightsail UpdateBucket Updates an existing Amazon Lightsail bucket. API Reference Use this action to update the configuration of an existing bucket, such as versioning, public accessibility, and the AWS accounts that can access the bucket. Request Syntax { "accessLogConfig": { "destination": "string", "enabled": boolean, "prefix": "string" }, "accessRules": { "allowPublicOverrides": boolean, "getObject": "string" }, "bucketName": "string", "readonlyAccessAccounts": [ "string" ], "versioning": "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. accessLogConfig An object that describes the access log configuration for the bucket. Type: BucketAccessLogConfig object Required: No accessRules An object that sets the public accessibility of objects in the specified bucket. UpdateBucket API Version 2016-11-28 695 Amazon Lightsail Type: AccessRules object Required: No bucketName The name of the bucket to update. Type: String API Reference Length Constraints: Minimum length of 3. Maximum length of 54. Pattern: ^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$ Required: Yes readonlyAccessAccounts An array of strings to specify the AWS account IDs that can access the bucket. You can give a maximum of 10 AWS accounts access to a bucket. Type: Array of strings Array Members: Maximum number of 10 items. Pattern: .*\S.* Required: No versioning Specifies whether to enable or suspend versioning of objects in the bucket. The following options can be specified: • Enabled - Enables versioning of objects in the specified bucket. • Suspended - Suspends versioning of objects in the specified bucket. Existing object versions are retained. Type: String Pattern: .*\S.* Required: No Request Parameters API Version 2016-11-28 696 Amazon Lightsail Response Syntax API Reference { "bucket": { "ableToUpdateBundle": boolean, "accessLogConfig": { "destination": "string", "enabled": boolean, "prefix": "string" }, "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" Response Syntax API Version 2016-11-28 697 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. bucket An object that describes the bucket that is updated. 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 affected by the request. Type: Array of Operation objects Response Elements API Version 2016-11-28 698 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 field. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot find 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 Errors API Version 2016-11-28 699 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-specific 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 700 Amazon Lightsail API Reference UpdateBucketBundle Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket. A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. You can update a bucket's bundle only one time within a monthly AWS billing cycle. To determine if you can update a bucket's bundle, use the GetBuckets action. The ableToUpdateBundle parameter in the response will indicate whether you can currently update a bucket's bundle. Update a bucket's bundle if |
amazon-lightsail-api-reference-138 | amazon-lightsail-api-reference.pdf | 138 | V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 700 Amazon Lightsail API Reference UpdateBucketBundle Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket. A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. You can update a bucket's bundle only one time within a monthly AWS billing cycle. To determine if you can update a bucket's bundle, use the GetBuckets action. The ableToUpdateBundle parameter in the response will indicate whether you can currently update a bucket's bundle. Update a bucket's bundle if it's consistently going over its storage space or data transfer quota, or if a bucket's usage is consistently in the lower range of its storage space or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might experience, we strongly recommend that you update a bucket's bundle only as a long-term strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle that will provide the bucket with ample storage space and data transfer for a long time to come. Request Syntax { "bucketName": "string", "bundleId": "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 for which to update the bundle. 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 UpdateBucketBundle API Version 2016-11-28 701 Amazon Lightsail bundleId API Reference The ID of the new bundle to apply to the bucket. Use the GetBucketBundles action to get a list of bundle IDs that you can specify. Type: String Pattern: .*\S.* 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. Response Syntax API Version 2016-11-28 702 Amazon Lightsail 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 affected 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 field. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot find a resource. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 Errors API Version 2016-11-28 703 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-specific 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 704 Amazon Lightsail API Reference UpdateContainerService Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names. Request Syntax { "isDisabled": boolean, "power": "string", "privateRegistryAccess": { "ecrImagePullerRole": { "isActive": boolean } }, "publicDomainNames": { "string" : [ "string" ] }, "scale": number, "serviceName": "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. isDisabled A Boolean value to indicate whether the container service is disabled. Type: Boolean Required: No power The power for the container service. The power specifies 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 configured capacity. UpdateContainerService API Version 2016-11-28 705 Amazon Lightsail API Reference 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 view the specifications of each power option. Type: String Valid Values: |
amazon-lightsail-api-reference-139 | amazon-lightsail-api-reference.pdf | 139 | whether the container service is disabled. Type: Boolean Required: No power The power for the container service. The power specifies 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 configured capacity. UpdateContainerService API Version 2016-11-28 705 Amazon Lightsail API Reference 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 view the specifications of each power option. Type: String Valid Values: nano | micro | small | medium | large | xlarge Required: No privateRegistryAccess An object to describe the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories. For more information, see Configuring 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 configured 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 certificate before you can use public domain names with your container service. Use the CreateCertificate action to create a certificate for the public domain names you want to use with your container service. Request Parameters API Version 2016-11-28 706 Amazon Lightsail API Reference 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 Required: No scale The scale for the container service. The scale specifies the allocated compute nodes of the container service. The power and scale of a container service makes up its configured 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: No serviceName The name of the container service to update. 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": { "arn": "string", "containerServiceName": "string", "createdAt": number, "currentDeployment": { "containers": { "string" : { "command": [ "string" ], Response Syntax API Version 2016-11-28 707 Amazon Lightsail API Reference "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" }, "image": "string", "ports": { "string" : "string" } } }, "createdAt": number, Response Syntax API Version 2016-11-28 708 Amazon Lightsail API Reference "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": [ { "key": "string", "value": "string" } ], "url": "string" } Response Syntax API Version 2016-11-28 709 API Reference Amazon Lightsail } 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 field. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot find a resource. Response Elements API Version 2016-11-28 710 Amazon Lightsail HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when |
amazon-lightsail-api-reference-140 | amazon-lightsail-api-reference.pdf | 140 | 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 field. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot find a resource. Response Elements API Version 2016-11-28 710 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 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 you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. Update container service The following example updates an existing container service named container-service-1 in the us-west-2 AWS Region by adding the example.com, applications.example.com, www.example.com, and containers.example.com public domains of the example-com SSL/ TLS certificate. Sample Request POST / HTTP/1.1 Host: lightsail.us-west-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: Lightsail_20161128.UpdateContainerService Content-Type: application/x-amz-json-1.1 User-Agent: AGENT X-Amz-Date: 20201022T203059Z Examples API Version 2016-11-28 711 API Reference Amazon Lightsail Authorization: AUTHPARAMS Content-Length: 192 { "serviceName": "myservice", "isDisabled": false, "publicDomainNames": { "example-com": [ "example.com", "applications.example.com", "www.example.com", "containers.example.com" ] } } Sample Response HTTP/1.1 200 OK Server: Server Date: Thu, 22 Oct 2020 20:31:00 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 1178 x-amzn-RequestId: d198e00c-70c7-47e4-afa7-2EXAMPLE6f5a Connection: keep-alive { "containerService": { "arn": "arn:aws:lightsail:us- west-2:111122223333:ContainerService/1724babe-944a-4c49-887a-e7EXAMPLEe34", "containerServiceName": "myservice", "createdAt": 1.602859922E9, "currentDeployment": { "containers": { "mystaticwebsite": { "command": [], "environment": {}, "image": "httpd", "ports": {"80": "HTTP"} } }, "createdAt": 1.603393327E9, "publicEndpoint": { Examples API Version 2016-11-28 712 Amazon Lightsail API Reference "containerName": "mystaticwebsite", "containerPort": 80, "healthCheck": { "healthyThreshold": 2, "intervalSeconds": 5, "path": "/", "successCodes": "200-499", "timeoutSeconds": 2, "unhealthyThreshold": 2 } }, "state": "ACTIVE", "version": 5 }, "isDisabled": false, "location": { "availabilityZone": "all", "regionName": "us-west-2" }, "power": "nano", "powerId": "nano-1", "principalArn": "arn:aws:iam::111122223333:role/amazon/lightsail/us-west-2/ containers/myservice/1blaioEXAMPLEa1td8sgmnvhmoEXAMPLE8tetach1pcir6773v4g", "privateDomainName": "myservice.service.local", "publicDomainNames": { "example-com": [ "example.com", "applications.example.com", "www.example.com", "containers.example.com" ] }, "resourceType": "ContainerService", "scale": 1, "state": "UPDATING", "tags": [], "url": "https://myservice.urEXAMPLE1234.us-west-2.cs.amazonlightsail.com/" } } Examples API Version 2016-11-28 713 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-specific 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 714 Amazon Lightsail UpdateDistribution API Reference Updates an existing Amazon Lightsail content delivery network (CDN) distribution. Use this action to update the configuration of your existing distribution. Request Syntax { "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", "isEnabled": boolean, "origin": { "name": "string", "protocolPolicy": "string", UpdateDistribution API Version 2016-11-28 715 Amazon Lightsail API Reference "regionName": "string", "responseTimeout": number }, "useDefaultCertificate": boolean, "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. 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. Note The cacheBehaviorSettings specified in your UpdateDistributionRequest will replace your distribution's existing settings. Type: CacheSettings object Required: No certificateName The name of the SSL/TLS certificate that you want to attach to the distribution. Only certificates with a status of ISSUED can be attached to a distribution. Use the GetCertificates action to get a list of certificate names that you can specify. Type: String Request Parameters API Version 2016-11-28 716 Amazon Lightsail Pattern: \w[\w\-]*\w Required: No defaultCacheBehavior API Reference An object that describes the default cache behavior for the distribution. Type: CacheBehavior object Required: No distributionName The name of the distribution to update. Use the GetDistributions action to get a |
amazon-lightsail-api-reference-141 | amazon-lightsail-api-reference.pdf | 141 | your distribution's existing settings. Type: CacheSettings object Required: No certificateName The name of the SSL/TLS certificate that you want to attach to the distribution. Only certificates with a status of ISSUED can be attached to a distribution. Use the GetCertificates action to get a list of certificate names that you can specify. Type: String Request Parameters API Version 2016-11-28 716 Amazon Lightsail Pattern: \w[\w\-]*\w Required: No defaultCacheBehavior API Reference An object that describes the default cache behavior for the distribution. Type: CacheBehavior object Required: No distributionName The name of the distribution to update. Use the GetDistributions action to get a list of distribution names that you can specify. Type: String Pattern: \w[\w\-]*\w Required: Yes isEnabled Indicates whether to enable the distribution. Type: Boolean Required: No origin 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: No useDefaultCertificate Indicates whether the default SSL/TLS certificate is attached to the distribution. The default value is true. When true, the distribution uses the default domain name such as d111111abcdef8.cloudfront.net. Request Parameters API Version 2016-11-28 717 Amazon Lightsail API Reference Set this value to false to attach a new certificate to the distribution. Type: Boolean Required: No viewerMinimumTlsProtocolVersion Use this parameter to update the minimum TLS protocol version for the SSL/TLS certificate that's attached to the distribution. Type: String Valid Values: TLSv1.1_2016 | TLSv1.2_2018 | TLSv1.2_2019 | TLSv1.2_2021 Required: No 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. Response Syntax API Version 2016-11-28 718 Amazon Lightsail API Reference 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 affected 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 field. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot find a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. Errors API Version 2016-11-28 719 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-specific 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 720 Amazon Lightsail API Reference UpdateDistributionBundle Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution. A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution. Update your distribution's bundle if your distribution is going over its monthly network transfer quota and is incurring an overage fee. You can update your distribution's bundle only one time within your monthly AWS billing cycle. To determine if you can update your distribution's bundle, use the GetDistributions action. The ableToUpdateBundle parameter in the result will indicate whether you can currently update your distribution's bundle. Request Syntax { "bundleId": "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. bundleId The bundle ID of the new bundle to apply to your distribution. Use the GetDistributionBundles action to get a list of distribution bundle IDs that you can specify. Type: String Required: No distributionName The name of the distribution for which to update the bundle. UpdateDistributionBundle API Version 2016-11-28 721 Amazon Lightsail API Reference Use the GetDistributions action to get a list of distribution names that you can specify. Type: String Pattern: \w[\w\-]*\w Required: No Response Syntax { "operation": { |
amazon-lightsail-api-reference-142 | amazon-lightsail-api-reference.pdf | 142 | the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. bundleId The bundle ID of the new bundle to apply to your distribution. Use the GetDistributionBundles action to get a list of distribution bundle IDs that you can specify. Type: String Required: No distributionName The name of the distribution for which to update the bundle. UpdateDistributionBundle API Version 2016-11-28 721 Amazon Lightsail API Reference Use the GetDistributions action to get a list of distribution names that you can specify. Type: String Pattern: \w[\w\-]*\w Required: No 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 affected by the request. Type: Operation object Response Syntax API Version 2016-11-28 722 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 field. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot find 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 723 Amazon Lightsail HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific 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 724 Amazon Lightsail API Reference UpdateDomainEntry Updates a domain recordset after it is created. The update domain entry operation supports tag-based access control via resource tags applied to the resource identified 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. Type: DomainEntry object Required: Yes domainName The name of the domain recordset to update. UpdateDomainEntry API Version 2016-11-28 725 API Reference Amazon Lightsail Type: String 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 affected by the request. Type: Array of Operation objects Response Syntax API Version 2016-11-28 726 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 field. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot find a resource. HTTP Status Code: |
amazon-lightsail-api-reference-143 | amazon-lightsail-api-reference.pdf | 143 | 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 field. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot find 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 727 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-specific 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 728 Amazon Lightsail API Reference UpdateInstanceMetadataOptions Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance. When you modify the parameters on a running instance, the GetInstance or GetInstances API operation initially responds with a state of pending. After the parameter modifications are successfully applied, the state changes to applied in subsequent GetInstance or GetInstances API calls. For more information, see Use IMDSv2 with an Amazon Lightsail instance in the Amazon Lightsail Developer Guide. Request Syntax { "httpEndpoint": "string", "httpProtocolIpv6": "string", "httpPutResponseHopLimit": number, "httpTokens": "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. httpEndpoint Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained. If you specify a value of disabled, you cannot access your instance metadata. Type: String Valid Values: disabled | enabled Required: No httpProtocolIpv6 Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled. UpdateInstanceMetadataOptions API Version 2016-11-28 729 Amazon Lightsail Note API Reference This parameter is available only for instances in the Europe (Stockholm) AWS Region (eu-north-1). Type: String Valid Values: disabled | enabled Required: No httpPutResponseHopLimit The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther. If no parameter is specified, the existing state is maintained. Type: Integer Required: No httpTokens The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional. If the state is optional, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned. If the state is required, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available. Type: String Valid Values: optional | required Required: No Request Parameters API Version 2016-11-28 730 Amazon Lightsail instanceName API Reference The name of the instance for which to update metadata parameters. 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", "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 affected by the request. Response Syntax API Version 2016-11-28 731 Amazon Lightsail Type: Operation object 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 |
amazon-lightsail-api-reference-144 | amazon-lightsail-api-reference.pdf | 144 | 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 affected by the request. Response Syntax API Version 2016-11-28 731 Amazon Lightsail Type: Operation object 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 field. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot find 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 732 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-specific 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 733 Amazon Lightsail API Reference UpdateLoadBalancerAttribute Updates the specified attribute for a load balancer. You can only update one attribute at a time. The update load balancer attribute operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "attributeName": "string", "attributeValue": "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. attributeName The name of the attribute you want to update. Type: String Valid Values: HealthCheckPath | SessionStickinessEnabled | SessionStickiness_LB_CookieDurationSeconds | HttpsRedirectionEnabled | TlsPolicyName Required: Yes attributeValue The value that you want to specify for the attribute name. The following values are supported depending on what you specify for the attributeName request parameter: UpdateLoadBalancerAttribute API Version 2016-11-28 734 Amazon Lightsail API Reference • If you specify HealthCheckPath for the attributeName request parameter, then the attributeValue request parameter must be the path to ping on the target (for example, / weather/us/wa/seattle). • If you specify SessionStickinessEnabled for the attributeName request parameter, then the attributeValue request parameter must be true to activate session stickiness or false to deactivate session stickiness. • If you specify SessionStickiness_LB_CookieDurationSeconds for the attributeName request parameter, then the attributeValue request parameter must be an interger that represents the cookie duration in seconds. • If you specify HttpsRedirectionEnabled for the attributeName request parameter, then the attributeValue request parameter must be true to activate HTTP to HTTPS redirection or false to deactivate HTTP to HTTPS redirection. • If you specify TlsPolicyName for the attributeName request parameter, then the attributeValue request parameter must be the name of the TLS policy. Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes loadBalancerName The name of the load balancer that you want to modify (my-load-balancer. Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax { "operations": [ Response Syntax API Version 2016-11-28 735 Amazon Lightsail API Reference { "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 affected 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 736 Amazon Lightsail HTTP Status Code: 400 AccountSetupInProgressException API Reference Lightsail throws this |
amazon-lightsail-api-reference-145 | amazon-lightsail-api-reference.pdf | 145 | 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 affected 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 736 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 field. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot find 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 737 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-specific 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 738 Amazon Lightsail API Reference UpdateRelationalDatabase Allows the update of one or more attributes of a database in Amazon Lightsail. Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window. The update relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "applyImmediately": boolean, "caCertificateIdentifier": "string", "disableBackupRetention": boolean, "enableBackupRetention": boolean, "masterUserPassword": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "publiclyAccessible": boolean, "relationalDatabaseBlueprintId": "string", "relationalDatabaseName": "string", "rotateMasterUserPassword": 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. applyImmediately When true, applies changes immediately. When false, applies changes during the preferred maintenance window. Some changes may cause an outage. Default: false Type: Boolean UpdateRelationalDatabase API Version 2016-11-28 739 Amazon Lightsail Required: No caCertificateIdentifier Indicates the certificate that needs to be associated with the database. API Reference Type: String Required: No disableBackupRetention When true, disables automated backup retention for your database. Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database using the create relational database snapshot operation. Updates are applied during the next maintenance window because this can result in an outage. Type: Boolean Required: No enableBackupRetention When true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage. Type: Boolean Required: No masterUserPassword The password for the master user. The password can include any printable ASCII character except "/", """, or "@". MySQL Constraints: Must contain from 8 to 41 characters. PostgreSQL Constraints: Must contain from 8 to 128 characters. Type: String Request Parameters API Version 2016-11-28 740 Amazon Lightsail Required: No preferredBackupWindow API Reference The daily time range during which automated backups are created for your database if automated backups are enabled. Constraints: • Must be in the hh24:mi-hh24:mi format. Example: 16:00-16:30 • Specified in Coordinated Universal Time (UTC). • Must not conflict with the preferred maintenance window. • Must be at least 30 minutes. Type: String Required: No preferredMaintenanceWindow The weekly time range during which system maintenance can occur on your database. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. Constraints: • Must be in the ddd:hh24:mi-ddd:hh24:mi format. • Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. • Must be at least 30 minutes. • Specified in Coordinated Universal Time (UTC). • Example: Tue:17:00-Tue:17:30 Type: String Required: No publiclyAccessible Specifies the accessibility options for your database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources |
amazon-lightsail-api-reference-146 | amazon-lightsail-api-reference.pdf | 146 | selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. Constraints: • Must be in the ddd:hh24:mi-ddd:hh24:mi format. • Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. • Must be at least 30 minutes. • Specified in Coordinated Universal Time (UTC). • Example: Tue:17:00-Tue:17:30 Type: String Required: No publiclyAccessible Specifies the accessibility options for your database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database. Request Parameters API Version 2016-11-28 741 Amazon Lightsail Type: Boolean Required: No relationalDatabaseBlueprintId API Reference This parameter is used to update the major version of the database. Enter the blueprintId for the major version that you want to update to. Use the GetRelationalDatabaseBlueprints action to get a list of available blueprint IDs. Type: String Required: No relationalDatabaseName The name of your Lightsail database resource to update. Type: String Pattern: \w[\w\-]*\w Required: Yes rotateMasterUserPassword When true, the master user password is changed to a new strong password generated by Lightsail. Use the get relational database master user password operation to get the new password. Type: Boolean Required: No Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", Response Syntax API Version 2016-11-28 742 Amazon Lightsail API Reference "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 affected 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. Response Elements API Version 2016-11-28 743 Amazon Lightsail HTTP Status Code: 400 InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input field. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot find 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-specific AWS SDKs, see the following: See Also API Version 2016-11-28 744 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 745 Amazon Lightsail API Reference UpdateRelationalDatabaseParameters Allows the update of one or more parameters of a database in Amazon Lightsail. Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which parameter updates are applied: dynamic or pending-reboot. Parameters marked with a dynamic apply type are applied immediately. Parameters marked with a pending-reboot apply type are applied only after the database is rebooted using the reboot relational database operation. The update relational database parameters operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "parameters": [ { "allowedValues": "string", "applyMethod": "string", "applyType": "string", "dataType": "string", "description": "string", "isModifiable": boolean, "parameterName": "string", "parameterValue": "string" } ], "relationalDatabaseName": "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. parameters The database parameters to update. UpdateRelationalDatabaseParameters API Version 2016-11-28 746 Amazon Lightsail API Reference Type: Array of RelationalDatabaseParameter objects Required: Yes relationalDatabaseName The name of your database for which to update parameters. Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", |
amazon-lightsail-api-reference-147 | amazon-lightsail-api-reference.pdf | 147 | Syntax { "parameters": [ { "allowedValues": "string", "applyMethod": "string", "applyType": "string", "dataType": "string", "description": "string", "isModifiable": boolean, "parameterName": "string", "parameterValue": "string" } ], "relationalDatabaseName": "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. parameters The database parameters to update. UpdateRelationalDatabaseParameters API Version 2016-11-28 746 Amazon Lightsail API Reference Type: Array of RelationalDatabaseParameter objects Required: Yes relationalDatabaseName The name of your database for which to update parameters. 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. Response Syntax API Version 2016-11-28 747 Amazon Lightsail 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 affected 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 field. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot find a resource. HTTP Status Code: 400 Errors API Version 2016-11-28 748 Amazon Lightsail OperationFailureException API Reference 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-specific 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 749 Amazon Lightsail Data Types API Reference The Amazon Lightsail 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: • AccessKey • AccessKeyLastUsed • AccessRules • AccountLevelBpaSync • AddOn • AddOnRequest • Alarm • AttachedDisk • AutoSnapshotAddOnRequest • AutoSnapshotDetails • AvailabilityZone • Blueprint • Bucket • BucketAccessLogConfig • BucketBundle • BucketState • Bundle • CacheBehavior • CacheBehaviorPerPath • CacheSettings API Version 2016-11-28 750 Amazon Lightsail • Certificate • CertificateSummary • CloudFormationStackRecord • CloudFormationStackRecordSourceInfo • ContactMethod • Container • ContainerImage • ContainerService • ContainerServiceDeployment • ContainerServiceDeploymentRequest • ContainerServiceECRImagePullerRole • ContainerServiceECRImagePullerRoleRequest • ContainerServiceEndpoint • ContainerServiceHealthCheckConfig • ContainerServiceLogEvent • ContainerServicePower • ContainerServiceRegistryLogin • ContainerServiceStateDetail • CookieObject • CostEstimate • DestinationInfo • Disk • DiskInfo • DiskMap • DiskSnapshot • DiskSnapshotInfo • DistributionBundle • DnsRecordCreationState • Domain • DomainEntry API Reference API Version 2016-11-28 751 API Reference Amazon Lightsail • DomainValidationRecord • EndpointRequest • EstimateByTime • ExportSnapshotRecord • ExportSnapshotRecordSourceInfo • HeaderObject • HostKeyAttributes • InputOrigin • Instance • InstanceAccessDetails • InstanceEntry • InstanceHardware • InstanceHealthSummary • InstanceMetadataOptions • InstanceNetworking • InstancePortInfo • InstancePortState • InstanceSnapshot • InstanceSnapshotInfo • InstanceState • KeyPair • LightsailDistribution • LoadBalancer • LoadBalancerTlsCertificate • LoadBalancerTlsCertificateDnsRecordCreationState • LoadBalancerTlsCertificateDomainValidationOption • LoadBalancerTlsCertificateDomainValidationRecord • LoadBalancerTlsCertificateRenewalSummary • LoadBalancerTlsCertificateSummary • LoadBalancerTlsPolicy API Version 2016-11-28 752 Amazon Lightsail • LogEvent • MetricDatapoint • MonitoredResourceInfo • MonthlyTransfer • NameServersUpdateState • Operation • Origin • PasswordData • PendingMaintenanceAction • PendingModifiedRelationalDatabaseValues • PortInfo • PrivateRegistryAccess • PrivateRegistryAccessRequest • QueryStringObject • R53HostedZoneDeletionState • Region • RegisteredDomainDelegationInfo • RelationalDatabase • RelationalDatabaseBlueprint • RelationalDatabaseBundle • RelationalDatabaseEndpoint • RelationalDatabaseEvent • RelationalDatabaseHardware • RelationalDatabaseParameter • RelationalDatabaseSnapshot • RenewalSummary • ResourceBudgetEstimate • ResourceLocation • ResourceReceivingAccess • ResourceRecord API Reference API Version 2016-11-28 753 Amazon Lightsail • Session • SetupExecutionDetails • SetupHistory • SetupHistoryResource • SetupRequest • StaticIp • StopInstanceOnIdleRequest • Tag • TimePeriod API Reference API Version 2016-11-28 754 Amazon Lightsail AccessKey API Reference Describes an access key for an Amazon Lightsail bucket. Access keys grant full |
amazon-lightsail-api-reference-148 | amazon-lightsail-api-reference.pdf | 148 | • Operation • Origin • PasswordData • PendingMaintenanceAction • PendingModifiedRelationalDatabaseValues • PortInfo • PrivateRegistryAccess • PrivateRegistryAccessRequest • QueryStringObject • R53HostedZoneDeletionState • Region • RegisteredDomainDelegationInfo • RelationalDatabase • RelationalDatabaseBlueprint • RelationalDatabaseBundle • RelationalDatabaseEndpoint • RelationalDatabaseEvent • RelationalDatabaseHardware • RelationalDatabaseParameter • RelationalDatabaseSnapshot • RenewalSummary • ResourceBudgetEstimate • ResourceLocation • ResourceReceivingAccess • ResourceRecord API Reference API Version 2016-11-28 753 Amazon Lightsail • Session • SetupExecutionDetails • SetupHistory • SetupHistoryResource • SetupRequest • StaticIp • StopInstanceOnIdleRequest • Tag • TimePeriod API Reference API Version 2016-11-28 754 Amazon Lightsail AccessKey API Reference Describes an access key for an Amazon Lightsail bucket. Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the CreateBucketAccessKey action to create an access key for a specific 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 first 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. Contents accessKeyId The ID of the access key. Type: String Length Constraints: Fixed length of 20. Pattern: ^[A-Z0-9]{20}$ Required: No createdAt The timestamp when the access key was created. Type: Timestamp Required: No lastUsed An object that describes the last time the access key was used. AccessKey API Version 2016-11-28 755 Amazon Lightsail Note API Reference This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the region and serviceName values are N/A, and the lastUsedDate value is null. Type: AccessKeyLastUsed object Required: No secretAccessKey The secret access key used to sign requests. You should store the secret access key in a safe location. We recommend that you delete the access key if the secret access key is compromised. Type: String Pattern: .*\S.* Required: No status The status of the access key. A status of Active means that the key is valid, while Inactive means it is not. Type: String Valid Values: Active | Inactive Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ See Also API Version 2016-11-28 756 Amazon Lightsail • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 757 Amazon Lightsail AccessKeyLastUsed Describes the last time an access key was used. API Reference Note This object does not include data in the response of a CreateBucketAccessKey action. Contents lastUsedDate The date and time when the access key was most recently used. This value is null if the access key has not been used. Type: Timestamp Required: No region The AWS Region where this access key was most recently used. This value is N/A if the access key has not been used. Type: String Required: No serviceName The name of the AWS service with which this access key was most recently used. This value is N/A if the access key has not been used. Type: String Required: No AccessKeyLastUsed API Version 2016-11-28 758 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 759 Amazon Lightsail AccessRules API Reference Describes the anonymous access permissions for an Amazon Lightsail bucket and its objects. For more information about bucket access permissions, see Understanding bucket permissions in Amazon Lightsail in the Amazon Lightsail Developer Guide. Contents allowPublicOverrides A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified. When this is true, you can use the PutObjectAcl Amazon S3 API action to set individual objects to public (read-only) using the public-read ACL, or to private using the private ACL. Type: Boolean Required: No getObject Specifies the anonymous access to all objects in a bucket. The following options can be specified: • public - Sets all objects in the bucket to public (read-only), making them readable by anyone in the world. If the getObject value is set to public, then all objects in the bucket default to public regardless of the allowPublicOverrides value. • private - Sets all objects in the bucket to private, making them readable only by you or anyone you give access to. If the getObject value is set to private, and the allowPublicOverrides value is set to true, then all objects in the bucket default |
amazon-lightsail-api-reference-149 | amazon-lightsail-api-reference.pdf | 149 | to all objects in a bucket. The following options can be specified: • public - Sets all objects in the bucket to public (read-only), making them readable by anyone in the world. If the getObject value is set to public, then all objects in the bucket default to public regardless of the allowPublicOverrides value. • private - Sets all objects in the bucket to private, making them readable only by you or anyone you give access to. If the getObject value is set to private, and the allowPublicOverrides value is set to true, then all objects in the bucket default to private unless they are configured with a public-read ACL. Individual objects with a public-read ACL are readable by anyone in the world. AccessRules API Version 2016-11-28 760 Amazon Lightsail Type: String Valid Values: public | private Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 761 Amazon Lightsail API Reference AccountLevelBpaSync Describes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account- level block public access (BPA) feature for your Lightsail buckets. The account-level BPA feature of Amazon S3 provides centralized controls to limit public access to all Amazon S3 buckets in an account. BPA can make all Amazon S3 buckets in an AWS account private regardless of the individual bucket and object permissions that are configured. Lightsail buckets take into account the Amazon S3 account-level BPA configuration when allowing or denying public access. To do this, Lightsail periodically fetches the account-level BPA configuration from Amazon S3. When the account-level BPA status is InSync, the Amazon S3 account-level BPA configuration is synchronized and it applies to your Lightsail buckets. For more information about Amazon Simple Storage Service account-level BPA and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide. Contents bpaImpactsLightsail A Boolean value that indicates whether account-level block public access is affecting your Lightsail buckets. Type: Boolean Required: No lastSyncedAt The timestamp of when the account-level BPA configuration was last synchronized. This value is null when the account-level BPA configuration has not been synchronized. Type: Timestamp Required: No message A message that provides a reason for a Failed or Defaulted synchronization status. The following messages are possible: AccountLevelBpaSync API Version 2016-11-28 762 Amazon Lightsail API Reference • SYNC_ON_HOLD - The synchronization has not yet happened. This status message occurs immediately after you create your first Lightsail bucket. This status message should change after the first synchronization happens, approximately 1 hour after the first bucket is created. • DEFAULTED_FOR_SLR_MISSING - The synchronization failed because the required service- linked role is missing from your AWS account. The account-level BPA configuration for your Lightsail buckets is defaulted to active until the synchronization can occur. This means that all your buckets are private and not publicly accessible. For more information about how to create the required service-linked role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the Amazon Lightsail Developer Guide. • DEFAULTED_FOR_SLR_MISSING_ON_HOLD - The synchronization failed because the required service-linked role is missing from your AWS account. Account-level BPA is not yet configured for your Lightsail buckets. Therefore, only the bucket access permissions and individual object access permissions apply to your Lightsail buckets. For more information about how to create the required service-linked role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the Amazon Lightsail Developer Guide. • Unknown - The reason that synchronization failed is unknown. Contact AWS Support for more information. Type: String Valid Values: DEFAULTED_FOR_SLR_MISSING | SYNC_ON_HOLD | DEFAULTED_FOR_SLR_MISSING_ON_HOLD | Unknown Required: No status The status of the account-level BPA synchronization. The following statuses are possible: • InSync - Account-level BPA is synchronized. The Amazon S3 account-level BPA configuration applies to your Lightsail buckets. • NeverSynced - Synchronization has not yet happened. The Amazon S3 account-level BPA configuration does not apply to your Lightsail buckets. • Failed - Synchronization failed. The Amazon S3 account-level BPA configuration does not apply to your Lightsail buckets. • Defaulted - Synchronization failed and account-level BPA for your Lightsail buckets is defaulted to active. Contents API Version 2016-11-28 763 Amazon Lightsail Note API Reference You might need to complete further actions if the status is Failed or Defaulted. The message parameter provides more information for those statuses. Type: String Valid Values: InSync | Failed | NeverSynced | Defaulted Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also |
amazon-lightsail-api-reference-150 | amazon-lightsail-api-reference.pdf | 150 | • Defaulted - Synchronization failed and account-level BPA for your Lightsail buckets is defaulted to active. Contents API Version 2016-11-28 763 Amazon Lightsail Note API Reference You might need to complete further actions if the status is Failed or Defaulted. The message parameter provides more information for those statuses. Type: String Valid Values: InSync | Failed | NeverSynced | Defaulted Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 764 Amazon Lightsail AddOn API Reference Describes an add-on that is enabled for an Amazon Lightsail resource. Contents duration The amount of idle time in minutes after which your virtual computer will automatically stop. Important This add-on only applies to Lightsail for Research resources. Type: String Required: No name The name of the add-on. Type: String Required: No nextSnapshotTimeOfDay The next daily time an automatic snapshot will be created. The time shown is in HH:00 format, and in Coordinated Universal Time (UTC). The snapshot is automatically created between the time shown and up to 45 minutes after. Type: String Pattern: ^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$ Required: No snapshotTimeOfDay The daily time when an automatic snapshot is created. AddOn API Version 2016-11-28 765 Amazon Lightsail API Reference The time shown is in HH:00 format, and in Coordinated Universal Time (UTC). The snapshot is automatically created between the time shown and up to 45 minutes after. Type: String Pattern: ^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$ Required: No status The status of the add-on. Type: String Required: No threshold The trigger threshold of the action. Important This add-on only applies to Lightsail for Research resources. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 766 Amazon Lightsail AddOnRequest API Reference Describes a request to enable, modify, or disable an add-on for an Amazon Lightsail resource. Note An additional cost may be associated with enabling add-ons. For more information, see the Lightsail pricing page. Contents addOnType The add-on type. Type: String Valid Values: AutoSnapshot | StopInstanceOnIdle Required: Yes autoSnapshotAddOnRequest An object that represents additional parameters when enabling or modifying the automatic snapshot add-on. Type: AutoSnapshotAddOnRequest object Required: No stopInstanceOnIdleRequest An object that represents additional parameters when enabling or modifying the StopInstanceOnIdle add-on. Important This object only applies to Lightsail for Research resources. Type: StopInstanceOnIdleRequest object AddOnRequest API Version 2016-11-28 767 Amazon Lightsail Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 768 Amazon Lightsail Alarm Describes an alarm. API Reference An alarm is a way to monitor your Lightsail resource metrics. For more information, see Alarms in Amazon Lightsail. Contents arn The Amazon Resource Name (ARN) of the alarm. Type: String Pattern: .*\S.* Required: No comparisonOperator The arithmetic operation used when comparing the specified statistic and threshold. Type: String Valid Values: GreaterThanOrEqualToThreshold | GreaterThanThreshold | LessThanThreshold | LessThanOrEqualToThreshold Required: No contactProtocols The contact protocols for the alarm, such as Email, SMS (text messaging), or both. Type: Array of strings Valid Values: Email | SMS Required: No createdAt The timestamp when the alarm was created. Type: Timestamp Alarm API Version 2016-11-28 769 Amazon Lightsail Required: No datapointsToAlarm API Reference The number of data points that must not within the specified threshold to trigger the alarm. Type: Integer Required: No evaluationPeriods The number of periods over which data is compared to the specified threshold. Type: Integer Required: No location An object that lists information about the location of the alarm. Type: ResourceLocation object Required: No metricName The name of the metric associated with the alarm. Type: String Valid Values: CPUUtilization | NetworkIn | NetworkOut | StatusCheckFailed | StatusCheckFailed_Instance | StatusCheckFailed_System | ClientTLSNegotiationErrorCount | HealthyHostCount | UnhealthyHostCount | HTTPCode_LB_4XX_Count | HTTPCode_LB_5XX_Count | HTTPCode_Instance_2XX_Count | HTTPCode_Instance_3XX_Count | HTTPCode_Instance_4XX_Count | HTTPCode_Instance_5XX_Count | InstanceResponseTime | RejectedConnectionCount | RequestCount | DatabaseConnections | DiskQueueDepth | FreeStorageSpace | NetworkReceiveThroughput | NetworkTransmitThroughput | BurstCapacityTime | BurstCapacityPercentage Required: No Contents API Version 2016-11-28 770 Amazon Lightsail monitoredResourceInfo API Reference An object that lists information about the resource monitored by the alarm. Type: MonitoredResourceInfo object Required: No name The name of the alarm. Type: String Pattern: \w[\w\-]*\w Required: No notificationEnabled Indicates whether the alarm is enabled. Type: Boolean Required: No notificationTriggers The alarm states that trigger a notification. Type: Array of strings Valid Values: OK | ALARM | INSUFFICIENT_DATA Required: No period The period, in seconds, over which the statistic |
amazon-lightsail-api-reference-151 | amazon-lightsail-api-reference.pdf | 151 | | RejectedConnectionCount | RequestCount | DatabaseConnections | DiskQueueDepth | FreeStorageSpace | NetworkReceiveThroughput | NetworkTransmitThroughput | BurstCapacityTime | BurstCapacityPercentage Required: No Contents API Version 2016-11-28 770 Amazon Lightsail monitoredResourceInfo API Reference An object that lists information about the resource monitored by the alarm. Type: MonitoredResourceInfo object Required: No name The name of the alarm. Type: String Pattern: \w[\w\-]*\w Required: No notificationEnabled Indicates whether the alarm is enabled. Type: Boolean Required: No notificationTriggers The alarm states that trigger a notification. Type: Array of strings Valid Values: OK | ALARM | INSUFFICIENT_DATA Required: No period The period, in seconds, over which the statistic is applied. Type: Integer Valid Range: Minimum value of 60. Maximum value of 86400. Required: No Contents API Version 2016-11-28 771 Amazon Lightsail resourceType The Lightsail resource type of the alarm. Type: String API Reference Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No state The current state of the alarm. An alarm has the following possible states: • ALARM - The metric is outside of the defined threshold. • INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state. • OK - The metric is within the defined threshold. Type: String Valid Values: OK | ALARM | INSUFFICIENT_DATA Required: No statistic The statistic for the metric associated with the alarm. The following statistics are available: • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application. • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application. Contents API Version 2016-11-28 772 Amazon Lightsail API Reference • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources. • SampleCount - The count, or number, of data points used for the statistical calculation. Type: String Valid Values: Minimum | Maximum | Sum | Average | SampleCount Required: No supportCode The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily. Type: String Required: No threshold The value against which the specified statistic is compared. Type: Double Required: No treatMissingData Specifies how the alarm handles missing data points. An alarm can treat missing data in the following ways: • breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold. • notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold. • ignore - Ignore the missing data. Maintains the current alarm state. Contents API Version 2016-11-28 773 Amazon Lightsail API Reference • missing - Missing data is treated as missing. Type: String Valid Values: breaching | notBreaching | ignore | missing Required: No unit The unit of the metric associated with the alarm. Type: String Valid Values: Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 774 Amazon Lightsail AttachedDisk API Reference Describes a block storage disk that is attached to an instance, and is included in an automatic snapshot. Contents path The path of the disk (/dev/xvdf). Type: String Required: No sizeInGb The size of the disk in GB. Type: Integer Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AttachedDisk API Version |
amazon-lightsail-api-reference-152 | amazon-lightsail-api-reference.pdf | 152 | Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 774 Amazon Lightsail AttachedDisk API Reference Describes a block storage disk that is attached to an instance, and is included in an automatic snapshot. Contents path The path of the disk (/dev/xvdf). Type: String Required: No sizeInGb The size of the disk in GB. Type: Integer Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AttachedDisk API Version 2016-11-28 775 Amazon Lightsail API Reference AutoSnapshotAddOnRequest Describes a request to enable or modify the automatic snapshot add-on for an Amazon Lightsail instance or disk. When you modify the automatic snapshot time for a resource, it is typically effective immediately except under the following conditions: • If an automatic snapshot has been created for the current day, and you change the snapshot time to a later time of day, then the new snapshot time will be effective the following day. This ensures that two snapshots are not created for the current day. • If an automatic snapshot has not yet been created for the current day, and you change the snapshot time to an earlier time of day, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day. • If an automatic snapshot has not yet been created for the current day, and you change the snapshot time to a time that is within 30 minutes from your current time, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day, because 30 minutes is required between your current time and the new snapshot time that you specify. • If an automatic snapshot is scheduled to be created within 30 minutes from your current time and you change the snapshot time, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day, because 30 minutes is required between your current time and the new snapshot time that you specify. Contents snapshotTimeOfDay The daily time when an automatic snapshot will be created. Constraints: • Must be in HH:00 format, and in an hourly increment. • Specified in Coordinated Universal Time (UTC). • The snapshot will be automatically created between the time specified and up to 45 minutes after. AutoSnapshotAddOnRequest API Version 2016-11-28 776 Amazon Lightsail Type: String Pattern: ^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$ API Reference Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 777 Amazon Lightsail API Reference AutoSnapshotDetails Describes an automatic snapshot. Contents createdAt The timestamp when the automatic snapshot was created. Type: Timestamp Required: No date The date of the automatic snapshot in YYYY-MM-DD format. Type: String Required: No fromAttachedDisks An array of objects that describe the block storage disks attached to the instance when the automatic snapshot was created. Type: Array of AttachedDisk objects Required: No status The status of the automatic snapshot. Type: String Valid Values: Success | Failed | InProgress | NotFound Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: AutoSnapshotDetails API Version 2016-11-28 778 Amazon Lightsail • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 779 Amazon Lightsail AvailabilityZone API Reference Describes an Availability Zone. This is returned only as part of a GetRegions request. Contents state The state of the Availability Zone. Type: String Pattern: .*\S.* Required: No zoneName The name of the Availability Zone. The format is us-east-2a (case-sensitive). Type: String Pattern: .*\S.* Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AvailabilityZone API Version 2016-11-28 780 API Reference Amazon Lightsail Blueprint Describes a blueprint (a virtual private server image). Contents appCategory Virtual computer blueprints that are supported by Lightsail for Research. Important This parameter only applies to Lightsail for Research resources. Type: String Valid Values: LfR Required: No blueprintId The ID for the virtual private |
amazon-lightsail-api-reference-153 | amazon-lightsail-api-reference.pdf | 153 | format is us-east-2a (case-sensitive). Type: String Pattern: .*\S.* Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AvailabilityZone API Version 2016-11-28 780 API Reference Amazon Lightsail Blueprint Describes a blueprint (a virtual private server image). Contents appCategory Virtual computer blueprints that are supported by Lightsail for Research. Important This parameter only applies to Lightsail for Research resources. Type: String Valid Values: LfR Required: No blueprintId The ID for the virtual private server image (app_wordpress_x_x or app_lamp_x_x). Type: String Pattern: .*\S.* Required: No description The description of the blueprint. Type: String Required: No group The group name of the blueprint (amazon-linux). Type: String Blueprint API Version 2016-11-28 781 Amazon Lightsail Pattern: .*\S.* Required: No isActive API Reference A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases. Type: Boolean Required: No licenseUrl The end-user license agreement URL for the image or blueprint. Type: String Required: No minPower The minimum bundle power required to run this blueprint. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500. 0 indicates that the blueprint runs on all instance sizes. Type: Integer Required: No name The friendly name of the blueprint (Amazon Linux). Type: String Pattern: \w[\w\-]*\w Required: No platform The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint. Contents API Version 2016-11-28 782 Amazon Lightsail Type: String Valid Values: LINUX_UNIX | WINDOWS Required: No productUrl The product URL to learn more about the image or blueprint. API Reference Type: String Required: No type The type of the blueprint (os or app). Type: String Valid Values: os | app Required: No version The version number of the operating system, application, or stack ( 2016.03.0). Type: String Required: No versionCode The version code. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2016-11-28 783 Amazon Lightsail • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 784 Amazon Lightsail Bucket Describes an Amazon Lightsail bucket. Contents ableToUpdateBundle API Reference Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle. You can update a bucket's bundle only one time within a monthly AWS billing cycle. Use the UpdateBucketBundle action to change a bucket's bundle. Type: Boolean Required: No accessLogConfig An object that describes the access log configuration for the bucket. Type: BucketAccessLogConfig object Required: No accessRules An object that describes the access rules of the bucket. Type: AccessRules object Required: No arn The Amazon Resource Name (ARN) of the bucket. Type: String Pattern: .*\S.* Required: No Bucket API Version 2016-11-28 785 Amazon Lightsail bundleId API Reference The ID of the bundle currently applied to the bucket. A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. Use the UpdateBucketBundle action to change the bundle of a bucket. Type: String Pattern: .*\S.* Required: No createdAt The timestamp when the distribution was created. Type: Timestamp Required: No location An object that describes the location of the bucket, such as the AWS Region and Availability Zone. Type: ResourceLocation object Required: No name The name of the bucket. 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: No objectVersioning Indicates whether object versioning is enabled for the bucket. Contents API Version 2016-11-28 786 Amazon Lightsail API Reference The following options can be configured: • Enabled - Object versioning is enabled. • Suspended - Object versioning was previously enabled but is currently suspended. Existing object versions are retained. • NeverEnabled - Object versioning has never been enabled. Type: String Pattern: .*\S.* Required: No readonlyAccessAccounts An array of strings that specify the AWS account IDs that have read-only access to the bucket. Type: Array of strings Array Members: Maximum number of 10 items. Pattern: .*\S.* Required: No resourcesReceivingAccess An array of objects that describe Lightsail instances that have access to the bucket. Use the SetResourceAccessForBucket action to update the instances that have access to a bucket. Type: Array of ResourceReceivingAccess objects Required: No resourceType The Lightsail resource type of the bucket. Type: String Pattern: .*\S.* Required: No Contents API Version 2016-11-28 787 Amazon Lightsail state An object that describes the state of the bucket. Type: |
amazon-lightsail-api-reference-154 | amazon-lightsail-api-reference.pdf | 154 | An array of strings that specify the AWS account IDs that have read-only access to the bucket. Type: Array of strings Array Members: Maximum number of 10 items. Pattern: .*\S.* Required: No resourcesReceivingAccess An array of objects that describe Lightsail instances that have access to the bucket. Use the SetResourceAccessForBucket action to update the instances that have access to a bucket. Type: Array of ResourceReceivingAccess objects Required: No resourceType The Lightsail resource type of the bucket. Type: String Pattern: .*\S.* Required: No Contents API Version 2016-11-28 787 Amazon Lightsail state An object that describes the state of the bucket. Type: BucketState object Required: No supportCode API Reference The support code for a bucket. Include this code in your email to support when you have questions about a Lightsail bucket. This code enables our support team to look up your Lightsail information more easily. Type: String Pattern: .*\S.* Required: No tags The tag keys and optional values for the bucket. For more information, see Tags in Amazon Lightsail in the Amazon Lightsail Developer Guide. Type: Array of Tag objects Required: No url The URL of the bucket. Type: String Pattern: .*\S.* Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2016-11-28 788 Amazon Lightsail • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 789 Amazon Lightsail API Reference BucketAccessLogConfig Describes the access log configuration for a bucket in the Amazon Lightsail object storage service. For more information about bucket access logs, see Logging bucket requests using access logging in Amazon Lightsail in the Amazon Lightsail Developer Guide. Contents enabled A Boolean value that indicates whether bucket access logging is enabled for the bucket. Type: Boolean Required: Yes destination The name of the bucket where the access logs are saved. The destination can be a Lightsail bucket in the same account, and in the same AWS Region as the source bucket. Note This parameter is required when enabling the access log for a bucket, and should be omitted when disabling the access log. 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: No prefix The optional object prefix for the bucket access log. The prefix is an optional addition to the object key that organizes your access log files in the destination bucket. For example, if you specify a logs/ prefix, then each log object BucketAccessLogConfig API Version 2016-11-28 790 Amazon Lightsail API Reference will begin with the logs/ prefix in its key (for example, logs/2021-11-01-21-32-16- E568B2907131C0C0). Note This parameter can be optionally specified when enabling the access log for a bucket, and should be omitted when disabling the access log. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: ^[\w/!.*')(-]+$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 791 Amazon Lightsail BucketBundle API Reference Describes the specifications of a bundle that can be applied to an Amazon Lightsail bucket. A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. Contents bundleId The ID of the bundle. Type: String Pattern: .*\S.* Required: No isActive Indicates whether the bundle is active. Use for a new or existing bucket. Type: Boolean Required: No name The name of the bundle. Type: String Pattern: .*\S.* Required: No price The monthly price of the bundle, in US dollars. Type: Float Required: No storagePerMonthInGb The storage size of the bundle, in GB. BucketBundle API Version 2016-11-28 792 API Reference Amazon Lightsail Type: Integer Required: No transferPerMonthInGb The monthly network transfer quota of the bundle. Type: Integer Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 793 API Reference Amazon Lightsail BucketState Describes the state of an Amazon Lightsail bucket. Contents code The state code of the bucket. The following codes are possible: • OK - The bucket is in a running state. • Unknown - Creation of the bucket might have timed-out. You might want to delete the bucket and create a new one. Type: String Pattern: .*\S.* Required: No message A message that describes the state of the bucket. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for |
amazon-lightsail-api-reference-155 | amazon-lightsail-api-reference.pdf | 155 | the state of an Amazon Lightsail bucket. Contents code The state code of the bucket. The following codes are possible: • OK - The bucket is in a running state. • Unknown - Creation of the bucket might have timed-out. You might want to delete the bucket and create a new one. Type: String Pattern: .*\S.* Required: No message A message that describes the state of the bucket. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 BucketState API Version 2016-11-28 794 Amazon Lightsail Bundle API Reference Describes a bundle, which is a set of specs describing your virtual private server (or instance). Contents bundleId The bundle ID (micro_x_x). Type: String Pattern: .*\S.* Required: No cpuCount The number of vCPUs included in the bundle (2). Type: Integer Required: No diskSizeInGb The size of the SSD (30). Type: Integer Required: No instanceType The instance type (micro). Type: String Required: No isActive A Boolean value indicating whether the bundle is active. Type: Boolean Bundle API Version 2016-11-28 795 Amazon Lightsail Required: No name A friendly name for the bundle (Micro). Type: String Required: No power API Reference A numeric value that represents the power of the bundle (500). You can use the bundle's power value in conjunction with a blueprint's minimum power value to determine whether the blueprint will run on the bundle. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500. Type: Integer Required: No price The price in US dollars (5.0) of the bundle. Type: Float Required: No publicIpv4AddressCount An integer that indicates the public ipv4 address count included in the bundle, the value is either 0 or 1. Type: Integer Required: No ramSizeInGb The amount of RAM in GB (2.0). Type: Float Required: No Contents API Version 2016-11-28 796 Amazon Lightsail supportedAppCategories API Reference Virtual computer blueprints that are supported by a Lightsail for Research bundle. Important This parameter only applies to Lightsail for Research resources. Type: Array of strings Valid Values: LfR Required: No supportedPlatforms The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle supports. You can only launch a WINDOWS bundle on a blueprint that supports the WINDOWS platform. LINUX_UNIX blueprints require a LINUX_UNIX bundle. Type: Array of strings Valid Values: LINUX_UNIX | WINDOWS Required: No transferPerMonthInGb The data transfer rate per month in GB (2000). Type: Integer Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 See Also API Version 2016-11-28 797 Amazon Lightsail • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 798 Amazon Lightsail CacheBehavior API Reference Describes the default cache behavior of an Amazon Lightsail content delivery network (CDN) distribution. Contents behavior The cache behavior of the distribution. The following cache behaviors can be specified: • cache - This option is best for static sites. When specified, your distribution caches and serves your entire website as static content. This behavior is ideal for websites with static content that doesn't change depending on who views it, or for websites that don't use cookies, headers, or query strings to personalize content. • dont-cache - This option is best for sites that serve a mix of static and dynamic content. When specified, your distribution caches and serve only the content that is specified in the distribution's CacheBehaviorPerPath parameter. This behavior is ideal for websites or web applications that use cookies, headers, and query strings to personalize content for individual users. Type: String Valid Values: dont-cache | cache Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CacheBehavior API Version 2016-11-28 799 Amazon Lightsail API Reference CacheBehaviorPerPath Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution. A per-path cache behavior is used to override, or add an exception to, the default cache behavior of a distribution. For example, if the cacheBehavior is set to cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will cache. Alternately, if the distribution's cacheBehavior is dont-cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will not cache. Contents behavior The cache behavior for the specified path. You can specify one of the following per-path cache |
amazon-lightsail-api-reference-156 | amazon-lightsail-api-reference.pdf | 156 | network (CDN) distribution. A per-path cache behavior is used to override, or add an exception to, the default cache behavior of a distribution. For example, if the cacheBehavior is set to cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will cache. Alternately, if the distribution's cacheBehavior is dont-cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will not cache. Contents behavior The cache behavior for the specified path. You can specify one of the following per-path cache behaviors: • cache - This behavior caches the specified path. • dont-cache - This behavior doesn't cache the specified path. Type: String Valid Values: dont-cache | cache Required: No path The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories (path/to/assets/*), and file types (*.html, *jpg, *js). Directories and file paths are case-sensitive. Examples: • Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance. var/www/html/ • Specify the following file to cache only the index page in the document root of an Apache web server. CacheBehaviorPerPath API Version 2016-11-28 800 Amazon Lightsail API Reference var/www/html/index.html • Specify the following to cache only the .html files in the document root of an Apache web server. var/www/html/*.html • Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server. var/www/html/images/*.jpg var/www/html/images/*.png var/www/html/images/*.gif Specify the following to cache all files in the images sub-directory of the document root of an Apache web server. var/www/html/images/ Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 801 Amazon Lightsail CacheSettings API Reference Describes the cache settings of an Amazon Lightsail content delivery network (CDN) distribution. These settings apply only to your distribution's cacheBehaviors (including the defaultCacheBehavior) that have a behavior of cache. Contents allowedHTTPMethods The HTTP methods that are processed and forwarded to the distribution's origin. You can specify the following options: • GET,HEAD - The distribution forwards the GET and HEAD methods. • GET,HEAD,OPTIONS - The distribution forwards the GET, HEAD, and OPTIONS methods. • GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE methods. If you specify the third option, you might need to restrict access to your distribution's origin so users can't perform operations that you don't want them to. For example, you might not want users to have permission to delete objects from your origin. Type: String Pattern: .*\S.* Required: No cachedHTTPMethods The HTTP method responses that are cached by your distribution. You can specify the following options: • GET,HEAD - The distribution caches responses to the GET and HEAD methods. • GET,HEAD,OPTIONS - The distribution caches responses to the GET, HEAD, and OPTIONS methods. Type: String CacheSettings API Version 2016-11-28 802 Amazon Lightsail Pattern: .*\S.* Required: No defaultTTL API Reference The default amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the content has been updated. Note The value specified applies only when the origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. Type: Long Required: No forwardedCookies An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded. Type: CookieObject object Required: No forwardedHeaders An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded. Type: HeaderObject object Required: No forwardedQueryStrings An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded. Type: QueryStringObject object Required: No Contents API Version 2016-11-28 803 Amazon Lightsail maximumTTL API Reference The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated. The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. Type: Long Required: No minimumTTL The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated. A value of 0 must be specified for minimumTTL if the distribution is configured to forward all headers to the origin. Type: Long Required: |
amazon-lightsail-api-reference-157 | amazon-lightsail-api-reference.pdf | 157 | in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated. The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. Type: Long Required: No minimumTTL The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated. A value of 0 must be specified for minimumTTL if the distribution is configured to forward all headers to the origin. Type: Long Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 804 Amazon Lightsail Certificate API Reference Describes the full details of an Amazon Lightsail SSL/TLS certificate. Note To get a summary of a certificate, use the GetCertificates action and omit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags. Contents arn The Amazon Resource Name (ARN) of the certificate. Type: String Pattern: .*\S.* Required: No createdAt The timestamp when the certificate was created. Type: Timestamp Required: No domainName The domain name of the certificate. Type: String Required: No domainValidationRecords An array of objects that describe the domain validation records of the certificate. Type: Array of DomainValidationRecord objects Certificate API Version 2016-11-28 805 API Reference Amazon Lightsail Required: No eligibleToRenew The renewal eligibility of the certificate. Type: String Required: No inUseResourceCount The number of Lightsail resources that the certificate is attached to. Type: Integer Required: No issuedAt The timestamp when the certificate was issued. Type: Timestamp Required: No issuerCA The certificate authority that issued the certificate. Type: String Required: No keyAlgorithm The algorithm used to generate the key pair (the public and private key) of the certificate. Type: String Required: No name The name of the certificate (my-certificate). Type: String Required: No Contents API Version 2016-11-28 806 API Reference Amazon Lightsail notAfter The timestamp when the certificate expires. Type: Timestamp Required: No notBefore The timestamp when the certificate is first valid. Type: Timestamp Required: No renewalSummary An object that describes the status of the certificate renewal managed by Lightsail. Type: RenewalSummary object Required: No requestFailureReason The validation failure reason, if any, of the certificate. The following failure reasons are possible: • NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates. • ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support. Note You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com. • DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain Contents API Version 2016-11-28 807 Amazon Lightsail API Reference name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do. If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate. If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case. • INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain. • OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request. Type: String Required: No revocationReason The reason the certificate was revoked. This value is present only when the certificate status is REVOKED. Type: String Required: No revokedAt The timestamp when the certificate was revoked. This value is present only when the |
amazon-lightsail-api-reference-158 | amazon-lightsail-api-reference.pdf | 158 | example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain. • OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request. Type: String Required: No revocationReason The reason the certificate was revoked. This value is present only when the certificate status is REVOKED. Type: String Required: No revokedAt The timestamp when the certificate was revoked. This value is present only when the certificate status is REVOKED. Type: Timestamp Required: No Contents API Version 2016-11-28 808 API Reference Amazon Lightsail serialNumber The serial number of the certificate. Type: String Required: No status The validation status of the certificate. Type: String Valid Values: PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED Required: No subjectAlternativeNames An array of strings that specify the alternate domains (example2.com) and subdomains (blog.example.com) of the certificate. Type: Array of strings Required: No supportCode The support code. Include this code in your email to support when you have questions about your Lightsail certificate. This code enables our support team to look up your Lightsail information more easily. Type: String Required: No tags The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide. Type: Array of Tag objects Required: No Contents API Version 2016-11-28 809 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 810 Amazon Lightsail API Reference CertificateSummary Describes an Amazon Lightsail SSL/TLS certificate. Contents certificateArn The Amazon Resource Name (ARN) of the certificate. Type: String Pattern: .*\S.* Required: No certificateDetail An object that describes a certificate in detail. Type: Certificate object Required: No certificateName The name of the certificate. Type: String Required: No domainName The domain name of the certificate. Type: String Required: No tags The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide. Type: Array of Tag objects CertificateSummary API Version 2016-11-28 811 Amazon Lightsail Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 812 Amazon Lightsail API Reference CloudFormationStackRecord Describes a CloudFormation stack record created as a result of the create cloud formation stack action. A CloudFormation stack record provides information about the AWS CloudFormation stack used to create a new Amazon Elastic Compute Cloud instance from an exported Lightsail instance snapshot. Contents arn The Amazon Resource Name (ARN) of the CloudFormation stack record. Type: String Pattern: .*\S.* Required: No createdAt The date when the CloudFormation stack record was created. Type: Timestamp Required: No destinationInfo A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon Resource Name (ARN) of the AWS CloudFormation stack. Type: DestinationInfo object Required: No location A list of objects describing the Availability Zone and AWS Region of the CloudFormation stack record. Type: ResourceLocation object CloudFormationStackRecord API Version 2016-11-28 813 Amazon Lightsail Required: No name API Reference The name of the CloudFormation stack record. It starts with CloudFormationStackRecord followed by a GUID. Type: String Pattern: \w[\w\-]*\w Required: No resourceType The Lightsail resource type (CloudFormationStackRecord). Type: String Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No sourceInfo A list of objects describing the source of the CloudFormation stack record. Type: Array of CloudFormationStackRecordSourceInfo objects Required: No state The current state of the CloudFormation stack record. Type: String Valid Values: Started | Succeeded | Failed Required: No Contents API Version 2016-11-28 814 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 815 Amazon Lightsail API Reference CloudFormationStackRecordSourceInfo Describes the source of a CloudFormation stack record (i.e., the export snapshot record). Contents arn The Amazon Resource Name (ARN) of the export snapshot record. Type: String Pattern: .*\S.* Required: No name The name of the record. Type: String Pattern: .*\S.* Required: No resourceType The Lightsail resource type (ExportSnapshotRecord). Type: String Valid |
amazon-lightsail-api-reference-159 | amazon-lightsail-api-reference.pdf | 159 | Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 815 Amazon Lightsail API Reference CloudFormationStackRecordSourceInfo Describes the source of a CloudFormation stack record (i.e., the export snapshot record). Contents arn The Amazon Resource Name (ARN) of the export snapshot record. Type: String Pattern: .*\S.* Required: No name The name of the record. Type: String Pattern: .*\S.* Required: No resourceType The Lightsail resource type (ExportSnapshotRecord). Type: String Valid Values: ExportSnapshotRecord Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 CloudFormationStackRecordSourceInfo API Version 2016-11-28 816 Amazon Lightsail • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 817 Amazon Lightsail ContactMethod Describes a contact method. API Reference A contact method is a way to send you notifications. For more information, see Notifications in Amazon Lightsail. Contents arn The Amazon Resource Name (ARN) of the contact method. Type: String Pattern: .*\S.* Required: No contactEndpoint The destination of the contact method, such as an email address or a mobile phone number. Type: String Pattern: .*\S.* Required: No createdAt The timestamp when the contact method was created. Type: Timestamp Required: No location An object that describes the location of the contact method, such as the AWS Region and Availability Zone. Type: ResourceLocation object Required: No ContactMethod API Version 2016-11-28 818 API Reference Amazon Lightsail name The name of the contact method. Type: String Pattern: \w[\w\-]*\w Required: No protocol The protocol of the contact method, such as email or SMS (text messaging). Type: String Valid Values: Email | SMS Required: No resourceType The Lightsail resource type of the contact method. Type: String Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No status The current status of the contact method. A contact method has the following possible status: • PendingVerification - The contact method has not yet been verified, and the verification has not yet expired. • Valid - The contact method has been verified. Contents API Version 2016-11-28 819 Amazon Lightsail API Reference • InValid - An attempt was made to verify the contact method, but the verification has expired. Type: String Valid Values: PendingVerification | Valid | Invalid Required: No supportCode The support code. Include this code in your email to support when you have questions about your Lightsail contact method. This code enables our support team to look up your Lightsail information more easily. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 820 Amazon Lightsail Container API Reference Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service. Contents command The launch command for the container. Type: Array of strings Required: No environment The environment variables of the container. Type: String to string map Required: No image The name of the image used for the container. Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (:). For example, if your container service name is container-service-1, the container image label is mystaticsite, and you want to use the third (3) version of the registered container image, then you should specify :container-service-1.mystaticsite.3. To use the latest version of a container image, specify latest instead of a version number (for example, :container- service-1.mystaticsite.latest). Lightsail will automatically use the highest numbered version of the registered container image. Container images sourced from a public registry like Docker Hub don't start with a colon. For example, nginx:latest or nginx. Type: String Required: No Container API Version 2016-11-28 821 API Reference Amazon Lightsail ports The open firewall ports of the container. Type: String to string map Valid Values: HTTP | HTTPS | TCP | UDP Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 822 Amazon Lightsail ContainerImage API Reference Describes a container image that is registered to an Amazon Lightsail container service. Contents createdAt The timestamp when the container image was created. Type: Timestamp Required: |
amazon-lightsail-api-reference-160 | amazon-lightsail-api-reference.pdf | 160 | Reference Amazon Lightsail ports The open firewall ports of the container. Type: String to string map Valid Values: HTTP | HTTPS | TCP | UDP Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 822 Amazon Lightsail ContainerImage API Reference Describes a container image that is registered to an Amazon Lightsail container service. Contents createdAt The timestamp when the container image was created. Type: Timestamp Required: No digest The digest of the container image. Type: String Required: No image The name of the container image. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ContainerImage API Version 2016-11-28 823 API Reference Amazon Lightsail ContainerService Describes an Amazon Lightsail container service. Contents arn The Amazon Resource Name (ARN) of the container service. Type: String Pattern: .*\S.* Required: No containerServiceName The name of the container service. 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: No createdAt The timestamp when the container service was created. Type: Timestamp Required: No currentDeployment An object that describes the current container deployment of the container service. Type: ContainerServiceDeployment object Required: No ContainerService API Version 2016-11-28 824 Amazon Lightsail isDisabled API Reference A Boolean value indicating whether the container service is disabled. Type: Boolean Required: No location An object that describes the location of the container service, such as the AWS Region and Availability Zone. Type: ResourceLocation object Required: No nextDeployment An object that describes the next deployment of the container service. This value is null when there is no deployment in a pending state. Type: ContainerServiceDeployment object Required: No power The power specification of the container service. The power specifies the amount of RAM, the number of vCPUs, and the base price of the container service. Type: String Valid Values: nano | micro | small | medium | large | xlarge Required: No powerId The ID of the power of the container service. Type: String Required: No Contents API Version 2016-11-28 825 Amazon Lightsail principalArn The principal ARN of the container service. API Reference The principal ARN can be used to create a trust relationship between your standard AWS account and your Lightsail container service. This allows you to give your service permission to access resources in your standard AWS account. Type: String Required: No privateDomainName The private domain name of the container service. The private domain name is accessible only by other resources within the default virtual private cloud (VPC) of your Lightsail account. Type: String Required: No privateRegistryAccess An object that describes the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories. For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide. Type: PrivateRegistryAccess object Required: No publicDomainNames The public domain name of 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 configured as the public endpoint of your container service. Contents API Version 2016-11-28 826 Amazon Lightsail API Reference 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 certificate before you can use public domain names with your container service. Use the CreateCertificate action to create a certificate for the public domain names you want to use with your container service. See CreateContainerService or UpdateContainerService for information about how to specify public domain names for your Lightsail container service. Type: String to array of strings map Required: No resourceType The Lightsail resource type of the container service. Type: String Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No scale The scale specification of the container service. The scale specifies the allocated compute nodes of the container service. Type: Integer Valid Range: Minimum value of 1. Maximum value of 20. Required: No Contents API Version 2016-11-28 827 Amazon Lightsail state The current state of the container service. The following container service states are possible: • PENDING - The container service is being created. API Reference • READY - |
amazon-lightsail-api-reference-161 | amazon-lightsail-api-reference.pdf | 161 | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No scale The scale specification of the container service. The scale specifies the allocated compute nodes of the container service. Type: Integer Valid Range: Minimum value of 1. Maximum value of 20. Required: No Contents API Version 2016-11-28 827 Amazon Lightsail state The current state of the container service. The following container service states are possible: • PENDING - The container service is being created. API Reference • READY - The container service is running but it does not have an active container deployment. • DEPLOYING - The container service is launching a container deployment. • RUNNING - The container service is running and it has an active container deployment. • UPDATING - The container service capacity or its custom domains are being updated. • DELETING - The container service is being deleted. • DISABLED - The container service is disabled, and its active deployment and containers, if any, are shut down. Type: String Valid Values: PENDING | READY | RUNNING | UPDATING | DELETING | DISABLED | DEPLOYING Required: No stateDetail An object that describes the current state of the container service. Note The state detail is populated only when a container service is in a PENDING, DEPLOYING, or UPDATING state. Type: ContainerServiceStateDetail object Required: No tags The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide. Contents API Version 2016-11-28 828 Amazon Lightsail Type: Array of Tag objects Required: No url API Reference The publicly accessible URL of the container service. If no public endpoint is specified in the currentDeployment, this URL returns a 404 response. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 829 Amazon Lightsail API Reference ContainerServiceDeployment Describes a container deployment configuration of an Amazon Lightsail container service. A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service. Contents containers An object that describes the configuration for the containers of the deployment. 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 createdAt The timestamp when the deployment was created. Type: Timestamp Required: No publicEndpoint An object that describes the endpoint of the deployment. Type: ContainerServiceEndpoint object Required: No state The state of the deployment. A deployment can be in one of the following states: • ACTIVATING - The deployment is being created. ContainerServiceDeployment API Version 2016-11-28 830 Amazon Lightsail API Reference • ACTIVE - The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time. • INACTIVE - The deployment was previously successfully created, but it is not currently running on the container service. • FAILED - The deployment failed. Use the GetContainerLog action to view the log events for the containers in the deployment to try to determine the reason for the failure. Type: String Valid Values: ACTIVATING | ACTIVE | INACTIVE | FAILED Required: No version The version number of the deployment. Type: Integer Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 831 Amazon Lightsail API Reference ContainerServiceDeploymentRequest Describes a container deployment configuration of an Amazon Lightsail container service. A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service. Contents containers An object that describes the configuration for the containers of the deployment. 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 endpoint of the deployment. Type: EndpointRequest object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ContainerServiceDeploymentRequest API Version 2016-11-28 832 Amazon Lightsail API Reference ContainerServiceECRImagePullerRole Describes the activation status of the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories. When activated, Lightsail creates an AWS Identity and Access Management (IAM) role for |
amazon-lightsail-api-reference-162 | amazon-lightsail-api-reference.pdf | 162 | object that describes the endpoint of the deployment. Type: EndpointRequest object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ContainerServiceDeploymentRequest API Version 2016-11-28 832 Amazon Lightsail API Reference ContainerServiceECRImagePullerRole Describes the activation status of the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories. When activated, Lightsail creates an AWS Identity and Access Management (IAM) role for the specified Lightsail container service. You can use the ARN of the role to create a trust relationship between your Lightsail container service and an Amazon ECR private repository in your AWS account. This allows your container service to pull images from Amazon ECR private repositories. For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide. Contents isActive A Boolean value that indicates whether the role is activated. Type: Boolean Required: No principalArn The Amazon Resource Name (ARN) of the role, if it is activated. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ContainerServiceECRImagePullerRole API Version 2016-11-28 833 Amazon Lightsail API Reference ContainerServiceECRImagePullerRoleRequest Describes a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories. When activated, Lightsail creates an AWS Identity and Access Management (IAM) role for the specified Lightsail container service. You can use the ARN of the role to create a trust relationship between your Lightsail container service and an Amazon ECR private repository in your AWS account. This allows your container service to pull images from Amazon ECR private repositories. For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide. Contents isActive A Boolean value that indicates whether to activate the role. Type: Boolean Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ContainerServiceECRImagePullerRoleRequest API Version 2016-11-28 834 Amazon Lightsail API Reference ContainerServiceEndpoint Describes the public endpoint configuration of a deployment of an Amazon Lightsail container service. Contents containerName The name of the container entry of the deployment that the endpoint configuration applies to. Type: String Required: No containerPort The port of the specified container to which traffic is forwarded to. Type: Integer Required: No healthCheck An object that describes the health check configuration of the container. Type: ContainerServiceHealthCheckConfig object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ContainerServiceEndpoint API Version 2016-11-28 835 Amazon Lightsail API Reference ContainerServiceHealthCheckConfig Describes the health check configuration of an Amazon Lightsail container service. Contents healthyThreshold The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2. Type: Integer Required: No intervalSeconds The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5. Type: Integer Required: No path The path on the container on which to perform the health check. The default value is /. Type: String Required: No successCodes The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299). Type: String Required: No timeoutSeconds The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2. ContainerServiceHealthCheckConfig API Version 2016-11-28 836 Amazon Lightsail Type: Integer Required: No unhealthyThreshold API Reference The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2. Type: Integer Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 837 Amazon Lightsail API Reference ContainerServiceLogEvent Describes the log events of a container of an Amazon Lightsail container service. |
amazon-lightsail-api-reference-163 | amazon-lightsail-api-reference.pdf | 163 | 2. ContainerServiceHealthCheckConfig API Version 2016-11-28 836 Amazon Lightsail Type: Integer Required: No unhealthyThreshold API Reference The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2. Type: Integer Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 837 Amazon Lightsail API Reference ContainerServiceLogEvent Describes the log events of a container of an Amazon Lightsail container service. Contents createdAt The timestamp when the container service log event was created. Type: Timestamp Required: No message The message of the container service log event. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ContainerServiceLogEvent API Version 2016-11-28 838 Amazon Lightsail API Reference ContainerServicePower Describes the powers that can be specified for an Amazon Lightsail container service. The power specifies the amount of RAM, the number of vCPUs, and the base price of the container service. Contents cpuCount The number of vCPUs included in the power. Type: Float Required: No isActive A Boolean value indicating whether the power is active and can be specified for container services. Type: Boolean Required: No name The friendly name of the power (nano). Type: String Required: No powerId The ID of the power (nano-1). Type: String Required: No price The monthly price of the power in USD. ContainerServicePower API Version 2016-11-28 839 API Reference Amazon Lightsail Type: Float Required: No ramSizeInGb The amount of RAM (in GB) of the power. Type: Float Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 840 Amazon Lightsail API Reference ContainerServiceRegistryLogin Describes the sign-in credentials for the container image registry of an Amazon Lightsail account. Contents expiresAt The timestamp of when the container image registry sign-in credentials expire. 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 using the CreateContainerServiceRegistryLogin action. Type: Timestamp Required: No password The container service registry password to use to push container images to the container image registry of a Lightsail account Type: String Required: No registry The address to use to push container images to the container image registry of a Lightsail account. Type: String Required: No username The container service registry username to use to push container images to the container image registry of a Lightsail account. Type: String Required: No ContainerServiceRegistryLogin API Version 2016-11-28 841 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 842 Amazon Lightsail API Reference ContainerServiceStateDetail Describes the current state of a container service. Contents code The state code of the container service. The following state codes are possible: • The following state codes are possible if your container service is in a DEPLOYING or UPDATING state: • CREATING_SYSTEM_RESOURCES - The system resources for your container service are being created. • CREATING_NETWORK_INFRASTRUCTURE - The network infrastructure for your container service are being created. • PROVISIONING_CERTIFICATE - The SSL/TLS certificate for your container service is being created. • PROVISIONING_SERVICE - Your container service is being provisioned. • CREATING_DEPLOYMENT - Your deployment is being created on your container service. • EVALUATING_HEALTH_CHECK - The health of your deployment is being evaluated. • ACTIVATING_DEPLOYMENT - Your deployment is being activated. • The following state codes are possible if your container service is in a PENDING state: • CERTIFICATE_LIMIT_EXCEEDED - The SSL/TLS certificate required for your container service exceeds the maximum number of certificates allowed for your account. • UNKNOWN_ERROR - An error was experienced when your container service was being created. Type: String Valid Values: CREATING_SYSTEM_RESOURCES | CREATING_NETWORK_INFRASTRUCTURE | PROVISIONING_CERTIFICATE | PROVISIONING_SERVICE | CREATING_DEPLOYMENT | EVALUATING_HEALTH_CHECK | ACTIVATING_DEPLOYMENT | CERTIFICATE_LIMIT_EXCEEDED | UNKNOWN_ERROR Required: No ContainerServiceStateDetail API Version 2016-11-28 843 Amazon Lightsail message API Reference A message that provides more information for the state code. Note The state detail is populated only when a container service is in a PENDING, DEPLOYING, or UPDATING state. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS |
amazon-lightsail-api-reference-164 | amazon-lightsail-api-reference.pdf | 164 | experienced when your container service was being created. Type: String Valid Values: CREATING_SYSTEM_RESOURCES | CREATING_NETWORK_INFRASTRUCTURE | PROVISIONING_CERTIFICATE | PROVISIONING_SERVICE | CREATING_DEPLOYMENT | EVALUATING_HEALTH_CHECK | ACTIVATING_DEPLOYMENT | CERTIFICATE_LIMIT_EXCEEDED | UNKNOWN_ERROR Required: No ContainerServiceStateDetail API Version 2016-11-28 843 Amazon Lightsail message API Reference A message that provides more information for the state code. Note The state detail is populated only when a container service is in a PENDING, DEPLOYING, or UPDATING state. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 844 Amazon Lightsail CookieObject API Reference Describes whether an Amazon Lightsail content delivery network (CDN) distribution forwards cookies to the origin and, if so, which ones. For the cookies that you specify, your distribution caches separate versions of the specified content based on the cookie values in viewer requests. Contents cookiesAllowList The specific cookies to forward to your distribution's origin. Type: Array of strings Required: No option Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter. Type: String Valid Values: none | allow-list | all Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CookieObject API Version 2016-11-28 845 Amazon Lightsail CostEstimate API Reference Describes the estimated cost for resources in your Lightsail for Research account. Contents resultsByTime The cost estimate result that's associated with a time period. Type: Array of EstimateByTime objects Required: No usageType The types of usage that are included in the estimate, such as costs, usage, or data transfer. Type: String Pattern: .*\S.* Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CostEstimate API Version 2016-11-28 846 API Reference Amazon Lightsail DestinationInfo Describes the destination of a record. Contents id The ID of the resource created at the destination. Type: String Pattern: .*\S.* Required: No service The destination service of the record. Type: String Pattern: .*\S.* Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DestinationInfo API Version 2016-11-28 847 API Reference Amazon Lightsail Disk Describes a block storage disk. Contents addOns An array of objects representing the add-ons enabled on the disk. Type: Array of AddOn objects Required: No arn The Amazon Resource Name (ARN) of the disk. Type: String Pattern: .*\S.* Required: No attachedTo The resources to which the disk is attached. Type: String Pattern: \w[\w\-]*\w Required: No attachmentState This member has been deprecated. (Discontinued) The attachment state of the disk. Note In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now discontinued, but still included in the response. Use isAttached instead. Disk API Version 2016-11-28 848 API Reference Amazon Lightsail Type: String Required: No autoMountStatus The status of automatically mounting a storage disk to a virtual computer. Important This parameter only applies to Lightsail for Research resources. Type: String Valid Values: Failed | Pending | Mounted | NotMounted Required: No createdAt The date when the disk was created. Type: Timestamp Required: No gbInUse This member has been deprecated. (Discontinued) The number of GB in use by the disk. Note In releases prior to November 14, 2017, this parameter was not included in the API response. It is now discontinued. Type: Integer Required: No Contents API Version 2016-11-28 849 Amazon Lightsail iops API Reference The input/output operations per second (IOPS) of the disk. Type: Integer Required: No isAttached A Boolean value indicating whether the disk is attached. Type: Boolean Required: No isSystemDisk A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it). Type: Boolean Required: No location The AWS Region and Availability Zone where the disk is located. Type: ResourceLocation object Required: No name The unique name of the disk. Type: String Pattern: \w[\w\-]*\w Required: No path The disk path. Contents API Version 2016-11-28 850 Amazon Lightsail Type: String Required: No resourceType The Lightsail resource type (Disk). Type: String API Reference Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | |
amazon-lightsail-api-reference-165 | amazon-lightsail-api-reference.pdf | 165 | (has an operating system loaded on it). Type: Boolean Required: No location The AWS Region and Availability Zone where the disk is located. Type: ResourceLocation object Required: No name The unique name of the disk. Type: String Pattern: \w[\w\-]*\w Required: No path The disk path. Contents API Version 2016-11-28 850 Amazon Lightsail Type: String Required: No resourceType The Lightsail resource type (Disk). Type: String API Reference Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No sizeInGb The size of the disk in GB. Type: Integer Required: No state Describes the status of the disk. Type: String Valid Values: pending | error | available | in-use | unknown Required: No supportCode The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily. Type: String Contents API Version 2016-11-28 851 Amazon Lightsail Required: No tags API Reference The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide. Type: Array of Tag objects Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 852 Amazon Lightsail DiskInfo Describes a disk. Contents isSystemDisk API Reference A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it). Type: Boolean Required: No name The disk name. Type: String Required: No path The disk path. Type: String Pattern: .*\S.* Required: No sizeInGb The size of the disk in GB (32). Type: Integer Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: DiskInfo API Version 2016-11-28 853 Amazon Lightsail • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 854 API Reference Amazon Lightsail DiskMap Describes a block storage disk mapping. Contents newDiskName The new disk name (my-new-disk). Type: String Pattern: \w[\w\-]*\w Required: No originalDiskPath The original disk path exposed to the instance (for example, /dev/sdh). Type: String Pattern: .*\S.* Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DiskMap API Version 2016-11-28 855 API Reference Amazon Lightsail DiskSnapshot Describes a block storage disk snapshot. Contents arn The Amazon Resource Name (ARN) of the disk snapshot. Type: String Pattern: .*\S.* Required: No createdAt The date when the disk snapshot was created. Type: Timestamp Required: No fromDiskArn The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created. Type: String Pattern: .*\S.* Required: No fromDiskName The unique name of the source disk from which the disk snapshot was created. Type: String Pattern: \w[\w\-]*\w Required: No DiskSnapshot API Version 2016-11-28 856 Amazon Lightsail fromInstanceArn API Reference The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created. Type: String Pattern: .*\S.* Required: No fromInstanceName The unique name of the source instance from which the disk (system volume) snapshot was created. Type: String Pattern: \w[\w\-]*\w Required: No isFromAutoSnapshot A Boolean value indicating whether the snapshot was created from an automatic snapshot. Type: Boolean Required: No location The AWS Region and Availability Zone where the disk snapshot was created. Type: ResourceLocation object Required: No name The name of the disk snapshot (my-disk-snapshot). Type: String Pattern: \w[\w\-]*\w Required: No Contents API Version 2016-11-28 857 API Reference Amazon Lightsail progress The progress of the snapshot. Type: String Required: No resourceType The Lightsail resource type (DiskSnapshot). Type: String Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No sizeInGb The size of the disk in GB. Type: Integer Required: No state The status of the disk snapshot operation. Type: String Valid Values: pending | completed | error | unknown Required: No supportCode The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily. Contents API Version 2016-11-28 |
amazon-lightsail-api-reference-166 | amazon-lightsail-api-reference.pdf | 166 | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No sizeInGb The size of the disk in GB. Type: Integer Required: No state The status of the disk snapshot operation. Type: String Valid Values: pending | completed | error | unknown Required: No supportCode The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily. Contents API Version 2016-11-28 858 Amazon Lightsail Type: String Required: No tags API Reference The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide. Type: Array of Tag objects Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 859 API Reference Amazon Lightsail DiskSnapshotInfo Describes a disk snapshot. Contents sizeInGb The size of the disk in GB (32). Type: Integer Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DiskSnapshotInfo API Version 2016-11-28 860 Amazon Lightsail DistributionBundle Describes the specifications of a distribution bundle. API Reference Contents bundleId The ID of the bundle. Type: String Required: No isActive Indicates whether the bundle is active, and can be specified for a new or existing distribution. Type: Boolean Required: No name The name of the distribution bundle. Type: String Required: No price The monthly price, in US dollars, of the bundle. Type: Float Required: No transferPerMonthInGb The monthly network transfer quota of the bundle. Type: Integer Required: No DistributionBundle API Version 2016-11-28 861 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 862 Amazon Lightsail API Reference DnsRecordCreationState Describes the creation state of the canonical name (CNAME) records that are automatically added by Amazon Lightsail to the DNS of a domain to validate domain ownership for an SSL/TLS certificate. When you create an SSL/TLS certificate for a Lightsail resource, you must add a set of CNAME records to the DNS of the domains for the certificate to validate that you own the domains. Lightsail can automatically add the CNAME records to the DNS of the domain if the DNS zone for the domain exists within your Lightsail account. If automatic record addition fails, or if you manage the DNS of your domain using a third-party service, then you must manually add the CNAME records to the DNS of your domain. For more information, see Verify an SSL/TLS certificate in Amazon Lightsail in the Amazon Lightsail Developer Guide. Contents code The status code for the automated DNS record creation. Following are the possible values: • SUCCEEDED - The validation records were successfully added to the domain. • STARTED - The automatic DNS record creation has started. • FAILED - The validation records failed to be added to the domain. Type: String Valid Values: SUCCEEDED | STARTED | FAILED Required: No message The message that describes the reason for the status code. Type: String Required: No DnsRecordCreationState API Version 2016-11-28 863 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 864 API Reference Amazon Lightsail Domain Describes a domain where you are storing recordsets. Contents arn The Amazon Resource Name (ARN) of the domain recordset (arn:aws:lightsail:global:123456789101:Domain/824cede0- abc7-4f84-8dbc-12345EXAMPLE). Type: String Pattern: .*\S.* Required: No createdAt The date when the domain recordset was created. Type: Timestamp Required: No domainEntries An array of key-value pairs containing information about the domain entries. Type: Array of DomainEntry objects Required: No location The AWS Region and Availability Zones where the domain recordset was created. Type: ResourceLocation object Required: No name The name of the domain. Domain API Version 2016-11-28 865 Amazon Lightsail Type: String Pattern: \w[\w\-]*\w Required: No registeredDomainDelegationInfo API Reference An object that describes the state of the Route 53 domain delegation to a Lightsail DNS zone. Type: RegisteredDomainDelegationInfo object Required: No resourceType The resource type. Type: String Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | |
amazon-lightsail-api-reference-167 | amazon-lightsail-api-reference.pdf | 167 | pairs containing information about the domain entries. Type: Array of DomainEntry objects Required: No location The AWS Region and Availability Zones where the domain recordset was created. Type: ResourceLocation object Required: No name The name of the domain. Domain API Version 2016-11-28 865 Amazon Lightsail Type: String Pattern: \w[\w\-]*\w Required: No registeredDomainDelegationInfo API Reference An object that describes the state of the Route 53 domain delegation to a Lightsail DNS zone. Type: RegisteredDomainDelegationInfo object Required: No resourceType The resource type. Type: String Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No supportCode The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily. Type: String Required: No tags The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide. Type: Array of Tag objects Contents API Version 2016-11-28 866 Amazon Lightsail Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 867 API Reference Amazon Lightsail DomainEntry Describes a domain recordset entry. Contents id The ID of the domain recordset entry. Type: String Pattern: .*\S.* Required: No isAlias When true, specifies whether the domain entry is an alias used by the Lightsail load balancer, Lightsail container service, Lightsail content delivery network (CDN) distribution, or another AWS resource. You can include an alias (A type) record in your request, which points to the DNS name of a load balancer, container service, CDN distribution, or other AWS resource and routes traffic to that resource. Type: Boolean Required: No name The name of the domain. Type: String Required: No options This member has been deprecated. (Discontinued) The options for the domain entry. DomainEntry API Version 2016-11-28 868 Amazon Lightsail Note API Reference In releases prior to November 29, 2017, this parameter was not included in the API response. It is now discontinued. Type: String to string map Required: No target The target IP address (192.0.2.0), or AWS name server (ns-111.awsdns-22.com.). For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. For Lightsail distributions, the value looks like exampled1182ne.cloudfront.net. For Lightsail container services, the value looks like container- service-1.example23scljs.us-west-2.cs.amazonlightsail.com. Be sure to also set isAlias to true when setting up an A record for a Lightsail load balancer, distribution, or container service. Type: String Required: No type The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT). The following domain entry types can be used: • A • AAAA • CNAME • MX • NS • SOA Contents API Version 2016-11-28 869 Amazon Lightsail • SRV • TXT Type: String Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 870 Amazon Lightsail API Reference DomainValidationRecord Describes the domain name system (DNS) records that you must add to the DNS of your registered domain to validate ownership for an Amazon Lightsail SSL/TLS certificate. Contents dnsRecordCreationState An object that describes the state of the canonical name (CNAME) records that are automatically added by Lightsail to the DNS of the domain to validate domain ownership. Type: DnsRecordCreationState object Required: No domainName The domain name of the certificate validation record. For example, example.com or www.example.com. Type: String Required: No resourceRecord An object that describes the DNS records to add to your domain's DNS to validate it for the certificate. Type: ResourceRecord object Required: No validationStatus The validation status of the record. Type: String Valid Values: PENDING_VALIDATION | FAILED | SUCCESS Required: No DomainValidationRecord API Version 2016-11-28 871 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 872 Amazon Lightsail EndpointRequest API Reference Describes the settings of a public endpoint for an Amazon Lightsail container service. Contents containerName The name of the container for the endpoint. Type: String Required: Yes containerPort The port of the container to which |
amazon-lightsail-api-reference-168 | amazon-lightsail-api-reference.pdf | 168 | Valid Values: PENDING_VALIDATION | FAILED | SUCCESS Required: No DomainValidationRecord API Version 2016-11-28 871 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 872 Amazon Lightsail EndpointRequest API Reference Describes the settings of a public endpoint for an Amazon Lightsail container service. Contents containerName The name of the container for the endpoint. Type: String Required: Yes containerPort The port of the container to which traffic is forwarded to. Type: Integer Required: Yes healthCheck An object that describes the health check configuration of the container. Type: ContainerServiceHealthCheckConfig object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 EndpointRequest API Version 2016-11-28 873 API Reference Amazon Lightsail EstimateByTime An estimate that's associated with a time period. Contents currency The currency of the estimate in USD. Type: String Valid Values: USD Required: No pricingUnit The unit of measurement that's used for the cost estimate. Type: String Valid Values: GB | Hrs | GB-Mo | Bundles | Queries Required: No timePeriod The period of time, in days, that an estimate covers. The period has a start date and an end date. The start date must come before the end date. Type: TimePeriod object Required: No unit The number of pricing units used to calculate the total number of hours. For example, 1 unit equals 1 hour. Type: Double Required: No EstimateByTime API Version 2016-11-28 874 Amazon Lightsail usageCost API Reference The amount of cost or usage that's measured for the cost estimate. Type: Double Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 875 Amazon Lightsail API Reference ExportSnapshotRecord Describes an export snapshot record. Contents arn The Amazon Resource Name (ARN) of the export snapshot record. Type: String Pattern: .*\S.* Required: No createdAt The date when the export snapshot record was created. Type: Timestamp Required: No destinationInfo A list of objects describing the destination of the export snapshot record. Type: DestinationInfo object Required: No location The AWS Region and Availability Zone where the export snapshot record is located. Type: ResourceLocation object Required: No name The export snapshot record name. Type: String ExportSnapshotRecord API Version 2016-11-28 876 Amazon Lightsail Pattern: \w[\w\-]*\w Required: No resourceType API Reference The Lightsail resource type (ExportSnapshotRecord). Type: String Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No sourceInfo A list of objects describing the source of the export snapshot record. Type: ExportSnapshotRecordSourceInfo object Required: No state The state of the export snapshot record. Type: String Valid Values: Started | Succeeded | Failed Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ See Also API Version 2016-11-28 877 Amazon Lightsail • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 878 Amazon Lightsail API Reference ExportSnapshotRecordSourceInfo Describes the source of an export snapshot record. Contents arn The Amazon Resource Name (ARN) of the source instance or disk snapshot. Type: String Pattern: .*\S.* Required: No createdAt The date when the source instance or disk snapshot was created. Type: Timestamp Required: No diskSnapshotInfo A list of objects describing a disk snapshot. Type: DiskSnapshotInfo object Required: No fromResourceArn The Amazon Resource Name (ARN) of the snapshot's source instance or disk. Type: String Pattern: .*\S.* Required: No fromResourceName The name of the snapshot's source instance or disk. ExportSnapshotRecordSourceInfo API Version 2016-11-28 879 API Reference Amazon Lightsail Type: String Pattern: .*\S.* Required: No instanceSnapshotInfo A list of objects describing an instance snapshot. Type: InstanceSnapshotInfo object Required: No name The name of the source instance or disk snapshot. Type: String Pattern: .*\S.* Required: No resourceType The Lightsail resource type (InstanceSnapshot or DiskSnapshot). Type: String Valid Values: InstanceSnapshot | DiskSnapshot Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 880 Amazon Lightsail HeaderObject API Reference Describes the request headers that a Lightsail distribution bases caching |
amazon-lightsail-api-reference-169 | amazon-lightsail-api-reference.pdf | 169 | objects describing an instance snapshot. Type: InstanceSnapshotInfo object Required: No name The name of the source instance or disk snapshot. Type: String Pattern: .*\S.* Required: No resourceType The Lightsail resource type (InstanceSnapshot or DiskSnapshot). Type: String Valid Values: InstanceSnapshot | DiskSnapshot Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 880 Amazon Lightsail HeaderObject API Reference Describes the request headers that a Lightsail distribution bases caching on. For the headers that you specify, your distribution caches separate versions of the specified content based on the header values in viewer requests. For example, suppose viewer requests for logo.jpg contain a custom product header that has a value of either acme or apex, and you configure your distribution to cache your content based on values in the product header. Your distribution forwards the product header to the origin and caches the response from the origin once for each header value. Contents headersAllowList The specific headers to forward to your distribution's origin. Type: Array of strings Valid Values: Accept | Accept-Charset | Accept-Datetime | Accept-Encoding | Accept-Language | Authorization | CloudFront-Forwarded-Proto | CloudFront-Is-Desktop-Viewer | CloudFront-Is-Mobile-Viewer | CloudFront- Is-SmartTV-Viewer | CloudFront-Is-Tablet-Viewer | CloudFront-Viewer- Country | Host | Origin | Referer Required: No option The headers that you want your distribution to forward to your origin and base caching on. You can configure your distribution to do one of the following: • all - Forward all headers to your origin. • none - Forward only the default headers. • allow-list - Forward only the headers you specify using the headersAllowList parameter. Type: String Valid Values: none | allow-list | all HeaderObject API Version 2016-11-28 881 Amazon Lightsail Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 882 Amazon Lightsail HostKeyAttributes Describes the public SSH host keys or the RDP certificate. API Reference Contents algorithm The SSH host key algorithm or the RDP certificate format. For SSH host keys, the algorithm may be ssh-rsa, ecdsa-sha2-nistp256, ssh-ed25519, etc. For RDP certificates, the algorithm is always x509-cert. Type: String Required: No fingerprintSHA1 The SHA-1 fingerprint of the returned SSH host key or RDP certificate. • Example of an SHA-1 SSH fingerprint: SHA1:1CHH6FaAaXjtFOsR/t83vf91SR0 • Example of an SHA-1 RDP fingerprint: af:34:51:fe:09:f0:e0:da:b8:4e:56:ca:60:c2:10:ff:38:06:db:45 Type: String Required: No fingerprintSHA256 The SHA-256 fingerprint of the returned SSH host key or RDP certificate. • Example of an SHA-256 SSH fingerprint: SHA256:KTsMnRBh1IhD17HpdfsbzeGA4jOijm5tyXsMjKVbB8o • Example of an SHA-256 RDP fingerprint: 03:9b:36:9f:4b:de:4e:61:70:fc:7c:c9:78:e7:d2:1a:1c:25:a8:0c:91:f6:7c:e4:d6:a0:85:c8:b4:53:99:68 Type: String HostKeyAttributes API Version 2016-11-28 883 API Reference Amazon Lightsail Required: No notValidAfter The returned RDP certificate is not valid after this point in time. This value is listed only for RDP certificates. Type: Timestamp Required: No notValidBefore The returned RDP certificate is valid after this point in time. This value is listed only for RDP certificates. Type: Timestamp Required: No publicKey The public SSH host key or the RDP certificate. Type: String Required: No witnessedAt The time that the SSH host key or RDP certificate was recorded by Lightsail. Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 See Also API Version 2016-11-28 884 Amazon Lightsail • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 885 Amazon Lightsail InputOrigin API Reference Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution. An origin can be a Lightsail instance, bucket, container service, or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide network of edge servers. Contents name The name of the origin resource. Type: String Pattern: \w[\w\-]*\w Required: No protocolPolicy The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content. Type: String Valid Values: http-only | https-only Required: No regionName The AWS Region name of the origin resource. 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: No InputOrigin API Version 2016-11-28 886 Amazon Lightsail responseTimeout API Reference The amount of time, in seconds, that the distribution waits for a response after forwarding a request to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify |
amazon-lightsail-api-reference-170 | amazon-lightsail-api-reference.pdf | 170 | Values: http-only | https-only Required: No regionName The AWS Region name of the origin resource. 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: No InputOrigin API Version 2016-11-28 886 Amazon Lightsail responseTimeout API Reference The amount of time, in seconds, that the distribution waits for a response after forwarding a request to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds. Type: Integer Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 887 Amazon Lightsail Instance Describes an instance (a virtual private server). Contents addOns API Reference An array of objects representing the add-ons enabled on the instance. Type: Array of AddOn objects Required: No arn The Amazon Resource Name (ARN) of the instance (arn:aws:lightsail:us- east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE). Type: String Pattern: .*\S.* Required: No blueprintId The blueprint ID (amazon_linux_2023). Type: String Pattern: .*\S.* Required: No blueprintName The friendly name of the blueprint (Amazon Linux 2023). Type: String Pattern: .*\S.* Required: No Instance API Version 2016-11-28 888 API Reference Amazon Lightsail bundleId The bundle for the instance (micro_x_x). Type: String Pattern: .*\S.* Required: No createdAt The timestamp when the instance was created (1479734909.17) in Unix time format. Type: Timestamp Required: No hardware The size of the vCPU and the amount of RAM for the instance. Type: InstanceHardware object Required: No ipAddressType The IP address type of the instance. The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6. Type: String Valid Values: dualstack | ipv4 | ipv6 Required: No ipv6Addresses The IPv6 addresses of the instance. Type: Array of strings Pattern: ([A-F0-9]{1,4}:){7}[A-F0-9]{1,4} Contents API Version 2016-11-28 889 Amazon Lightsail Required: No isStaticIp API Reference A Boolean value indicating whether this instance has a static IP assigned to it. Type: Boolean Required: No location The region name and Availability Zone where the instance is located. Type: ResourceLocation object Required: No metadataOptions The metadata options for the Amazon Lightsail instance. Type: InstanceMetadataOptions object Required: No name The name the user gave the instance (Amazon_Linux_2023-1). Type: String Pattern: \w[\w\-]*\w Required: No networking Information about the public ports and monthly data transfer rates for the instance. Type: InstanceNetworking object Required: No privateIpAddress The private IP address of the instance. Contents API Version 2016-11-28 890 API Reference Amazon Lightsail Type: String Pattern: ([0-9]{1,3}\.){3}[0-9]{1,3} Required: No publicIpAddress The public IP address of the instance. Type: String Pattern: ([0-9]{1,3}\.){3}[0-9]{1,3} Required: No resourceType The type of resource (usually Instance). Type: String Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No sshKeyName The name of the SSH key being used to connect to the instance (LightsailDefaultKeyPair). Type: String Pattern: \w[\w\-]*\w Required: No state The status code and the state (running) for the instance. Contents API Version 2016-11-28 891 Amazon Lightsail Type: InstanceState object Required: No supportCode API Reference The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily. Type: String Required: No tags The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide. Type: Array of Tag objects Required: No username The user name for connecting to the instance (ec2-user). Type: String Pattern: .*\S.* Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 892 Amazon Lightsail API Reference InstanceAccessDetails The parameters for gaining temporary access to one of your Amazon Lightsail instances. Contents certKey For SSH access, the public key to use when accessing your instance For OpenSSH clients (command line SSH), you should save this value to tempkey-cert.pub. Type: String Required: No expiresAt For SSH access, the date on which the temporary keys expire. Type: Timestamp Required: No hostKeys Describes the public SSH host keys or the RDP certificate. Type: Array of HostKeyAttributes objects Required: No instanceName The name of this Amazon Lightsail instance. Type: String Pattern: \w[\w\-]*\w Required: No ipAddress The public IP address of the Amazon Lightsail |
amazon-lightsail-api-reference-171 | amazon-lightsail-api-reference.pdf | 171 | parameters for gaining temporary access to one of your Amazon Lightsail instances. Contents certKey For SSH access, the public key to use when accessing your instance For OpenSSH clients (command line SSH), you should save this value to tempkey-cert.pub. Type: String Required: No expiresAt For SSH access, the date on which the temporary keys expire. Type: Timestamp Required: No hostKeys Describes the public SSH host keys or the RDP certificate. Type: Array of HostKeyAttributes objects Required: No instanceName The name of this Amazon Lightsail instance. Type: String Pattern: \w[\w\-]*\w Required: No ipAddress The public IP address of the Amazon Lightsail instance. Type: String InstanceAccessDetails API Version 2016-11-28 893 Amazon Lightsail API Reference Pattern: ([0-9]{1,3}\.){3}[0-9]{1,3} Required: No ipv6Addresses The IPv6 address of the Amazon Lightsail instance. Type: Array of strings Pattern: ([A-F0-9]{1,4}:){7}[A-F0-9]{1,4} Required: No password For RDP access, the password for your Amazon Lightsail instance. Password will be an empty string if the password for your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready. Note If you create an instance using any key pair other than the default (LightsailDefaultKeyPair), password will always be an empty string. If you change the Administrator password on the instance, Lightsail will continue to return the original password value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default. Type: String Required: No passwordData For a Windows Server-based instance, an object with the data you can use to retrieve your password. This is only needed if password is empty and the instance is not new (and therefore the password is not ready yet). When you create an instance, it can take up to 15 minutes for the instance to be ready. Type: PasswordData object Required: No Contents API Version 2016-11-28 894 Amazon Lightsail privateKey API Reference For SSH access, the temporary private key. For OpenSSH clients (command line SSH), you should save this value to tempkey). Type: String Required: No protocol The protocol for these Amazon Lightsail instance access details. Type: String Valid Values: ssh | rdp Required: No username The user name to use when logging in to the Amazon Lightsail instance. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 895 Amazon Lightsail InstanceEntry API Reference Describes the Amazon Elastic Compute Cloud instance and related resources to be created using the create cloud formation stack operation. Contents availabilityZone The Availability Zone for the new Amazon EC2 instance. Type: String Required: Yes instanceType The instance type (t2.micro) to use for the new Amazon EC2 instance. Type: String Pattern: .*\S.* Required: Yes portInfoSource The port configuration to use for the new Amazon EC2 instance. The following configuration options are available: • DEFAULT - Use the default firewall settings from the Lightsail instance blueprint. If this is specified, then IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2. • INSTANCE - Use the configured firewall settings from the source Lightsail instance. If this is specified, the new instance that is created in Amazon EC2 will be configured to match the configuration of the source Lightsail instance. For example, if the source instance is configured for dual-stack (IPv4 and IPv6), then IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2. If the source instance is configured for IPv4 only, then only IPv4 will be configured for the new instance that is created in Amazon EC2. • NONE - Use the default Amazon EC2 security group. If this is specified, then only IPv4 will be configured for the new instance that is created in Amazon EC2. InstanceEntry API Version 2016-11-28 896 Amazon Lightsail API Reference • CLOSED - All ports closed. If this is specified, then only IPv4 will be configured for the new instance that is created in Amazon EC2. Note If you configured lightsail-connect as a cidrListAliases on your instance, or if you chose to allow the Lightsail browser-based SSH or RDP clients to connect to your instance, that configuration is not carried over to your new Amazon EC2 instance. Type: String Valid Values: DEFAULT | INSTANCE | NONE | CLOSED Required: Yes sourceName The name of the export snapshot record, which contains the exported Lightsail instance snapshot that will be used as the source of the new Amazon EC2 instance. Use the get export snapshot records operation to get a list of export snapshot records that you can use to create a CloudFormation stack. Type: String Pattern: \w[\w\-]*\w Required: Yes |
amazon-lightsail-api-reference-172 | amazon-lightsail-api-reference.pdf | 172 | if you chose to allow the Lightsail browser-based SSH or RDP clients to connect to your instance, that configuration is not carried over to your new Amazon EC2 instance. Type: String Valid Values: DEFAULT | INSTANCE | NONE | CLOSED Required: Yes sourceName The name of the export snapshot record, which contains the exported Lightsail instance snapshot that will be used as the source of the new Amazon EC2 instance. Use the get export snapshot records operation to get a list of export snapshot records that you can use to create a CloudFormation stack. Type: String Pattern: \w[\w\-]*\w Required: Yes userData A launch script you can create that configures 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. Contents API Version 2016-11-28 897 Amazon Lightsail Type: String Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 898 API Reference Amazon Lightsail InstanceHardware Describes the hardware for the instance. Contents cpuCount The number of vCPUs the instance has. Type: Integer Required: No disks The disks attached to the instance. Type: Array of Disk objects Required: No ramSizeInGb The amount of RAM in GB on the instance (1.0). Type: Float Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 InstanceHardware API Version 2016-11-28 899 Amazon Lightsail API Reference InstanceHealthSummary Describes information about the health of the instance. Contents instanceHealth Describes the overall instance health. Valid values are below. Type: String Valid Values: initial | healthy | unhealthy | unused | draining | unavailable Required: No instanceHealthReason More information about the instance health. If the instanceHealth is healthy, then an instanceHealthReason value is not provided. If instanceHealth is initial, the instanceHealthReason value can be one of the following: • Lb.RegistrationInProgress - The target instance is in the process of being registered with the load balancer. • Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status. If instanceHealth is unhealthy, the instanceHealthReason value can be one of the following: • Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code. • Instance.Timeout - The health check requests timed out. • Instance.FailedHealthChecks - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason. • Lb.InternalError - The health checks failed due to an internal error. InstanceHealthSummary API Version 2016-11-28 900 Amazon Lightsail API Reference If instanceHealth is unused, the instanceHealthReason value can be one of the following: • Instance.NotRegistered - The target instance is not registered with the target group. • Instance.NotInUse - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer. • Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load balancer. • Instance.InvalidState - The target is in the stopped or terminated state. If instanceHealth is draining, the instanceHealthReason value can be one of the following: • Instance.DeregistrationInProgress - The target instance is in the process of being deregistered and the deregistration delay period has not expired. Type: String Valid Values: Lb.RegistrationInProgress | Lb.InitialHealthChecking | Lb.InternalError | Instance.ResponseCodeMismatch | Instance.Timeout | Instance.FailedHealthChecks | Instance.NotRegistered | Instance.NotInUse | Instance.DeregistrationInProgress | Instance.InvalidState | Instance.IpUnusable Required: No instanceName The name of the Lightsail instance for which you are requesting health check data. Type: String Pattern: \w[\w\-]*\w Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2016-11-28 901 Amazon Lightsail • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 902 Amazon Lightsail API Reference InstanceMetadataOptions The metadata options for the instance. Contents httpEndpoint Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled. If the value is disabled, you cannot access your instance metadata. Type: String Valid Values: disabled | enabled Required: No httpProtocolIpv6 Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled. Type: String Valid Values: disabled | enabled Required: No httpPutResponseHopLimit |
amazon-lightsail-api-reference-173 | amazon-lightsail-api-reference.pdf | 173 | 2016-11-28 901 Amazon Lightsail • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 902 Amazon Lightsail API Reference InstanceMetadataOptions The metadata options for the instance. Contents httpEndpoint Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled. If the value is disabled, you cannot access your instance metadata. Type: String Valid Values: disabled | enabled Required: No httpProtocolIpv6 Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled. Type: String Valid Values: disabled | enabled Required: No httpPutResponseHopLimit The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther. Type: Integer Required: No httpTokens The state of token usage for your instance metadata requests. If the state is optional, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned. InstanceMetadataOptions API Version 2016-11-28 903 Amazon Lightsail API Reference If the state is required, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available. Important Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken instance metric to track the number of calls to the instance metadata service that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide. Type: String Valid Values: optional | required Required: No state The state of the metadata option changes. The following states are possible: • pending - The metadata options are being updated. The instance is not yet ready to process metadata traffic with the new selection. • applied - The metadata options have been successfully applied to the instance. Type: String Valid Values: pending | applied Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 See Also API Version 2016-11-28 904 Amazon Lightsail • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 905 Amazon Lightsail API Reference InstanceNetworking Describes monthly data transfer rates and port information for an instance. Contents monthlyTransfer The amount of data in GB allocated for monthly data transfers. Type: MonthlyTransfer object Required: No ports An array of key-value pairs containing information about the ports on the instance. Type: Array of InstancePortInfo objects Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 InstanceNetworking API Version 2016-11-28 906 Amazon Lightsail InstancePortInfo API Reference Describes information about ports for an Amazon Lightsail instance. Contents accessDirection The access direction (inbound or outbound). Note Lightsail currently supports only inbound access direction. Type: String Valid Values: inbound | outbound Required: No accessFrom The location from which access is allowed. For example, Anywhere (0.0.0.0/0), or Custom if a specific IP address or range of IP addresses is allowed. Type: String Required: No accessType The type of access (Public or Private). Type: String Valid Values: Public | Private Required: No cidrListAliases An alias that defines access for a preconfigured range of IP addresses. InstancePortInfo API Version 2016-11-28 907 Amazon Lightsail API Reference The only alias currently supported is lightsail-connect, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance. Type: Array of strings Required: No cidrs The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Note The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance. For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia. Type: Array of strings Required: No commonName The common name of the port information. Type: String Required: No fromPort The first port in a range of open ports on an instance. Allowed ports: • TCP and UDP - 0 to 65535 • ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia. Contents API Version 2016-11-28 908 Amazon Lightsail API Reference • ICMPv6 - The ICMP type for IPv6 addresses. For example, |
amazon-lightsail-api-reference-174 | amazon-lightsail-api-reference.pdf | 174 | on Wikipedia. Type: Array of strings Required: No commonName The common name of the port information. Type: String Required: No fromPort The first port in a range of open ports on an instance. Allowed ports: • TCP and UDP - 0 to 65535 • ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia. Contents API Version 2016-11-28 908 Amazon Lightsail API Reference • ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6. Type: Integer Valid Range: Minimum value of -1. Maximum value of 65535. Required: No ipv6Cidrs The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used. Note The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance. For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia. Type: Array of strings Required: No protocol The IP protocol name. The name can be one of the following: • tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead. • all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia. Contents API Version 2016-11-28 909 Amazon Lightsail API Reference • udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead. • icmp - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter. • icmp6 - Internet Control Message Protocol (ICMP) for IPv6. When you specify icmp6 as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter. Type: String Valid Values: tcp | all | udp | icmp | icmpv6 Required: No toPort The last port in a range of open ports on an instance. Allowed ports: • TCP and UDP - 0 to 65535 • ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia. • ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6. Type: Integer Valid Range: Minimum value of -1. Maximum value of 65535. Required: No Contents API Version 2016-11-28 910 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 911 Amazon Lightsail InstancePortState API Reference Describes open ports on an instance, the IP addresses allowed to connect to the instance through the ports, and the protocol. Contents cidrListAliases An alias that defines access for a preconfigured range of IP addresses. The only alias currently supported is lightsail-connect, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance. Type: Array of strings Required: No cidrs The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Note The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance. For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia. Type: Array of strings Required: No fromPort The first port in a range of open ports on an instance. Allowed ports: • TCP and UDP - 0 to 65535 InstancePortState API Version 2016-11-28 912 Amazon Lightsail |
amazon-lightsail-api-reference-175 | amazon-lightsail-api-reference.pdf | 175 | to your instance. Type: Array of strings Required: No cidrs The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Note The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance. For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia. Type: Array of strings Required: No fromPort The first port in a range of open ports on an instance. Allowed ports: • TCP and UDP - 0 to 65535 InstancePortState API Version 2016-11-28 912 Amazon Lightsail API Reference • ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia. • ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6. Type: Integer Valid Range: Minimum value of -1. Maximum value of 65535. Required: No ipv6Cidrs The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used. Note The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance. For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia. Type: Array of strings Required: No protocol The IP protocol name. The name can be one of the following: • tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead. Contents API Version 2016-11-28 913 Amazon Lightsail API Reference • all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia. • udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead. • icmp - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter. • icmp6 - Internet Control Message Protocol (ICMP) for IPv6. When you specify icmp6 as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter. Type: String Valid Values: tcp | all | udp | icmp | icmpv6 Required: No state Specifies whether the instance port is open or closed. Note The port state for Lightsail instances is always open. Type: String Valid Values: open | closed Required: No toPort The last port in a range of open ports on an instance. Contents API Version 2016-11-28 914 Amazon Lightsail Allowed ports: • TCP and UDP - 0 to 65535 API Reference • ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia. • ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6. Type: Integer Valid Range: Minimum value of -1. Maximum value of 65535. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 915 Amazon Lightsail InstanceSnapshot Describes an instance snapshot. Contents arn API Reference The Amazon Resource Name (ARN) of the snapshot (arn:aws:lightsail:us- east-2:123456789101:InstanceSnapshot/ d23b5706-3322-4d83-81e5-12345EXAMPLE). Type: String Pattern: .*\S.* Required: No createdAt The timestamp when the snapshot was created (1479907467.024). Type: Timestamp Required: No fromAttachedDisks An array of disk objects containing information about all block storage disks. Type: Array of Disk objects Required: No fromBlueprintId The blueprint ID from which you created the snapshot (amazon_linux_2023). A blueprint is a virtual private server (or instance) image used |
amazon-lightsail-api-reference-176 | amazon-lightsail-api-reference.pdf | 176 | AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 915 Amazon Lightsail InstanceSnapshot Describes an instance snapshot. Contents arn API Reference The Amazon Resource Name (ARN) of the snapshot (arn:aws:lightsail:us- east-2:123456789101:InstanceSnapshot/ d23b5706-3322-4d83-81e5-12345EXAMPLE). Type: String Pattern: .*\S.* Required: No createdAt The timestamp when the snapshot was created (1479907467.024). Type: Timestamp Required: No fromAttachedDisks An array of disk objects containing information about all block storage disks. Type: Array of Disk objects Required: No fromBlueprintId The blueprint ID from which you created the snapshot (amazon_linux_2023). A blueprint is a virtual private server (or instance) image used to create instances quickly. Type: String Required: No fromBundleId The bundle ID from which you created the snapshot (micro_x_x). InstanceSnapshot API Version 2016-11-28 916 Amazon Lightsail Type: String Required: No fromInstanceArn API Reference The Amazon Resource Name (ARN) of the instance from which the snapshot was created (arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c- ccb1-430b-8daf-12345EXAMPLE). Type: String Pattern: .*\S.* Required: No fromInstanceName The instance from which the snapshot was created. Type: String Pattern: \w[\w\-]*\w Required: No isFromAutoSnapshot A Boolean value indicating whether the snapshot was created from an automatic snapshot. Type: Boolean Required: No location The region name and Availability Zone where you created the snapshot. Type: ResourceLocation object Required: No name The name of the snapshot. Type: String Contents API Version 2016-11-28 917 Amazon Lightsail Pattern: \w[\w\-]*\w Required: No progress The progress of the snapshot. Note API Reference This is populated only for disk snapshots, and is null for instance snapshots. Type: String Required: No resourceType The type of resource (usually InstanceSnapshot). Type: String Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No sizeInGb The size in GB of the SSD. Type: Integer Required: No state The state the snapshot is in. Type: String Contents API Version 2016-11-28 918 Amazon Lightsail API Reference Valid Values: pending | error | available Required: No supportCode The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily. Type: String Required: No tags The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide. Type: Array of Tag objects Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 919 Amazon Lightsail API Reference InstanceSnapshotInfo Describes an instance snapshot. Contents fromBlueprintId The blueprint ID from which the source instance (amazon_linux_2023). Type: String Pattern: .*\S.* Required: No fromBundleId The bundle ID from which the source instance was created (micro_x_x). Type: String Pattern: .*\S.* Required: No fromDiskInfo A list of objects describing the disks that were attached to the source instance. Type: Array of DiskInfo objects Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 InstanceSnapshotInfo API Version 2016-11-28 920 Amazon Lightsail API Reference See Also API Version 2016-11-28 921 Amazon Lightsail InstanceState Describes the virtual private server (or instance) status. API Reference Contents code The status code for the instance. Type: Integer Required: No name The state of the instance (running or pending). Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 InstanceState API Version 2016-11-28 922 Amazon Lightsail KeyPair Describes an SSH key pair. Contents arn API Reference The Amazon Resource Name (ARN) of the key pair (arn:aws:lightsail:us- east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE). Type: String Pattern: .*\S.* Required: No createdAt The timestamp when the key pair was created (1479816991.349). Type: Timestamp Required: No fingerprint The RSA fingerprint of the key pair. Type: String Required: No location The region name and Availability Zone where the key pair was created. Type: ResourceLocation object Required: No name The friendly name of the SSH key pair. Type: String KeyPair API Version 2016-11-28 923 Amazon Lightsail Pattern: \w[\w\-]*\w Required: No resourceType The resource type (usually KeyPair). Type: String API Reference Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No supportCode |
amazon-lightsail-api-reference-177 | amazon-lightsail-api-reference.pdf | 177 | key pair. Type: String Required: No location The region name and Availability Zone where the key pair was created. Type: ResourceLocation object Required: No name The friendly name of the SSH key pair. Type: String KeyPair API Version 2016-11-28 923 Amazon Lightsail Pattern: \w[\w\-]*\w Required: No resourceType The resource type (usually KeyPair). Type: String API Reference Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No supportCode The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily. Type: String Required: No tags The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide. Type: Array of Tag objects Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2016-11-28 924 Amazon Lightsail • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 925 Amazon Lightsail API Reference LightsailDistribution Describes an Amazon Lightsail content delivery network (CDN) distribution. Contents ableToUpdateBundle Indicates whether the bundle that is currently applied to your distribution, specified using the distributionName parameter, can be changed to another bundle. Use the UpdateDistributionBundle action to change your distribution's bundle. Type: Boolean Required: No alternativeDomainNames The alternate domain names of the distribution. Type: Array of strings Required: No arn The Amazon Resource Name (ARN) of the distribution. Type: String Pattern: .*\S.* Required: No bundleId The ID of the bundle currently applied to the distribution. Type: String Required: No cacheBehaviors An array of objects that describe the per-path cache behavior of the distribution. LightsailDistribution API Version 2016-11-28 926 Amazon Lightsail API Reference Type: Array of CacheBehaviorPerPath objects Required: No cacheBehaviorSettings An object that describes the cache behavior settings of the distribution. Type: CacheSettings object Required: No certificateName The name of the SSL/TLS certificate attached to the distribution, if any. Type: String Pattern: \w[\w\-]*\w Required: No createdAt The timestamp when the distribution was created. Type: Timestamp Required: No defaultCacheBehavior An object that describes the default cache behavior of the distribution. Type: CacheBehavior object Required: No domainName The domain name of the distribution. Type: String Required: No ipAddressType The IP address type of the distribution. Contents API Version 2016-11-28 927 Amazon Lightsail API Reference The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. Type: String Valid Values: dualstack | ipv4 | ipv6 Required: No isEnabled Indicates whether the distribution is enabled. Type: Boolean Required: No location An object that describes the location of the distribution, such as the AWS Region and Availability Zone. Note 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. Type: ResourceLocation object Required: No name The name of the distribution. Type: String Pattern: \w[\w\-]*\w Required: No origin An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer. Contents API Version 2016-11-28 928 Amazon Lightsail API Reference The distribution pulls, caches, and serves content from the origin. Type: Origin object Required: No originPublicDNS The public DNS of the origin. Type: String Required: No resourceType The Lightsail resource type (Distribution). Type: String Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No status The status of the distribution. Type: String Required: No supportCode The support code. Include this code in your email to support when you have questions about your Lightsail distribution. This code enables our support team to look up your Lightsail information more easily. Type: String Contents API Version 2016-11-28 929 Amazon Lightsail Required: No tags API Reference The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide. Type: Array of Tag objects Required: No viewerMinimumTlsProtocolVersion The minimum TLS protocol version that the distribution can use to communicate with viewers. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 930 API Reference Amazon Lightsail LoadBalancer |
amazon-lightsail-api-reference-178 | amazon-lightsail-api-reference.pdf | 178 | Required: No tags API Reference The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide. Type: Array of Tag objects Required: No viewerMinimumTlsProtocolVersion The minimum TLS protocol version that the distribution can use to communicate with viewers. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 930 API Reference Amazon Lightsail LoadBalancer Describes a load balancer. Contents arn The Amazon Resource Name (ARN) of the load balancer. Type: String Pattern: .*\S.* Required: No configurationOptions A string to string map of the configuration options for your load balancer. Valid values are listed below. Type: String to string map Valid Keys: HealthCheckPath | SessionStickinessEnabled | SessionStickiness_LB_CookieDurationSeconds | HttpsRedirectionEnabled | TlsPolicyName Required: No createdAt The date when your load balancer was created. Type: Timestamp Required: No dnsName The DNS name of your Lightsail load balancer. Type: String Pattern: .*\S.* LoadBalancer API Version 2016-11-28 931 Amazon Lightsail Required: No healthCheckPath API Reference The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a request to the default (root) page. Type: String Pattern: .*\S.* Required: No httpsRedirectionEnabled A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer. Type: Boolean Required: No instanceHealthSummary An array of InstanceHealthSummary objects describing the health of the load balancer. Type: Array of InstanceHealthSummary objects Required: No instancePort The port where the load balancer will direct traffic to your Lightsail instances. For HTTP traffic, it's port 80. For HTTPS traffic, it's port 443. Type: Integer Required: No ipAddressType The IP address type of the load balancer. The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6. Type: String Contents API Version 2016-11-28 932 Amazon Lightsail API Reference Valid Values: dualstack | ipv4 | ipv6 Required: No location The AWS Region where your load balancer was created (us-east-2a). Lightsail automatically creates your load balancer across Availability Zones. Type: ResourceLocation object Required: No name The name of the load balancer (my-load-balancer). Type: String Pattern: \w[\w\-]*\w Required: No protocol The protocol you have enabled for your load balancer. Valid values are below. You can't just have HTTP_HTTPS, but you can have just HTTP. Type: String Valid Values: HTTP_HTTPS | HTTP Required: No publicPorts An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443. Type: Array of integers Valid Range: Minimum value of -1. Maximum value of 65535. Required: No Contents API Version 2016-11-28 933 Amazon Lightsail resourceType The resource type (LoadBalancer. Type: String API Reference Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No state The status of your load balancer. Valid values are below. Type: String Valid Values: active | provisioning | active_impaired | failed | unknown Required: No supportCode The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily. Type: String Required: No tags The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide. Type: Array of Tag objects Required: No Contents API Version 2016-11-28 934 Amazon Lightsail tlsCertificateSummaries API Reference An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if true, the certificate is attached to the load balancer. Type: Array of LoadBalancerTlsCertificateSummary objects Required: No tlsPolicyName The name of the TLS security policy for the load balancer. Type: String Pattern: \w[\w\-]*\w Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 935 Amazon Lightsail API Reference LoadBalancerTlsCertificate Describes a load balancer SSL/TLS certificate. TLS is just an updated, more secure version of Secure Socket Layer (SSL). Contents arn The Amazon Resource Name (ARN) of the SSL/TLS certificate. Type: String Pattern: .*\S.* Required: No createdAt The time when you created your SSL/TLS certificate. Type: Timestamp Required: No domainName The domain name for your SSL/TLS certificate. Type: String Required: No domainValidationRecords An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records. Type: Array of LoadBalancerTlsCertificateDomainValidationRecord objects Required: No failureReason The validation failure reason, if any, |
amazon-lightsail-api-reference-179 | amazon-lightsail-api-reference.pdf | 179 | AWS SDK for Ruby V3 See Also API Version 2016-11-28 935 Amazon Lightsail API Reference LoadBalancerTlsCertificate Describes a load balancer SSL/TLS certificate. TLS is just an updated, more secure version of Secure Socket Layer (SSL). Contents arn The Amazon Resource Name (ARN) of the SSL/TLS certificate. Type: String Pattern: .*\S.* Required: No createdAt The time when you created your SSL/TLS certificate. Type: Timestamp Required: No domainName The domain name for your SSL/TLS certificate. Type: String Required: No domainValidationRecords An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records. Type: Array of LoadBalancerTlsCertificateDomainValidationRecord objects Required: No failureReason The validation failure reason, if any, of the certificate. LoadBalancerTlsCertificate API Version 2016-11-28 936 Amazon Lightsail API Reference The following failure reasons are possible: • NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates. • ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support. Note You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com. • DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do. If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate. If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case. • INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain. • OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request. Type: String Contents API Version 2016-11-28 937 Amazon Lightsail API Reference Valid Values: NO_AVAILABLE_CONTACTS | ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED | INVALID_PUBLIC_DOMAIN | OTHER Required: No isAttached When true, the SSL/TLS certificate is attached to the Lightsail load balancer. Type: Boolean Required: No issuedAt The time when the SSL/TLS certificate was issued. Type: Timestamp Required: No issuer The issuer of the certificate. Type: String Pattern: .*\S.* Required: No keyAlgorithm The algorithm used to generate the key pair (the public and private key). Type: String Pattern: .*\S.* Required: No loadBalancerName The load balancer name where your SSL/TLS certificate is attached. Type: String Contents API Version 2016-11-28 938 API Reference Amazon Lightsail Pattern: \w[\w\-]*\w Required: No location The AWS Region and Availability Zone where you created your certificate. Type: ResourceLocation object Required: No name The name of the SSL/TLS certificate (my-certificate). Type: String Pattern: \w[\w\-]*\w Required: No notAfter The timestamp when the SSL/TLS certificate expires. Type: Timestamp Required: No notBefore The timestamp when the SSL/TLS certificate is first valid. Type: Timestamp Required: No renewalSummary An object that describes the status of the certificate renewal managed by Lightsail. Type: LoadBalancerTlsCertificateRenewalSummary object Required: No Contents API Version 2016-11-28 939 Amazon Lightsail resourceType API Reference The resource type (LoadBalancerTlsCertificate). • Instance - A Lightsail instance (a virtual private server) • StaticIp - A static IP address • KeyPair - The key pair used to connect to a Lightsail instance • InstanceSnapshot - A Lightsail instance snapshot • Domain - A DNS zone • PeeredVpc - A peered VPC • LoadBalancer - A Lightsail load balancer • LoadBalancerTlsCertificate - An SSL/TLS certificate associated with a Lightsail load balancer • Disk - A Lightsail block storage disk • DiskSnapshot - A block storage disk snapshot Type: String Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No revocationReason The reason the certificate was revoked. This value is present only when the |
amazon-lightsail-api-reference-180 | amazon-lightsail-api-reference.pdf | 180 | • PeeredVpc - A peered VPC • LoadBalancer - A Lightsail load balancer • LoadBalancerTlsCertificate - An SSL/TLS certificate associated with a Lightsail load balancer • Disk - A Lightsail block storage disk • DiskSnapshot - A block storage disk snapshot Type: String Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No revocationReason The reason the certificate was revoked. This value is present only when the certificate status is REVOKED. Type: String Valid Values: UNSPECIFIED | KEY_COMPROMISE | CA_COMPROMISE | AFFILIATION_CHANGED | SUPERCEDED | CESSATION_OF_OPERATION | CERTIFICATE_HOLD | REMOVE_FROM_CRL | PRIVILEGE_WITHDRAWN | A_A_COMPROMISE Contents API Version 2016-11-28 940 Amazon Lightsail Required: No revokedAt API Reference The timestamp when the certificate was revoked. This value is present only when the certificate status is REVOKED. Type: Timestamp Required: No serial The serial number of the certificate. Type: String Pattern: .*\S.* Required: No signatureAlgorithm The algorithm that was used to sign the certificate. Type: String Pattern: .*\S.* Required: No status The validation status of the SSL/TLS certificate. Valid values are below. Type: String Valid Values: PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED | UNKNOWN Required: No subject The name of the entity that is associated with the public key contained in the certificate. Type: String Contents API Version 2016-11-28 941 Amazon Lightsail Pattern: .*\S.* Required: No subjectAlternativeNames API Reference An array of strings that specify the alternate domains (example2.com) and subdomains (blog.example.com) for the certificate. Type: Array of strings Required: No supportCode The support code. Include this code in your email to support when you have questions about your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to look up your Lightsail information more easily. Type: String Required: No tags The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide. Type: Array of Tag objects Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 942 Amazon Lightsail API Reference LoadBalancerTlsCertificateDnsRecordCreationState An object that describes the state of the canonical name (CNAME) records that are automatically added by Lightsail to the DNS of the domain to validate domain ownership. Contents code The status code for the automated DNS record creation. Following are the possible values: • SUCCEEDED - The validation records were successfully added. • STARTED - The automatic DNS record creation has started. • FAILED - The validation record addition failed. Type: String Valid Values: SUCCEEDED | STARTED | FAILED Required: No message The message that describes the reason for the status code. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LoadBalancerTlsCertificateDnsRecordCreationState API Version 2016-11-28 943 Amazon Lightsail API Reference LoadBalancerTlsCertificateDomainValidationOption Contains information about the domain names on an SSL/TLS certificate that you will use to validate domain ownership. Contents domainName The fully qualified domain name in the certificate request. Type: String Required: No validationStatus The status of the domain validation. Valid values are listed below. Type: String Valid Values: PENDING_VALIDATION | FAILED | SUCCESS Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LoadBalancerTlsCertificateDomainValidationOption API Version 2016-11-28 944 Amazon Lightsail API Reference LoadBalancerTlsCertificateDomainValidationRecord Describes the validation record of each domain name in the SSL/TLS certificate. Contents dnsRecordCreationState An object that describes the state of the canonical name (CNAME) records that are automatically added by Lightsail to the DNS of a domain to validate domain ownership. Type: LoadBalancerTlsCertificateDnsRecordCreationState object Required: No domainName The domain name against which your SSL/TLS certificate was validated. Type: String Required: No name A fully qualified domain name in the certificate. For example, example.com. Type: String Pattern: .*\S.* Required: No type The type of validation record. For example, CNAME for domain validation. Type: String Pattern: .*\S.* Required: No validationStatus The validation status. Valid values are listed below. LoadBalancerTlsCertificateDomainValidationRecord API Version 2016-11-28 945 Amazon Lightsail Type: String API Reference Valid Values: PENDING_VALIDATION | FAILED | SUCCESS Required: No value The value for that type. Type: String Pattern: .*\S.* Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: |
amazon-lightsail-api-reference-181 | amazon-lightsail-api-reference.pdf | 181 | Type: String Required: No name A fully qualified domain name in the certificate. For example, example.com. Type: String Pattern: .*\S.* Required: No type The type of validation record. For example, CNAME for domain validation. Type: String Pattern: .*\S.* Required: No validationStatus The validation status. Valid values are listed below. LoadBalancerTlsCertificateDomainValidationRecord API Version 2016-11-28 945 Amazon Lightsail Type: String API Reference Valid Values: PENDING_VALIDATION | FAILED | SUCCESS Required: No value The value for that type. Type: String Pattern: .*\S.* Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 946 Amazon Lightsail API Reference LoadBalancerTlsCertificateRenewalSummary Contains information about the status of Lightsail's managed renewal for the certificate. The renewal status of the certificate. The following renewal status are possible: • PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names in the certificate. No further action is required. • PendingValidation - Lightsail couldn't automatically validate one or more domain names in the certificate. You must take action to validate these domain names or the certificate won't be renewed. If you used DNS validation, check to make sure your certificate's domain validation records exist in your domain's DNS, and that your certificate remains in use. • Success - All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required. • Failed - One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate action. Contents domainValidationOptions Contains information about the validation of each domain name in the certificate, as it pertains to Lightsail's managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request. Type: Array of LoadBalancerTlsCertificateDomainValidationOption objects Required: No renewalStatus The renewal status of the certificate. The following renewal status are possible: • PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names of the certificate. No further action is required. LoadBalancerTlsCertificateRenewalSummary API Version 2016-11-28 947 Amazon Lightsail API Reference • PendingValidation - Lightsail couldn't automatically validate one or more domain names of the certificate. You must take action to validate these domain names or the certificate won't be renewed. Check to make sure your certificate's domain validation records exist in your domain's DNS, and that your certificate remains in use. • Success - All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required. • Failed - One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate action. Type: String Valid Values: PENDING_AUTO_RENEWAL | PENDING_VALIDATION | SUCCESS | FAILED Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 948 Amazon Lightsail API Reference LoadBalancerTlsCertificateSummary Provides a summary of SSL/TLS certificate metadata. Contents isAttached When true, the SSL/TLS certificate is attached to the Lightsail load balancer. Type: Boolean Required: No name The name of the SSL/TLS certificate. Type: String Pattern: \w[\w\-]*\w Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LoadBalancerTlsCertificateSummary API Version 2016-11-28 949 Amazon Lightsail API Reference LoadBalancerTlsPolicy Describes the TLS security policies that are available for Lightsail load balancers. For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide. Contents ciphers The ciphers used by the TLS security policy. The ciphers are listed in order of preference. Type: Array of strings Required: No description The description of the TLS security policy. Type: String Required: No isDefault A Boolean value that indicates whether the TLS security policy is the default. Type: Boolean Required: No name The name of the TLS security policy. Type: String Pattern: \w[\w\-]*\w Required: No LoadBalancerTlsPolicy API Version 2016-11-28 950 Amazon Lightsail protocols The protocols used in a given TLS security policy. API Reference Type: Array of strings Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 951 API Reference Amazon Lightsail LogEvent Describes a database log event. Contents createdAt |
amazon-lightsail-api-reference-182 | amazon-lightsail-api-reference.pdf | 182 | is the default. Type: Boolean Required: No name The name of the TLS security policy. Type: String Pattern: \w[\w\-]*\w Required: No LoadBalancerTlsPolicy API Version 2016-11-28 950 Amazon Lightsail protocols The protocols used in a given TLS security policy. API Reference Type: Array of strings Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 951 API Reference Amazon Lightsail LogEvent Describes a database log event. Contents createdAt The timestamp when the database log event was created. Type: Timestamp Required: No message The message of the database log event. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LogEvent API Version 2016-11-28 952 Amazon Lightsail MetricDatapoint Describes the metric data point. API Reference Contents average The average. Type: Double Required: No maximum The maximum. Type: Double Required: No minimum The minimum. Type: Double Required: No sampleCount The sample count. Type: Double Required: No sum The sum. Type: Double Required: No MetricDatapoint API Version 2016-11-28 953 API Reference Amazon Lightsail timestamp The timestamp (1479816991.349). Type: Timestamp Required: No unit The unit. Type: String Valid Values: Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 954 Amazon Lightsail API Reference MonitoredResourceInfo Describes resource being monitored by an alarm. An alarm is a way to monitor your Amazon Lightsail resource metrics. For more information, see Alarms in Amazon Lightsail. Contents arn The Amazon Resource Name (ARN) of the resource being monitored. Type: String Pattern: ^arn:(aws[^:]*):([a-zA-Z0-9-]+):([a-z0-9-]+):([0-9]+):([a-zA-Z]+)/ ([a-zA-Z0-9-]+)$ Required: No name The name of the Lightsail resource being monitored. Type: String Pattern: \w[\w\-]*\w Required: No resourceType The Lightsail resource type of the resource being monitored. Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms. Type: String Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | MonitoredResourceInfo API Version 2016-11-28 955 Amazon Lightsail API Reference CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 956 Amazon Lightsail MonthlyTransfer API Reference Describes the monthly data transfer in and out of your virtual private server (or instance). Contents gbPerMonthAllocated The amount allocated per month (in GB). Type: Integer Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MonthlyTransfer API Version 2016-11-28 957 Amazon Lightsail API Reference NameServersUpdateState Describes the state of the name server records update made by Amazon Lightsail to an Amazon Route 53 registered domain. For more information, see DNS in Amazon Lightsail in the Amazon Lightsail Developer Guide. Contents code The status code for the name servers update. Following are the possible values: • SUCCEEDED - The name server records were successfully updated. • PENDING - The name server record update is in progress. • FAILED - The name server record update failed. • STARTED - The automatic name server record update started. Type: String Valid Values: SUCCEEDED | PENDING | FAILED | STARTED Required: No message The message that describes the reason for the status code. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 NameServersUpdateState API Version 2016-11-28 958 Amazon Lightsail • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 959 Amazon Lightsail Operation Describes the API operation. Contents createdAt The timestamp when the operation was initialized (1479816991.349). API Reference Type: Timestamp Required: No errorCode The error code. Type: String |
amazon-lightsail-api-reference-183 | amazon-lightsail-api-reference.pdf | 183 | FAILED | STARTED Required: No message The message that describes the reason for the status code. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 NameServersUpdateState API Version 2016-11-28 958 Amazon Lightsail • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 959 Amazon Lightsail Operation Describes the API operation. Contents createdAt The timestamp when the operation was initialized (1479816991.349). API Reference Type: Timestamp Required: No errorCode The error code. Type: String Required: No errorDetails The error details. Type: String Required: No id The ID of the operation. Type: String Pattern: .*\S.* Required: No isTerminal A Boolean value indicating whether the operation is terminal. Type: Boolean Operation API Version 2016-11-28 960 API Reference Amazon Lightsail Required: No location The AWS Region and Availability Zone. Type: ResourceLocation object Required: No operationDetails Details about the operation (Debian-1GB-Ohio-1). Type: String Required: No operationType The type of operation. Type: String Valid Values: DeleteKnownHostKeys | DeleteInstance | CreateInstance | StopInstance | StartInstance | RebootInstance | OpenInstancePublicPorts | PutInstancePublicPorts | CloseInstancePublicPorts | AllocateStaticIp | ReleaseStaticIp | AttachStaticIp | DetachStaticIp | UpdateDomainEntry | DeleteDomainEntry | CreateDomain | DeleteDomain | CreateInstanceSnapshot | DeleteInstanceSnapshot | CreateInstancesFromSnapshot | CreateLoadBalancer | DeleteLoadBalancer | AttachInstancesToLoadBalancer | DetachInstancesFromLoadBalancer | UpdateLoadBalancerAttribute | CreateLoadBalancerTlsCertificate | DeleteLoadBalancerTlsCertificate | AttachLoadBalancerTlsCertificate | CreateDisk | DeleteDisk | AttachDisk | DetachDisk | CreateDiskSnapshot | DeleteDiskSnapshot | CreateDiskFromSnapshot | CreateRelationalDatabase | UpdateRelationalDatabase | DeleteRelationalDatabase | CreateRelationalDatabaseFromSnapshot | CreateRelationalDatabaseSnapshot | DeleteRelationalDatabaseSnapshot | UpdateRelationalDatabaseParameters | StartRelationalDatabase | RebootRelationalDatabase | StopRelationalDatabase | EnableAddOn | DisableAddOn | PutAlarm | GetAlarms | DeleteAlarm | TestAlarm | CreateContactMethod | Contents API Version 2016-11-28 961 Amazon Lightsail API Reference GetContactMethods | SendContactMethodVerification | DeleteContactMethod | CreateDistribution | UpdateDistribution | DeleteDistribution | ResetDistributionCache | AttachCertificateToDistribution | DetachCertificateFromDistribution | UpdateDistributionBundle | SetIpAddressType | CreateCertificate | DeleteCertificate | CreateContainerService | UpdateContainerService | DeleteContainerService | CreateContainerServiceDeployment | CreateContainerServiceRegistryLogin | RegisterContainerImage | DeleteContainerImage | CreateBucket | DeleteBucket | CreateBucketAccessKey | DeleteBucketAccessKey | UpdateBucketBundle | UpdateBucket | SetResourceAccessForBucket | UpdateInstanceMetadataOptions | StartGUISession | StopGUISession | SetupInstanceHttps Required: No resourceName The resource name. Type: String Pattern: \w[\w\-]*\w Required: No resourceType The resource type. Type: String Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No status The status of the operation. Contents API Version 2016-11-28 962 Amazon Lightsail Type: String API Reference Valid Values: NotStarted | Started | Failed | Completed | Succeeded Required: No statusChangedAt The timestamp when the status was changed (1479816991.349). Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 963 Amazon Lightsail Origin API Reference Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution. An origin can be a Lightsail instance, bucket, or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide network of edge servers. Contents name The name of the origin resource. Type: String Pattern: \w[\w\-]*\w Required: No protocolPolicy The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content. Type: String Valid Values: http-only | https-only Required: No regionName The AWS Region name of the origin resource. 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: No Origin API Version 2016-11-28 964 Amazon Lightsail resourceType The resource type of the origin resource (Instance). Type: String API Reference Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No responseTimeout The amount of time, in seconds, that the distribution waits for a response after forwarding a request to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds. Type: Integer Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 965 Amazon Lightsail PasswordData API Reference The password data for the Windows Server-based instance, including |
amazon-lightsail-api-reference-184 | amazon-lightsail-api-reference.pdf | 184 | of time, in seconds, that the distribution waits for a response after forwarding a request to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds. Type: Integer Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 965 Amazon Lightsail PasswordData API Reference The password data for the Windows Server-based instance, including the ciphertext and the key pair name. Contents ciphertext The encrypted password. Ciphertext will be an empty string if access to your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready. Note If you use the default key pair (LightsailDefaultKeyPair), the decrypted password will be available in the password field. If you are using a custom key pair, you need to use your own means of decryption. If you change the Administrator password on the instance, Lightsail will continue to return the original ciphertext value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default. Type: String Required: No keyPairName The name of the key pair that you used when creating your instance. If no key pair name was specified when creating the instance, Lightsail uses the default key pair (LightsailDefaultKeyPair). If you are using a custom key pair, you need to use your own means of decrypting your password using the ciphertext. Lightsail creates the ciphertext by encrypting your password with the public key part of this key pair. Type: String Pattern: \w[\w\-]*\w PasswordData API Version 2016-11-28 966 Amazon Lightsail Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 967 Amazon Lightsail API Reference PendingMaintenanceAction Describes a pending database maintenance action. Contents action The type of pending database maintenance action. Type: String Pattern: .*\S.* Required: No currentApplyDate The effective date of the pending database maintenance action. Type: Timestamp Required: No description Additional detail about the pending database maintenance action. Type: String Pattern: .*\S.* Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PendingMaintenanceAction API Version 2016-11-28 968 Amazon Lightsail API Reference See Also API Version 2016-11-28 969 Amazon Lightsail API Reference PendingModifiedRelationalDatabaseValues Describes a pending database value modification. Contents backupRetentionEnabled A Boolean value indicating whether automated backup retention is enabled. Type: Boolean Required: No engineVersion The database engine version. Type: String Required: No masterUserPassword The password for the master user of the database. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PendingModifiedRelationalDatabaseValues API Version 2016-11-28 970 Amazon Lightsail PortInfo API Reference Describes ports to open on an instance, the IP addresses allowed to connect to the instance through the ports, and the protocol. Contents cidrListAliases An alias that defines access for a preconfigured range of IP addresses. The only alias currently supported is lightsail-connect, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance. Type: Array of strings Required: No cidrs The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Note The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance. Examples: • To allow the IP address 192.0.2.44, specify 192.0.2.44 or 192.0.2.44/32. • To allow the IP addresses 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24. For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia. Type: Array of strings Required: No PortInfo API Version 2016-11-28 971 Amazon Lightsail fromPort The first port in a range of open ports on an instance. Allowed ports: • TCP and UDP - 0 to 65535 API Reference • ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia. • ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more |
amazon-lightsail-api-reference-185 | amazon-lightsail-api-reference.pdf | 185 | Array of strings Required: No PortInfo API Version 2016-11-28 971 Amazon Lightsail fromPort The first port in a range of open ports on an instance. Allowed ports: • TCP and UDP - 0 to 65535 API Reference • ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia. • ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6. Type: Integer Valid Range: Minimum value of -1. Maximum value of 65535. Required: No ipv6Cidrs The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used. Note The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance. For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia. Type: Array of strings Required: No protocol The IP protocol name. Contents API Version 2016-11-28 972 Amazon Lightsail API Reference The name can be one of the following: • tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead. • all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia. • udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead. • icmp - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter. • icmp6 - Internet Control Message Protocol (ICMP) for IPv6. When you specify icmp6 as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter. Type: String Valid Values: tcp | all | udp | icmp | icmpv6 Required: No toPort The last port in a range of open ports on an instance. Allowed ports: • TCP and UDP - 0 to 65535 • ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia. Contents API Version 2016-11-28 973 Amazon Lightsail API Reference • ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6. Type: Integer Valid Range: Minimum value of -1. Maximum value of 65535. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 974 Amazon Lightsail API Reference PrivateRegistryAccess Describes the configuration for an Amazon Lightsail container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories. For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide. Contents ecrImagePullerRole An object that describes the activation status of the role that you can use to grant a Lightsail container service access to Amazon ECR private repositories. If the role is activated, the Amazon Resource Name (ARN) of the role is also listed. Type: ContainerServiceECRImagePullerRole object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PrivateRegistryAccess API Version 2016-11-28 975 Amazon Lightsail API Reference PrivateRegistryAccessRequest Describes a request to configure an Amazon Lightsail container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories. For more |
amazon-lightsail-api-reference-186 | amazon-lightsail-api-reference.pdf | 186 | to Amazon ECR private repositories. If the role is activated, the Amazon Resource Name (ARN) of the role is also listed. Type: ContainerServiceECRImagePullerRole object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PrivateRegistryAccess API Version 2016-11-28 975 Amazon Lightsail API Reference PrivateRegistryAccessRequest Describes a request to configure an Amazon Lightsail container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories. For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide. Contents ecrImagePullerRole An object to describe a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories. Type: ContainerServiceECRImagePullerRoleRequest object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PrivateRegistryAccessRequest API Version 2016-11-28 976 Amazon Lightsail QueryStringObject API Reference Describes the query string parameters that an Amazon Lightsail content delivery network (CDN) distribution to bases caching on. For the query strings that you specify, your distribution caches separate versions of the specified content based on the query string values in viewer requests. Contents option Indicates whether the distribution forwards and caches based on query strings. Type: Boolean Required: No queryStringsAllowList The specific query strings that the distribution forwards to the origin. Your distribution will cache content based on the specified query strings. If the option parameter is true, then your distribution forwards all query strings, regardless of what you specify using the queryStringsAllowList parameter. Type: Array of strings Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 QueryStringObject API Version 2016-11-28 977 Amazon Lightsail API Reference R53HostedZoneDeletionState Describes the deletion state of an Amazon Route 53 hosted zone for a domain that is being automatically delegated to an Amazon Lightsail DNS zone. Contents code The status code for the deletion state. Following are the possible values: • SUCCEEDED - The hosted zone was successfully deleted. • PENDING - The hosted zone deletion is in progress. • FAILED - The hosted zone deletion failed. • STARTED - The hosted zone deletion started. Type: String Valid Values: SUCCEEDED | PENDING | FAILED | STARTED Required: No message The message that describes the reason for the status code. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 R53HostedZoneDeletionState API Version 2016-11-28 978 Amazon Lightsail API Reference See Also API Version 2016-11-28 979 Amazon Lightsail Region Describes the AWS Region. Contents availabilityZones API Reference The Availability Zones. Follows the format us-east-2a (case-sensitive). Type: Array of AvailabilityZone objects Required: No continentCode The continent code (NA, meaning North America). Type: String Required: No description The description of the AWS Region (This region is recommended to serve users in the eastern United States and eastern Canada). Type: String Required: No displayName The display name (Ohio). Type: String Required: No name The region name (us-east-2). Type: String Region API Version 2016-11-28 980 Amazon Lightsail API Reference 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: No relationalDatabaseAvailabilityZones The Availability Zones for databases. Follows the format us-east-2a (case-sensitive). Type: Array of AvailabilityZone objects Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 981 Amazon Lightsail API Reference RegisteredDomainDelegationInfo Describes the delegation state of an Amazon Route 53 registered domain to Amazon Lightsail. When you delegate an Amazon Route 53 registered domain to Lightsail, you can manage the DNS of the domain using a Lightsail DNS zone. You no longer use the Route 53 hosted zone to manage the DNS of the domain. To delegate the domain, Lightsail automatically updates the domain's name servers in Route 53 to the name servers of the Lightsail DNS zone. Then, Lightsail automatically deletes the Route 53 hosted zone for the domain. All of the following |
amazon-lightsail-api-reference-187 | amazon-lightsail-api-reference.pdf | 187 | 2016-11-28 981 Amazon Lightsail API Reference RegisteredDomainDelegationInfo Describes the delegation state of an Amazon Route 53 registered domain to Amazon Lightsail. When you delegate an Amazon Route 53 registered domain to Lightsail, you can manage the DNS of the domain using a Lightsail DNS zone. You no longer use the Route 53 hosted zone to manage the DNS of the domain. To delegate the domain, Lightsail automatically updates the domain's name servers in Route 53 to the name servers of the Lightsail DNS zone. Then, Lightsail automatically deletes the Route 53 hosted zone for the domain. All of the following conditions must be true for automatic domain delegation to be successful: • The registered domain must be in the same AWS account as the Lightsail account making the request. • The user or entity making the request must have permission to manage domains in Route 53. • The Route 53 hosted zone for the domain must be empty. It cannot contain DNS records other than start of authority (SOA) and name server records. If automatic domain delegation fails, or if you manage the DNS of your domain using a service other than Route 53, then you must manually add the Lightsail DNS zone name servers to your domain in order to delegate management of its DNS to Lightsail. For more information, see Creating a DNS zone to manage your domain’s records in Amazon Lightsail in the Amazon Lightsail Developer Guide. Contents nameServersUpdateState An object that describes the state of the name server records that are automatically added to the Route 53 domain by Lightsail. Type: NameServersUpdateState object Required: No r53HostedZoneDeletionState Describes the deletion state of an Amazon Route 53 hosted zone for a domain that is being automatically delegated to an Amazon Lightsail DNS zone. RegisteredDomainDelegationInfo API Version 2016-11-28 982 Amazon Lightsail API Reference Type: R53HostedZoneDeletionState object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 983 API Reference Amazon Lightsail RelationalDatabase Describes a database. Contents arn The Amazon Resource Name (ARN) of the database. Type: String Pattern: .*\S.* Required: No backupRetentionEnabled A Boolean value indicating whether automated backup retention is enabled for the database. Type: Boolean Required: No caCertificateIdentifier The certificate associated with the database. Type: String Required: No createdAt The timestamp when the database was created. Formatted in Unix time. Type: Timestamp Required: No engine The database software (for example, MySQL). Type: String RelationalDatabase API Version 2016-11-28 984 API Reference Amazon Lightsail Pattern: .*\S.* Required: No engineVersion The database engine version (for example, 5.7.23). Type: String Pattern: .*\S.* Required: No hardware Describes the hardware of the database. Type: RelationalDatabaseHardware object Required: No latestRestorableTime The latest point in time to which the database can be restored. Formatted in Unix time. Type: Timestamp Required: No location The Region name and Availability Zone where the database is located. Type: ResourceLocation object Required: No masterDatabaseName The name of the master database created when the Lightsail database resource is created. Type: String Required: No Contents API Version 2016-11-28 985 Amazon Lightsail masterEndpoint The master endpoint for the database. Type: RelationalDatabaseEndpoint object Required: No masterUsername The master user name of the database. Type: String Pattern: .*\S.* Required: No name The unique name of the database resource in Lightsail. Type: String Pattern: \w[\w\-]*\w Required: No parameterApplyStatus The status of parameter updates for the database. Type: String Pattern: .*\S.* Required: No pendingMaintenanceActions Describes the pending maintenance actions for the database. Type: Array of PendingMaintenanceAction objects Required: No Contents API Reference API Version 2016-11-28 986 Amazon Lightsail pendingModifiedValues Describes pending database value modifications. Type: PendingModifiedRelationalDatabaseValues object Required: No preferredBackupWindow API Reference The daily time range during which automated backups are created for the database (for example, 16:00-16:30). Type: String Pattern: .*\S.* Required: No preferredMaintenanceWindow The weekly time range during which system maintenance can occur on the database. In the format ddd:hh24:mi-ddd:hh24:mi. For example, Tue:17:00-Tue:17:30. Type: String Pattern: .*\S.* Required: No publiclyAccessible A Boolean value indicating whether the database is publicly accessible. Type: Boolean Required: No relationalDatabaseBlueprintId The blueprint ID for the database. A blueprint describes the major engine version of a database. Type: String Pattern: .*\S.* Contents API Version 2016-11-28 987 Amazon Lightsail Required: No relationalDatabaseBundleId API Reference The bundle ID for the database. A bundle describes the performance specifications for your database. Type: String Pattern: .*\S.* Required: No resourceType The Lightsail resource type for the database (for example, RelationalDatabase). Type: String Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket |
amazon-lightsail-api-reference-188 | amazon-lightsail-api-reference.pdf | 188 | blueprint describes the major engine version of a database. Type: String Pattern: .*\S.* Contents API Version 2016-11-28 987 Amazon Lightsail Required: No relationalDatabaseBundleId API Reference The bundle ID for the database. A bundle describes the performance specifications for your database. Type: String Pattern: .*\S.* Required: No resourceType The Lightsail resource type for the database (for example, RelationalDatabase). Type: String Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No secondaryAvailabilityZone Describes the secondary Availability Zone of a high availability database. The secondary database is used for failover support of a high availability database. Type: String Required: No state Describes the current state of the database. Type: String Pattern: .*\S.* Contents API Version 2016-11-28 988 Amazon Lightsail Required: No supportCode API Reference The support code for the database. Include this code in your email to support when you have questions about a database in Lightsail. This code enables our support team to look up your Lightsail information more easily. Type: String Required: No tags The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide. Type: Array of Tag objects Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 989 Amazon Lightsail API Reference RelationalDatabaseBlueprint Describes a database image, or blueprint. A blueprint describes the major engine version of a database. Contents blueprintId The ID for the database blueprint. Type: String Required: No engine The database software of the database blueprint (for example, MySQL). Type: String Valid Values: mysql Required: No engineDescription The description of the database engine for the database blueprint. Type: String Required: No engineVersion The database engine version for the database blueprint (for example, 5.7.23). Type: String Required: No engineVersionDescription The description of the database engine version for the database blueprint. Type: String RelationalDatabaseBlueprint API Version 2016-11-28 990 Amazon Lightsail Required: No isEngineDefault API Reference A Boolean value indicating whether the engine version is the default for the database blueprint. Type: Boolean Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 991 Amazon Lightsail API Reference RelationalDatabaseBundle Describes a database bundle. A bundle describes the performance specifications of the database. Contents bundleId The ID for the database bundle. Type: String Required: No cpuCount The number of virtual CPUs (vCPUs) for the database bundle. Type: Integer Required: No diskSizeInGb The size of the disk for the database bundle. Type: Integer Required: No isActive A Boolean value indicating whether the database bundle is active. Type: Boolean Required: No isEncrypted A Boolean value indicating whether the database bundle is encrypted. Type: Boolean Required: No RelationalDatabaseBundle API Version 2016-11-28 992 API Reference Amazon Lightsail name The name for the database bundle. Type: String Required: No price The cost of the database bundle in US currency. Type: Float Required: No ramSizeInGb The amount of RAM in GB (for example, 2.0) for the database bundle. Type: Float Required: No transferPerMonthInGb The data transfer rate per month in GB for the database bundle. Type: Integer Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 993 Amazon Lightsail API Reference RelationalDatabaseEndpoint Describes an endpoint for a database. Contents address Specifies the DNS address of the database. Type: String Pattern: .*\S.* Required: No port Specifies the port that the database is listening on. Type: Integer Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RelationalDatabaseEndpoint API Version 2016-11-28 994 Amazon Lightsail API Reference RelationalDatabaseEvent Describes an event for a database. Contents createdAt The timestamp when the database event was created. Type: Timestamp Required: No eventCategories The category that the database event belongs to. Type: Array of strings Required: No message The message of the database event. Type: String Required: No resource The database that the database event relates to. Type: String Pattern: \w[\w\-]*\w Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see |
amazon-lightsail-api-reference-189 | amazon-lightsail-api-reference.pdf | 189 | • AWS SDK for Java V2 • AWS SDK for Ruby V3 RelationalDatabaseEndpoint API Version 2016-11-28 994 Amazon Lightsail API Reference RelationalDatabaseEvent Describes an event for a database. Contents createdAt The timestamp when the database event was created. Type: Timestamp Required: No eventCategories The category that the database event belongs to. Type: Array of strings Required: No message The message of the database event. Type: String Required: No resource The database that the database event relates to. Type: String Pattern: \w[\w\-]*\w Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: RelationalDatabaseEvent API Version 2016-11-28 995 Amazon Lightsail • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 996 Amazon Lightsail API Reference RelationalDatabaseHardware Describes the hardware of a database. Contents cpuCount The number of vCPUs for the database. Type: Integer Required: No diskSizeInGb The size of the disk for the database. Type: Integer Required: No ramSizeInGb The amount of RAM in GB for the database. Type: Float Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RelationalDatabaseHardware API Version 2016-11-28 997 Amazon Lightsail API Reference RelationalDatabaseParameter Describes the parameters of a database. Contents allowedValues Specifies the valid range of values for the parameter. Type: String Required: No applyMethod Indicates when parameter updates are applied. Can be immediate or pending-reboot. Type: String Required: No applyType Specifies the engine-specific parameter type. Type: String Required: No dataType Specifies the valid data type for the parameter. Type: String Required: No description Provides a description of the parameter. Type: String RelationalDatabaseParameter API Version 2016-11-28 998 Amazon Lightsail Required: No isModifiable A Boolean value indicating whether the parameter can be modified. API Reference Type: Boolean Required: No parameterName Specifies the name of the parameter. Type: String Required: No parameterValue Specifies the value of the parameter. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 999 Amazon Lightsail API Reference RelationalDatabaseSnapshot Describes a database snapshot. Contents arn The Amazon Resource Name (ARN) of the database snapshot. Type: String Pattern: .*\S.* Required: No createdAt The timestamp when the database snapshot was created. Type: Timestamp Required: No engine The software of the database snapshot (for example, MySQL) Type: String Pattern: .*\S.* Required: No engineVersion The database engine version for the database snapshot (for example, 5.7.23). Type: String Pattern: .*\S.* Required: No RelationalDatabaseSnapshot API Version 2016-11-28 1000 Amazon Lightsail fromRelationalDatabaseArn API Reference The Amazon Resource Name (ARN) of the database from which the database snapshot was created. Type: String Pattern: .*\S.* Required: No fromRelationalDatabaseBlueprintId The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database. Type: String Required: No fromRelationalDatabaseBundleId The bundle ID of the database from which the database snapshot was created. Type: String Required: No fromRelationalDatabaseName The name of the source database from which the database snapshot was created. Type: String Pattern: .*\S.* Required: No location The Region name and Availability Zone where the database snapshot is located. Type: ResourceLocation object Required: No name The name of the database snapshot. Contents API Version 2016-11-28 1001 API Reference Amazon Lightsail Type: String Pattern: \w[\w\-]*\w Required: No resourceType The Lightsail resource type. Type: String Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No sizeInGb The size of the disk in GB (for example, 32) for the database snapshot. Type: Integer Required: No state The state of the database snapshot. Type: String Pattern: .*\S.* Required: No supportCode The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily. Contents API Version 2016-11-28 1002 Amazon Lightsail Type: String Required: No tags API Reference The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide. Type: Array of Tag objects Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby |
amazon-lightsail-api-reference-190 | amazon-lightsail-api-reference.pdf | 190 | have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily. Contents API Version 2016-11-28 1002 Amazon Lightsail Type: String Required: No tags API Reference The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide. Type: Array of Tag objects Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 1003 Amazon Lightsail RenewalSummary API Reference Describes the status of a SSL/TLS certificate renewal managed by Amazon Lightsail. Contents domainValidationRecords An array of objects that describe the domain validation records of the certificate. Type: Array of DomainValidationRecord objects Required: No renewalStatus The renewal status of the certificate. The following renewal status are possible: • PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names of the certificate. No further action is required. • PendingValidation - Lightsail couldn't automatically validate one or more domain names of the certificate. You must take action to validate these domain names or the certificate won't be renewed. Check to make sure your certificate's domain validation records exist in your domain's DNS, and that your certificate remains in use. • Success - All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required. • Failed - One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate action. Type: String Valid Values: PendingAutoRenewal | PendingValidation | Success | Failed Required: No renewalStatusReason The reason for the renewal status of the certificate. RenewalSummary API Version 2016-11-28 1004 API Reference Amazon Lightsail Type: String Required: No updatedAt The timestamp when the certificate was last updated. Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 1005 Amazon Lightsail API Reference ResourceBudgetEstimate Describes the estimated cost or usage that a budget tracks. Contents costEstimates The cost estimate for the specified budget. Type: Array of CostEstimate objects Required: No endTime The estimate end time. Type: Timestamp Required: No resourceName The resource name. Type: String Pattern: \w[\w\-]*\w Required: No resourceType The type of resource the budget will track. Type: String Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket ResourceBudgetEstimate API Version 2016-11-28 1006 API Reference Amazon Lightsail Required: No startTime The estimate start time. Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 1007 Amazon Lightsail ResourceLocation Describes the resource location. Contents availabilityZone API Reference The Availability Zone. Follows the format us-east-2a (case-sensitive). Type: String Required: No regionName The AWS Region name. 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: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ResourceLocation API Version 2016-11-28 1008 Amazon Lightsail API Reference ResourceReceivingAccess Describes an Amazon Lightsail instance that has access to a Lightsail bucket. Contents name The name of the Lightsail instance. Type: String Pattern: .*\S.* Required: No resourceType The Lightsail resource type (for example, Instance). Type: String Pattern: .*\S.* Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ResourceReceivingAccess API Version 2016-11-28 1009 Amazon Lightsail ResourceRecord API Reference Describes the domain name system (DNS) records to add to your domain's DNS to validate it for an Amazon Lightsail certificate. Contents name The name of the record. Type: String Required: No type The DNS record type. Type: String Required: No value The value for the DNS record. Type: String Required: No See Also For more information about using this API in one of the |
amazon-lightsail-api-reference-191 | amazon-lightsail-api-reference.pdf | 191 | of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ResourceReceivingAccess API Version 2016-11-28 1009 Amazon Lightsail ResourceRecord API Reference Describes the domain name system (DNS) records to add to your domain's DNS to validate it for an Amazon Lightsail certificate. Contents name The name of the record. Type: String Required: No type The DNS record type. Type: String Required: No value The value for the DNS record. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ResourceRecord API Version 2016-11-28 1010 Amazon Lightsail Session API Reference Describes a web-based, remote graphical user interface (GUI), Amazon DCV session. The session is used to access a virtual computer’s operating system or application. Contents isPrimary When true, this Boolean value indicates the primary session for the specified resource. Type: Boolean Required: No name The session name. Type: String Pattern: .*\S.* Required: No url The session URL. Type: String Pattern: .*\S.* Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 Session API Version 2016-11-28 1011 Amazon Lightsail • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 1012 Amazon Lightsail API Reference SetupExecutionDetails Returns details about the commands that were run. Contents command The command that was executed. Type: String Required: No dateTime The timestamp for when the request was run. Type: Timestamp Required: No name The name of the target resource. Type: String Pattern: .*\S.* Required: No standardError The text written by the command to stderr. Type: String Required: No standardOutput The text written by the command to stdout. Type: String SetupExecutionDetails API Version 2016-11-28 1013 API Reference Amazon Lightsail Required: No status The status of the SetupInstanceHttps request. Type: String Valid Values: succeeded | failed | inProgress Required: No version The current version of the script.. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 1014 Amazon Lightsail SetupHistory API Reference Returns a list of the commands that were ran on the target resource. The status of each command is also returned. Contents executionDetails Describes the full details of the request. Type: Array of SetupExecutionDetails objects Required: No operationId A GUID that's used to identify the operation. Type: String Pattern: .*\S.* Required: No request Information about the specified request. Type: SetupRequest object Required: No resource The target resource name for the request. Type: SetupHistoryResource object Required: No status The status of the request. SetupHistory API Version 2016-11-28 1015 Amazon Lightsail Type: String Valid Values: succeeded | failed | inProgress API Reference Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 1016 Amazon Lightsail API Reference SetupHistoryResource The Lightsail resource that SetupHistory was ran on. Contents arn The Amazon Resource Name (ARN) of the Lightsail resource. Type: String Pattern: .*\S.* Required: No createdAt The timestamp for when the resource was created. Type: Timestamp Required: No location Describes the resource location. Type: ResourceLocation object Required: No name The name of the Lightsail resource. Type: String Pattern: \w[\w\-]*\w Required: No resourceType The Lightsail resource type. For example, Instance. SetupHistoryResource API Version 2016-11-28 1017 Amazon Lightsail Type: String API Reference Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 1018 Amazon Lightsail SetupRequest API Reference Returns information that was submitted during the SetupInstanceHttps request. Email information is redacted for privacy. Contents certificateProvider The Certificate Authority (CA) that issues the SSL/TLS certificate. Type: String Valid Values: LetsEncrypt Required: No domainNames The name of the domain and subdomains that the SSL/TLS certificate secures. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 4. Maximum length of 253. Pattern: |
amazon-lightsail-api-reference-192 | amazon-lightsail-api-reference.pdf | 192 | AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 1018 Amazon Lightsail SetupRequest API Reference Returns information that was submitted during the SetupInstanceHttps request. Email information is redacted for privacy. Contents certificateProvider The Certificate Authority (CA) that issues the SSL/TLS certificate. Type: String Valid Values: LetsEncrypt Required: No domainNames The name of the domain and subdomains that the SSL/TLS certificate secures. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 4. Maximum length of 253. Pattern: ^[a-zA-Z0-9\-]{1,63}(\.[a-zA-Z0-9\-]{1,63}){0,8}(\.[a-zA-Z] {2,63})$ Required: No instanceName The name of the Lightsail instance. Type: String Pattern: \w[\w\-]*\w Required: No SetupRequest API Version 2016-11-28 1019 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 1020 Amazon Lightsail StaticIp Describes a static IP. Contents arn API Reference The Amazon Resource Name (ARN) of the static IP (arn:aws:lightsail:us- east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE). Type: String Pattern: .*\S.* Required: No attachedTo The instance where the static IP is attached (Amazon_Linux-1GB-Ohio-1). Type: String Pattern: \w[\w\-]*\w Required: No createdAt The timestamp when the static IP was created (1479735304.222). Type: Timestamp Required: No ipAddress The static IP address. Type: String Pattern: ([0-9]{1,3}\.){3}[0-9]{1,3} Required: No StaticIp API Version 2016-11-28 1021 Amazon Lightsail isAttached A Boolean value indicating whether the static IP is attached. API Reference Type: Boolean Required: No location The region and Availability Zone where the static IP was created. Type: ResourceLocation object Required: No name The name of the static IP (StaticIP-Ohio-EXAMPLE). Type: String Pattern: \w[\w\-]*\w Required: No resourceType The resource type (usually StaticIp). Type: String Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket Required: No supportCode The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily. Contents API Version 2016-11-28 1022 Amazon Lightsail Type: String Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-11-28 1023 Amazon Lightsail API Reference StopInstanceOnIdleRequest Describes a request to create or edit the StopInstanceOnIdle add-on. Important This add-on only applies to Lightsail for Research resources. Contents duration The amount of idle time in minutes after which your virtual computer will automatically stop. Type: String Required: No threshold The value to compare with the duration. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 StopInstanceOnIdleRequest API Version 2016-11-28 1024 Amazon Lightsail Tag API Reference Describes a tag key and optional value assigned to an Amazon Lightsail resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide. Contents key The key of the tag. Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @ Type: String Required: No value The value of the tag. Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @ Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Tag API Version 2016-11-28 1025 Amazon Lightsail TimePeriod API Reference Sets the start date and end date for retrieving a cost estimate. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. Contents end The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Lightsail for Research retrieves cost and usage data from the start date up to, but not including, 2017-05-01. Type: Timestamp Required: No start The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Lightsail for Research retrieves cost and |
amazon-lightsail-api-reference-193 | amazon-lightsail-api-reference.pdf | 193 | but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. Contents end The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Lightsail for Research retrieves cost and usage data from the start date up to, but not including, 2017-05-01. Type: Timestamp Required: No start The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Lightsail for Research retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error. Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TimePeriod API Version 2016-11-28 1026 Amazon Lightsail API Reference Amazon Lightsail for Research actions You can use the following API actions, which are part of the Lightsail API, to manage Amazon Lightsail for Research resources. Choose the name of the action to view more information about that action. For more information about Lightsail for Research, see the Amazon Lightsail for Research User Guide. Lightsail for Research actions • AddOnRequest - Describes a request to enable, modify, or disable an add-on for an Amazon Lightsail or Lightsail for Research resource. Valid values are AutoSnapshot | StopInstanceOnIdle. • CreateGUISessionAccessDetails - Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. • GetCostEstimate - Retrieves information about the cost estimate for a specified resource. • StartGUISession - Initiates a Amazon DCV GUI session that’s used to access a virtual computer’s operating system or application. The session will be active for 1 hour. Use this action to resume the session after it expires. • StopGUISession - Terminates a web-based Amazon DCV GUI session that’s used to access a virtual computer’s operating system or application. The session will close and any unsaved data will be lost. Virtual computer and instance actions • CreateInstances - Creates one or more virtual computers. • DeleteInstance - Deletes a virtual computer. • GetBlueprints - Returns the list of available virtual computer applications, or blueprints. • GetBundles - Returns the hardware bundles that you can apply to a virtual computer when you create it. • GetInstance - Returns information about a specific virtual computer or instance. • GetInstanceMetricData - Returns the data points for the specified virtual computer metric, given an virtual computer name. • GetInstances - Returns information about all Lightsail instances and Lightsail for Research virtual computers in the user's account. API Version 2016-11-28 1027 Amazon Lightsail API Reference • GetInstanceState - Returns the state of a specific virtual computer or instance. • RebootInstance - Restarts a specific virtual computer. • StartInstance - Starts a specific virtual computer from a stopped state. To restart a virtual computer, use the reboot instance operation. • StopInstance - Stops a specific virtual computer that is currently running. • UpdateInstanceMetadataOptions - Modifies the virtual computer metadata parameters on a running or stopped virtual computer. Disk actions • AttachDisk - Attaches a block storage disk to a running or stopped virtual computer, and exposes it to the virtual computer with the specified disk name. • CreateDisk - Creates a block storage disk that can be attached to a virtual computer in the same AWS Region. • DeleteDisk - Deletes the specified block storage disk. • DetachDisk - Detaches a stopped block storage disk from a virtual computer. • GetDisk - Returns information about a specific block storage disk. • GetDisks - Returns information about all block storage disks in your AWS account and region. Key pair actions • CreateKeyPair - Creates a custom SSH key pair that you can use with a Lightsail for Research virtual computer. • DeleteKeyPair - Deletes the specified key pair by removing the public key from Amazon Lightsail. • DownloadDefaultKeyPair - Downloads the regional Lightsail default key pair. This action also creates a Lightsail default key pair if a default key pair does not currently exist in the AWS Region. • GetInstanceAccessDetails - Returns temporary SSH keys you can use to connect to a specific virtual computer. • GetKeyPair - Returns information about a specific key pair. • GetKeyPairs - Returns information about all key pairs in the user's account. • ImportKeyPair - Imports the public SSH key from a specific key pair. API Version 2016-11-28 1028 Amazon Lightsail Networking actions API Reference • GetInstancePortStates - Returns the firewall port states for a specific virtual computer, the IP addresses allowed to connect to |
amazon-lightsail-api-reference-194 | amazon-lightsail-api-reference.pdf | 194 | Lightsail default key pair if a default key pair does not currently exist in the AWS Region. • GetInstanceAccessDetails - Returns temporary SSH keys you can use to connect to a specific virtual computer. • GetKeyPair - Returns information about a specific key pair. • GetKeyPairs - Returns information about all key pairs in the user's account. • ImportKeyPair - Imports the public SSH key from a specific key pair. API Version 2016-11-28 1028 Amazon Lightsail Networking actions API Reference • GetInstancePortStates - Returns the firewall port states for a specific virtual computer, the IP addresses allowed to connect to the virtual computer through the ports, and the protocol. • IsVpcPeered - Returns a Boolean value indicating whether your Lightsail VPC is peered. • OpenInstancePublicPorts - Opens ports for a specific virtual computer, and specifies the IP addresses allowed to connect to the virtual computer through the ports, and the protocol. • PutInstancePublicPorts - Opens ports for a specific virtual computer, and specifies the IP addresses allowed to connect to the virtual computer through the ports, and the protocol. • PeerVpc - Peers the Lightsail VPC with the user's default VPC. • SetIpAddressType - Sets the IP address type for a virtual computer. • UnpeerVpc - Unpeers the Lightsail VPC from the user's default VPC. Snapshot actions • CopySnapshot - Copies a manual snapshot of an virtual computer or disk as another manual snapshot, or copies an automatic snapshot of an virtual computer or disk as a manual snapshot. • CreateDiskFromSnapshot - Creates a block storage disk from a manual or automatic snapshot of a disk. • CreateDiskSnapshot - Creates a snapshot of a block storage disk. • CreateInstancesFromSnapshot - Creates one or more new virtual computers from a manual or automatic snapshot of a virtual computer. • CreateInstanceSnapshot - Creates a snapshot of a specific virtual computer. • DeleteAutoSnapshot - Deletes an automatic snapshot of a virtual computer or disk. • DeleteDiskSnapshot - Deletes a specific snapshot of a disk. • DeleteInstanceSnapshot - Deletes a specific snapshot of a virtual computer. • ExportSnapshot - Exports a virtual computer or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). • GetDiskSnapshot - Returns information about a specific block storage disk snapshot. • GetDiskSnapshots - Returns information about all block storage disk snapshots in your AWS account and region. • GetExportSnapshotRecords - Returns all export snapshot records created as a result of the export snapshot operation. API Version 2016-11-28 1029 Amazon Lightsail API Reference • GetInstanceSnapshot - Returns information about a specific virtual computer snapshot. • GetInstanceSnapshots - Returns all virtual computer snapshots for the user's account. Tag actions • TagResource - Adds one or more tags to the specified resource. • UntagResource - Deletes the specified set of tag keys and their values from the specified resource. Additional resource actions • GetActiveNames - Returns the names of all active (not deleted) resources. • GetOperation - Returns information about a specific operation. Operations include events such as when you create a virtual computer, attach a disk, and so on. • GetOperations - Returns information about all operations. Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to GetOperations use the maximum (last) statusChangedAt value from the previous request. • GetOperationsForResource - Gets operations for a specific resource, such as a virtual computer or a disk. • GetRegions - Returns a list of all valid AWS Regions for Lightsail. Use the include availability zones parameter to also return the Availability Zones in a region. API Version 2016-11-28 1030 Amazon Lightsail API Reference Object storage actions Use the following API actions for Amazon Simple Storage Service (Amazon S3) to manage buckets and objects in the Amazon Lightsail object storage service. Choose the name of an API action to view the documentation for it in the Amazon S3 API reference. For more information about buckets in Lightsail, see Object storage in Amazon Lightsail. Uploading files to buckets • PutObject - Adds a file to a bucket. For more information, see Uploading files to a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide. Uploading objects to buckets using multipart upload • CreateMultipartUpload - Initiates a multipart upload and returns an upload ID. For more information, see Initiate a multipart upload in the Amazon Lightsail Developer Guide. • UploadPart - Uploads a part in a specific multipart upload. For more information, see Upload a part in the Amazon Lightsail Developer Guide. • ListParts - Lists the parts that have been uploaded for a specific multipart upload. For more information, see List parts of a multipart upload in the Amazon Lightsail Developer Guide. • CompleteMultipartUpload - Completes a multipart upload by assembling previously uploaded parts. For more information, see Complete |
amazon-lightsail-api-reference-195 | amazon-lightsail-api-reference.pdf | 195 | multipart upload • CreateMultipartUpload - Initiates a multipart upload and returns an upload ID. For more information, see Initiate a multipart upload in the Amazon Lightsail Developer Guide. • UploadPart - Uploads a part in a specific multipart upload. For more information, see Upload a part in the Amazon Lightsail Developer Guide. • ListParts - Lists the parts that have been uploaded for a specific multipart upload. For more information, see List parts of a multipart upload in the Amazon Lightsail Developer Guide. • CompleteMultipartUpload - Completes a multipart upload by assembling previously uploaded parts. For more information, see Complete a multipart upload in the Amazon Lightsail Developer Guide. • ListMultipartUploads - Lists all in-progress multipart uploads for a bucket. For more information, see List multipart uploads for a bucket in the Amazon Lightsail Developer Guide. • AbortMultipartUpload - Stops a multipart upload. For more information, see Stop a multipart upload in the Amazon Lightsail Developer Guide. Listing objects and object details • ListObjectsV2 - Returns a list of the objects (up to 1,000 in each request) in a bucket. For more information, see Viewing objects in a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide. API Version 2016-11-28 1031 Amazon Lightsail API Reference • HeadObject - Returns metadata from an object without returning the object itself. This action is useful if you're only interested in an object's metadata. For more information, see Viewing objects in a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide. • GetObject - Downloads an object from a bucket. For more information, see Downloading objects from a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide. • GetObjectTagging - Returns the tags of an object. For more information, see Tagging objects in a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide. • ListObjectVersions - Returns metadata about all versions of objects in a bucket. For more information, see Enabling and suspending object versioning in a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide. Copying and moving objects • CopyObject - Creates a copy of an object. For more information, see Copying or moving objects in a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide. Editing individual object permissions • GetObjectAcl - Sets the access control list (ACL) permissions for an object, which is how you can control the access permissions for an individual object. For more information, see Configuring access permissions for individual objects in a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide. • GetObjectAcl - Returns the access control list (ACL) set for an object, which controls the access permissions for the individual object. For more information, see Configuring access permissions for individual objects in a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide. Editing object tags • PutObjectTagging - Sets the supplied tag to an object. For more information, see Tagging objects in a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide. Listing and restoring object versions • ListObjectVersions - Returns metadata about all versions of objects in a bucket. For more information, see Enabling and suspending object versioning in a bucket in Amazon Lightsail and API Version 2016-11-28 1032 Amazon Lightsail API Reference Restoring previous versions of objects in a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide. • CopyObject - Creates a copy of an object in a bucket, including previous versions of an object. To restore an object version, use the CopyObject action to copy a previous version of an object and make it the latest version. For more information, see Restoring previous versions of objects in a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide. • DeleteObject - Deletes an object from a bucket, including previous versions of an object. For more information, see Delete multiple objects or object versions using the AWS CLI in the Amazon Lightsail Developer Guide. Deleting objects • DeleteObject - Deletes an object from a bucket. For more information, see Deleting objects in a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide. • DeleteObjects - Deletes multiple objects from a bucket using a single request. For more information, see Deleting objects in a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide. API Version 2016-11-28 1033 Amazon Lightsail 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-specific 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 |
amazon-lightsail-api-reference-196 | amazon-lightsail-api-reference.pdf | 196 | objects in a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide. API Version 2016-11-28 1033 Amazon Lightsail 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-specific 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 2016-11-28 1034 Amazon Lightsail 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 specified 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 Specifies 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 2016-11-28 1035 Amazon Lightsail Type: string Required: Conditional X-Amz-SignedHeaders API Reference Specifies 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 2016-11-28 1036 Amazon Lightsail API Reference Common Errors This section lists the errors common to the API actions of all AWS services. For errors specific to an API action for this service, see the topic for that API action. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 400 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 400 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 InvalidAction The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 400 InvalidClientTokenId The X.509 certificate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 400 OptInRequired The AWS access key ID needs a subscription for the service. HTTP Status Code: 403 API Version 2016-11-28 1037 Amazon Lightsail RequestExpired API Reference 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 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 ValidationError The input fails to satisfy the constraints specified by an AWS service. HTTP Status Code: 400 API Version 2016-11-28 1038 |
amazon-location-developer-guide-001 | amazon-location-developer-guide.pdf | 1 | Developer Guide Amazon Location Service Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon Location Service Developer Guide Amazon Location Service: Developer Guide Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. 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 affiliated with, connected to, or sponsored by Amazon. Amazon Location Service Table of Contents Developer Guide What is Amazon Location Service .................................................................................................. 1 Key features ................................................................................................................................................... 1 Key benefits ................................................................................................................................................... 4 Access high-quality geospatial data .................................................................................................... 4 Integrate seamlessly ............................................................................................................................... 5 Own your data ......................................................................................................................................... 5 Reduce operating costs .......................................................................................................................... 5 Rapid development ................................................................................................................................. 6 Supported regions ........................................................................................................................................ 6 Pricing model ................................................................................................................................................ 9 Terms of use and data attribution ........................................................................................................... 9 Data quality and coverage ....................................................................................................................... 11 Route Coverage definitions ................................................................................................................ 11 Place Address definitions .................................................................................................................... 11 Place Points-of-Interest (POI) definitions ........................................................................................ 11 Country/area data quality .................................................................................................................. 12 Get started ..................................................................................................................................... 28 Set up an account for the first time ...................................................................................................... 28 Set up authentication for the first time ................................................................................................ 32 Choose an API ............................................................................................................................................. 33 Create your first Maps and Places application ..................................................................................... 35 Create your first Geofences and Trackers application ........................................................................ 51 iOS ............................................................................................................................................................ 51 Android .................................................................................................................................................... 60 Authentication ............................................................................................................................... 70 Choose an authentication method ......................................................................................................... 70 Use API keys ................................................................................................................................................ 71 Create an API key ................................................................................................................................. 72 Call an API .............................................................................................................................................. 74 Best practices ......................................................................................................................................... 79 Use Amazon Cognito ................................................................................................................................. 79 Use Amazon Cognito and Amazon Location Service ..................................................................... 80 Create an Amazon Cognito identity pool ........................................................................................ 83 Use the identity pool in web ............................................................................................................. 84 iii Amazon Location Service Developer Guide Use IAM ........................................................................................................................................................ 85 Audience .................................................................................................................................................. 86 Authenticating with identities ............................................................................................................ 86 Managing access using policies .......................................................................................................... 90 How Amazon Location Service works with IAM ............................................................................. 92 How Amazon Location Service works with unauthenticated users .......................................... 100 Identity-based policy examples ....................................................................................................... 100 Troubleshooting .................................................................................................................................. 112 Maps ............................................................................................................................................. 115 Features ...................................................................................................................................................... 115 Common use cases .................................................................................................................................. 116 Standalone Map APIs .............................................................................................................................. 117 Displaying Map ......................................................................................................................................... 118 Map concepts ............................................................................................................................................ 118 Maps terminology ............................................................................................................................... 119 Localization and internationalization ............................................................................................. 120 Map styles ................................................................................................................................................. 123 Map styles overview .......................................................................................................................... 123 AWS map styles .................................................................................................................................. 123 Standard map style ............................................................................................................................ 124 Monochrome map style .................................................................................................................... 125 Hybrid map style ................................................................................................................................ 125 Satellite map style ............................................................................................................................. 126 Standard map style ............................................................................................................................ 127 Monochrome map style .................................................................................................................... 136 Hybrid map style ................................................................................................................................ 140 Map APIs .................................................................................................................................................... 142 Maps ...................................................................................................................................................... 142 Dynamic maps ..................................................................................................................................... 145 Static maps .......................................................................................................................................... 159 How to ........................................................................................................................................................ 164 Dynamic maps ..................................................................................................................................... 164 Static maps .......................................................................................................................................... 214 Manage costs and usage ........................................................................................................................ 267 Best practices ...................................................................................................................................... 268 Pricing ................................................................................................................................................... 270 iv Amazon Location Service Developer Guide Quotas and usage .............................................................................................................................. 270 Places ............................................................................................................................................ 273 What is a Place? ....................................................................................................................................... 273 Features .......................................................................................................................................................... 1 Use cases ................................................................................................................................................... 152 Places APIs overview ............................................................................................................................... 275 Places concepts ........................................................................................................................................ 276 Places terminology ............................................................................................................................. 276 Querying and biasing ........................................................................................................................ 278 Filtering ................................................................................................................................................. 279 Localization and internationalization ............................................................................................. 315 Contacts and opening hours ............................................................................................................ 317 Additional features ............................................................................................................................. 319 IntendedUse ......................................................................................................................................... 320 Get Started ................................................................................................................................................ 321 Places ..................................................................................................................................................... 321 Geocode ................................................................................................................................................ 325 Reverse Geocode ................................................................................................................................. 328 Autocomplete ...................................................................................................................................... 331 GetPlace ................................................................................................................................................ 333 Search Nearby ..................................................................................................................................... 335 Search Text .......................................................................................................................................... 338 Suggest ................................................................................................................................................. 340 How to ........................................................................................................................................................ 343 Use Geocode ........................................................................................................................................ 344 Use ReverseGeocode .......................................................................................................................... 416 Use Autocomplete .............................................................................................................................. 436 Use Get Place ...................................................................................................................................... 447 Use SearchNearby ............................................................................................................................... 457 Use SearchText .................................................................................................................................... 481 Use Suggest ......................................................................................................................................... 530 What's Next ............................................................................................................................................... 558 Best practices ...................................................................................................................................... 558 Places pricing ....................................................................................................................................... 559 Quotas and usage .............................................................................................................................. 560 Routes ........................................................................................................................................... 563 v Amazon Location Service Developer Guide Features ...................................................................................................................................................... 563 Use cases ................................................................................................................................................... 566 APIs ............................................................................................................................................................. 567 Routes concepts ....................................................................................................................................... 568 Terminology ......................................................................................................................................... 569 Where (origin, destination, waypoint, and traces) ....................................................................... 570 When (departure and arrival) .......................................................................................................... 578 How (travel mode, avoidance, and exclusion) .............................................................................. 580 Traffic awareness ................................................................................................................................ 587 Optimize route and waypoint sequence ........................................................................................ 588 Driver schedule and notices ............................................................................................................. 589 Route APIs ................................................................................................................................................. 592 Calculate routes .................................................................................................................................. 600 Calculate route matrix ....................................................................................................................... 606 Calculate isolines ................................................................................................................................ 607 Optimize waypoints ........................................................................................................................... 610 Snap to Roads ..................................................................................................................................... 612 How to ........................................................................................................................................................ 613 Use CalculateRoutes ........................................................................................................................... 614 Use CalculateIsolines ......................................................................................................................... 703 Use CalculateRouteMatrix ................................................................................................................. 719 Use OptimizeWaypoints .................................................................................................................... 728 Use SnapToRoads ............................................................................................................................... 742 Manage costs and usage ........................................................................................................................ 747 Best Practices ...................................................................................................................................... 747 Routes pricing ..................................................................................................................................... 749 Routes Quota and Usage .................................................................................................................. 752 Geofences ..................................................................................................................................... 755 Use cases ................................................................................................................................................... 756 Geofence concepts ................................................................................................................................... 757 Common terminology ........................................................................................................................ 757 Get started ................................................................................................................................................ 758 How to ........................................................................................................................................................ 759 Evaluate device positions against geofences ................................................................................ 760 React to events with EventBridge |
amazon-location-developer-guide-002 | amazon-location-developer-guide.pdf | 2 | routes .................................................................................................................................. 600 Calculate route matrix ....................................................................................................................... 606 Calculate isolines ................................................................................................................................ 607 Optimize waypoints ........................................................................................................................... 610 Snap to Roads ..................................................................................................................................... 612 How to ........................................................................................................................................................ 613 Use CalculateRoutes ........................................................................................................................... 614 Use CalculateIsolines ......................................................................................................................... 703 Use CalculateRouteMatrix ................................................................................................................. 719 Use OptimizeWaypoints .................................................................................................................... 728 Use SnapToRoads ............................................................................................................................... 742 Manage costs and usage ........................................................................................................................ 747 Best Practices ...................................................................................................................................... 747 Routes pricing ..................................................................................................................................... 749 Routes Quota and Usage .................................................................................................................. 752 Geofences ..................................................................................................................................... 755 Use cases ................................................................................................................................................... 756 Geofence concepts ................................................................................................................................... 757 Common terminology ........................................................................................................................ 757 Get started ................................................................................................................................................ 758 How to ........................................................................................................................................................ 759 Evaluate device positions against geofences ................................................................................ 760 React to events with EventBridge ................................................................................................... 761 Manage resources ............................................................................................................................... 767 vi Amazon Location Service Developer Guide Manage costs and usage ........................................................................................................................ 774 Pricing ................................................................................................................................................... 775 Quotas and usage .............................................................................................................................. 776 Trackers ........................................................................................................................................ 779 Features ...................................................................................................................................................... 780 Use cases ................................................................................................................................................... 782 Tracker concepts ....................................................................................................................................... 783 Common terminology ........................................................................................................................ 783 Get started ................................................................................................................................................ 785 Create a tracker .................................................................................................................................. 785 Create an unauthenticated identity pool ...................................................................................... 791 Update your tracker with a device position .................................................................................. 793 Get a device's location history ......................................................................................................... 795 List your device positions ................................................................................................................. 796 How to ........................................................................................................................................................ 799 Verify positions ................................................................................................................................... 799 Link to a geofence collection .......................................................................................................... 801 Track using AWS IoT and MQTT ...................................................................................................... 803 Manage trackers .................................................................................................................................. 811 Manage costs and usage ........................................................................................................................ 815 Pricing ................................................................................................................................................... 816 Quotas and usage .............................................................................................................................. 817 Developer tools ............................................................................................................................ 820 SDKs and frameworks ............................................................................................................................. 820 Developer tutorials ............................................................................................................................. 821 SDKs by language ............................................................................................................................... 849 Map Rendering SDK by language ................................................................................................... 853 API and CLI reference ............................................................................................................................. 855 API .......................................................................................................................................................... 855 CLI .......................................................................................................................................................... 855 Examples and Learning Resources ....................................................................................................... 858 Demos ................................................................................................................................................... 858 Samples ................................................................................................................................................ 858 GitHub ................................................................................................................................................... 859 Integrate with AWS ..................................................................................................................... 860 Resource Management ............................................................................................................................ 861 vii Amazon Location Service Developer Guide Manage quotas .................................................................................................................................... 862 Manage resources with Tags ............................................................................................................ 880 Manage billing and costs .................................................................................................................. 884 Create resources with AWS CloudFormation ................................................................................ 884 Monitoring and Auditing ........................................................................................................................ 885 Monitor with Amazon CloudWatch ................................................................................................. 885 Monitor and log with AWS CloudTrail ........................................................................................... 893 Best practices ............................................................................................................................................ 903 Resource management ...................................................................................................................... 903 Billing and cost management .......................................................................................................... 904 Quotas and usage .............................................................................................................................. 904 Security ........................................................................................................................................ 905 Data protection ........................................................................................................................................ 906 Data privacy ......................................................................................................................................... 907 Data retention ..................................................................................................................................... 907 Data at rest encryption ..................................................................................................................... 907 Data in transit encryption ................................................................................................................ 920 Incident response ..................................................................................................................................... 920 Logging and Monitoring ................................................................................................................... 921 Compliance validation ............................................................................................................................ 921 Resilience ................................................................................................................................................... 922 Infrastructure security ............................................................................................................................. 923 AWS PrivateLink for Amazon Location ............................................................................................... 923 Types of Amazon VPC endpoints for Amazon Location Service ............................................... 924 Considerations when using AWS PrivateLink for Amazon Location Service ........................... 925 Create an interface endpoint for Amazon Location Service ...................................................... 926 Access Amazon Location API operations from Amazon Location interface endpoints ......... 927 Update an on-premises DNS configuration .................................................................................. 928 Create an Amazon VPC endpoint policy for Amazon Location ................................................. 928 Configuration and vulnerability analysis ............................................................................................ 929 Confused deputy prevention ................................................................................................................. 929 Best practices ............................................................................................................................................ 929 Security ................................................................................................................................................. 930 Document history ........................................................................................................................ 932 AWS Glossary ............................................................................................................................... 933 viii Amazon Location Service Developer Guide What is Amazon Location Service Amazon Location Service is a fully-managed service that makes it easy to add location functionality to your applications. Amazon Location uses high-quality geospatial data to provide capabilities such as maps, places, routes, trackers, and geofences. In addition to these capabilities, Amazon Location helps you maintain control of your data for privacy and security. It enables you to access location data simply with developer tools and move your applications to production faster with included monitoring and management capabilities. This video provides an overview of the Amazon Location service. Introduction to Amazon Location Service With Amazon Location Service, you can add powerful location data and functionality to your applications. This includes capabilities such as maps, places (search and geocoding), routes, geofences, and trackers. Amazon Location provides location-based services (LBS) with high-quality data with global coverage. With its affordable data, geofences and trackers features, and built-in metrics for health monitoring, you can build sophisticated location-enabled applications. With Amazon Location, you are in control of your organization's data. It anonymizes queries sent to data providers by removing customer metadata and account information. Moreover, sensitive tracking and geofences location information, such as facility, asset, and personnel locations, never leaves your AWS account. This approach helps protect sensitive information from third parties, safeguard user privacy, and reduce security risks for your application. Amazon Location also ensures that neither Amazon nor third parties have rights to sell your data or use it for advertising. With Amazon Location Service, you can easily and seamlessly integrated your application with other AWS services, streamlining your development workflow and speeding up deployment. It works seamlessly with AWS CloudTrail, Amazon CloudWatch, Amazon EventBridge, and AWS Identity and Access Management. With this integration, you can easily manage resources and cost, monitor health metrics, and automatically respond to events, thanks |
amazon-location-developer-guide-003 | amazon-location-developer-guide.pdf | 3 | account. This approach helps protect sensitive information from third parties, safeguard user privacy, and reduce security risks for your application. Amazon Location also ensures that neither Amazon nor third parties have rights to sell your data or use it for advertising. With Amazon Location Service, you can easily and seamlessly integrated your application with other AWS services, streamlining your development workflow and speeding up deployment. It works seamlessly with AWS CloudTrail, Amazon CloudWatch, Amazon EventBridge, and AWS Identity and Access Management. With this integration, you can easily manage resources and cost, monitor health metrics, and automatically respond to events, thanks to its built-in monitoring, security, and compliance features. Key features of Amazon Location Amazon Location offers a comprehensive set of features to enhance your location-based applications and services. This page provides an overview of the key capabilities available, including Maps, Places, Routes, and Geofences and Trackers. Leveraging these features, you can Key features 1 Amazon Location Service Developer Guide build rich, location-aware experiences tailored to your specific use cases, whether it's delivering real-time location intelligence, enabling location-based services, or optimizing logistics and transportation operations. Amazon Location provides the following features: Maps Amazon Location Service Maps lets you visualize location information and is the foundation of many location-based service capabilities. Amazon Location Service offers both dynamic and static maps. Dynamic Maps allow you to create interactive maps using map tiles, with the option to use pre-built map styles such as standard, monochrome, hybrid, and satellite. You can stitch the Dynamic Maps content (Tiles, Styles, Glyphs, and Sprites) together using a map rendering engine, such as MapLibre. Static Maps allow you to create pre-rendered, non-interactive map images that display a fixed geographical area to be embedded in applications without complex renderers. For more information, see Maps. Places Amazon Location Service Places lets you integrate search and geocode functionality into your application. You can: • Use geocode (Forward and Reverse) to convert a place, such an admin area, street, or address into geographic coordinates and vice versa. • Use places search (Text and Nearby) to search for points of interest and get information on contact, access points, and opening hours. • Use autocomplete or suggestions to autofill or predict an address or place based on user input. You can also use Get Place to get place details by place ID. For more information, see Places. Routes Amazon Location Service Routes lets you find routes, service area, and optimize and analyze routes. You can do the following: Key features 2 Amazon Location Service Developer Guide • Estimate travel time and distance based on an up-to-date road network and live traffic information. • Create a service area or isoline based on distance and time thresholds of your business need. • Calculate a matrix (time and distance) for multiple origins and destinations and use the same for route planning. • Align GPS traces to the nearest road segment, to improve accuracy of vehicle tracking and route visualization. • Find the most efficient order to travel to multiple destinations, also known as solving the travelling salesman problem. For more information, see Routes. Geofences Amazon Location Service Geofences lets you give your application the ability to detect and act when a device enters or exits a defined geographical boundary known as a geofence. Automatically send an entry or exit event to Amazon EventBridge when a geofence breach is detected. This lets you initiate downstream actions, such as sending a notification to a target. For more information, see Geofences. Trackers Amazon Location Service Trackers let you retrieve the current and historical location of devices that are running your tracking-enabled application. You can also link trackers with Amazon Location Service geofences to evaluate location updates from your devices against your geofences automatically. Trackers can help you reduce costs by filtering position updates that haven't moved before storing or evaluating them against geofences. For more information, see Trackers. Key features 3 Amazon Location Service Developer Guide Key benefits of Amazon Location Service This section provides an overview of the key benefits of Amazon Location Service. The main benefits are: • Access high-quality geospatial data - Integrate reliable, complete, and up-to-date data into applications to make informed decisions, deliver precise insights, and optimize operations. • Integrate seamlessly - Quickly deploy and accelerate application development with seamless integration with AWS services. Amazon Location seamlessly integrates with various AWS services, enabling faster development, deployment, monitoring, and security compliance. • Own your data - Safeguard sensitive customer information, protect user privacy and reduce your application's overall security risks. The service provides robust data protection measures, including data anonymization, encryption, and integration with AWS security services. • Reduce operating costs - It offers high-quality geospatial data with a pay-as-you-go model, requiring no upfront commitment or minimum fee. • Rapid development - The service allows for easy |
amazon-location-developer-guide-004 | amazon-location-developer-guide.pdf | 4 | optimize operations. • Integrate seamlessly - Quickly deploy and accelerate application development with seamless integration with AWS services. Amazon Location seamlessly integrates with various AWS services, enabling faster development, deployment, monitoring, and security compliance. • Own your data - Safeguard sensitive customer information, protect user privacy and reduce your application's overall security risks. The service provides robust data protection measures, including data anonymization, encryption, and integration with AWS security services. • Reduce operating costs - It offers high-quality geospatial data with a pay-as-you-go model, requiring no upfront commitment or minimum fee. • Rapid development - The service allows for easy integration of geospatial data into applications, accelerating development cycles and streamlining integration with other AWS services. Access high-quality geospatial data Amazon Location Service offers a comprehensive solution for integrating geospatial capabilities into applications, focusing on four key benefits: seamless AWS integration, data ownership and privacy, cost reduction, and rapid development. By leveraging AWS infrastructure and security measures, the service enables you to quickly implement location-based features while maintaining control over your data and reducing operational costs. Key benefits 4 Amazon Location Service Integrate seamlessly Developer Guide With Amazon Location Service, you quickly deploy and accelerate application development with seamless integrations with AWS services. Amazon Location seamlessly integrates with a suite of AWS services to streamline development workflows, accelerate deployment, and provide robust monitoring, security, and compliance. It works with AWS CloudFormation for consistent resource provisioning, Amazon CloudWatch for tracking metrics, AWS CloudTrail for logging account activity, and Amazon EventBridge for event-driven architectures utilizing AWS Lambda. Amazon Location also leverages AWS Identity and Access Management (IAM) for secure access controls and resource tagging for efficient organization and management. This comprehensive integration enables faster development cycles, operational visibility, and adherence to security best practices. For more information, see Integrate with AWS. Own your data With Amazon Location Service, you protect user privacy, shield your sensitive information, and reduce your application’s security risks. Amazon Location provides robust data control, rights, and secure access measures to ensure your organization's data remains private and secure. It anonymizes queries, encrypts sensitive location data at rest and in transit, and integrates with AWS Key Management Service (AWS KMS) so you can use your own encryption keys. You retain full rights to your data, with no third-party access for advertising or resale. Amazon Location also seamlessly integrates with AWS Identity and Access Management and Amazon Cognito for secure authentication and access controls, leveraging the proven security services at AWS to safeguard your data and applications. For more information, see Security. Reduce operating costs With Amazon Location Service, you access cost-effective, high-quality geospatial data from trusted data providers. Amazon Location requires no up-front commitment, and no minimum fee. You are only charged for what you use. Location data is billed based on each request your application makes to the service. See the following case studies: • Halodoc, a digital health system, reduced 88% cost using Amazon Location Service Integrate seamlessly 5 Amazon Location Service Developer Guide • Geo.me, a web services provider, reduced 90% geospatial cost using Amazon Location Service Rapid development Amazon Location Service enables developers to quickly integrate geospatial data and functionality into their applications. By providing fully managed APIs, Amazon Location eliminates the need to build and maintain complex location data infrastructure. The service also seamlessly integrates with AWS services like AWS CloudFormation, CloudWatch, CloudTrail, and EventBridge, allowing developers to leverage these tools to build efficient, event-driven architectures. This integration streamlines the development process, accelerating the prototyping, iteration, and deployment of location-based experiences. With Amazon Location, organizations can rapidly enhance their offerings with geospatial features, reducing time-to-market and allowing developers to focus on core product development. ...Since it was so easy to get started and implement Amazon Location Service, our application was up and running in production in 2 weeks. Our ability to develop at this speed ensured readiness for the state department of transportation review date. We’ve done the review with the state and they approved our solution, we are now rolling it out to multiple company divisions for their upcoming state regulatory needs... Charles Evans, Chief Technology Officer at Command Alkon Amazon Location supported regions Amazon Location Service is available across multiple AWS regions globally. This page lists the regions where the service is currently deployed and operational. It provides information to help you determine the most suitable region for your applications and workloads. The guide covers any potential variations or limitations in feature availability across regions. This information is crucial for making informed decisions regarding deployment locations, ensuring compliance with data residency requirements, and optimizing performance based on the proximity to end-users or operational centers. Amazon Location is available in the following AWS Regions, using the listed endpoints. For more information, see AWS service endpoints. Rapid development 6 Amazon Location Service Developer Guide |
amazon-location-developer-guide-005 | amazon-location-developer-guide.pdf | 5 | globally. This page lists the regions where the service is currently deployed and operational. It provides information to help you determine the most suitable region for your applications and workloads. The guide covers any potential variations or limitations in feature availability across regions. This information is crucial for making informed decisions regarding deployment locations, ensuring compliance with data residency requirements, and optimizing performance based on the proximity to end-users or operational centers. Amazon Location is available in the following AWS Regions, using the listed endpoints. For more information, see AWS service endpoints. Rapid development 6 Amazon Location Service Developer Guide Region name Region code Endpoint Protocol US East (Ohio) us-east-2 US East (N. Virginia) us-east-1 US West (Oregon) us-west-2 Asia Pacific (Mumbai) Asia Pacific (Singapore) ap-south-1 ap-southeast-1 Asia Pacific (Sydney) ap-southeast-2 Asia Pacific (Malaysia) ap-southeast-5 Asia Pacific (Tokyo) ap-northeast-1 geo.us-ea st-2.amaz onaws.com geo.us-ea st-1.amaz onaws.com geo.us-we st-2.amaz onaws.com geo.ap-so uth-1.ama zonaws.com geo.ap-so utheast-1 .amazonaw s.com geo.ap-so utheast-2 .amazonaw s.com geo.ap-so utheast-5 .amazonaw s.com geo.ap-no rtheast-1 .amazonaw s.com HTTPS HTTPS HTTPS HTTPS Available version Current and Previous Current and Previous Current and Previous Current and Previous HTTPS Previous HTTPS Current and Previous HTTPS Previous HTTPS Current and Previous Supported regions 7 Amazon Location Service Developer Guide Region name Region code Endpoint Protocol Available version Current and Previous Current and Previous Current and Previous Current and Previous Current and Previous Current and Previous Current and Previous HTTPS Previous HTTPS HTTPS HTTPS HTTPS HTTPS HTTPS HTTPS Canada (Central) ca-central-1 Europe (Frankfur t) eu-central-1 Europe (Ireland) eu-west-1 Europe (London) eu-west-2 Europe (Spain) eu-south-2 Europe (Stockholm) eu-north-1 South America (São Paulo) sa-east-1 AWS GovCloud (US-West) us-gov-west-1 geo.ca-ce ntral-1.a mazonaws.com geo.eu-ce ntral-1.a mazonaws.com geo.eu-we st-1.amaz onaws.com geo.eu-we st-2.amaz onaws.com geo.eu-so uth-2.ama zonaws.com geo.eu-no rth-1.ama zonaws.com geo.sa-ea st-1.amaz onaws.com geo.us-go v-west-1. amazonaws.com geo-fips.us-gov- west-1.amaz onaws.com Supported regions 8 Amazon Location Service Pricing model Developer Guide Amazon Location Service requires no up-front commitment and no minimum fee. You're only charged for what you use. Amazon Location offers a free trial for the first three months of usage (usage quota apply). Location data is billed based on each request your application makes to the service. Beyond the Amazon Location Service free trial, you pay for the requests your application makes to the service. For more pricing information, visit our pricing page. Pricing Buckets Each API may offer multiple features at different price points and the price may vary based on features you requested through request parameters. For example, for CalculateRoutes, you'll be charged at Core price bucket when using Car, Pedestrian, or Truck mode. You'll be charged at Advanced price bucket when using other travel modes, such as Scooter mode. You'll be charged at Premium price bucket when you request for Toll Cost calculation. The specific pricing bucket you'll be charged for will be returned in the PricingBucket response field. To review the pricing for each API and feature, see the Amazon Location Service pricing page for details on API feature, request parameters, and corresponding pricing. For more information, see the following topics: • the section called “Pricing” • the section called “Places pricing” • the section called “Routes pricing” • the section called “Pricing” • the section called “Pricing” Terms of use and data attribution Before you use Amazon Location Service, be sure you can comply with all applicable legal requirements, including license terms applicable to the use of the provider. • For more information about the AWS requirements, see Section 82 of the AWS Service Terms. • For more information about the SLAs, see Amazon Location SLA. Pricing model 9 Amazon Location Service Developer Guide Amazon Location Service leverages data from multiple sources, as shown below: • HERE Technologies provides AWS customers access to base maps, geocoding, reverse geocoding, and street-level address data. Maps provided by HERE are constantly validated based on an average of 5 million daily updates to deliver over 900 mapping attributes and maintain accurate information. Learn more about HERE. • GrabMaps provides AWS customers access to various styles of map tiles, geocoding capabilities, reverse geocoding capabilities, and routing options. Today, GrabMaps powers more than 800 billion searches, suggestions, trips and trends each month in eight Southeast Asian countries. Learn more about GrabMaps. • Esri provides AWS customers access to various styles of map tiles, geocoding capabilities, reverse geocoding capabilities, and street-level address data. Today, Esri’s technology is deployed in more than 350,000 organizations including 90 of the Fortune 100 companies. Learn more about Esri. • AWS provides customers access to global base maps built from the Daylight distribution of OpenStreetMap (OSM) and other open data sources. Map styles are professionally designed to support different applications and use cases, including logistics and delivery, and data visualization in web and mobile environments. With a community of over a million map makers, OSM is an open |
amazon-location-developer-guide-006 | amazon-location-developer-guide.pdf | 6 | Esri provides AWS customers access to various styles of map tiles, geocoding capabilities, reverse geocoding capabilities, and street-level address data. Today, Esri’s technology is deployed in more than 350,000 organizations including 90 of the Fortune 100 companies. Learn more about Esri. • AWS provides customers access to global base maps built from the Daylight distribution of OpenStreetMap (OSM) and other open data sources. Map styles are professionally designed to support different applications and use cases, including logistics and delivery, and data visualization in web and mobile environments. With a community of over a million map makers, OSM is an open data project where contributors update more than 500,000 features per day. Learn more about Open Data. When using data from Amazon Location Service you shall provide End-Users of your products and/or services with notice, in a reasonably conspicuous manner (e.g., by inserting a reference in the End-User Terms), a link to this page, which highlights our data sources, and their sources for attribution. In addition, by default, attribution is shown on the bottom right corner of the map when using Amazon Location Service to render dynamic maps. • Esri's data source attributions • GrabMaps' data source attributions • HERE's data source attributions Terms of use and data attribution 10 Amazon Location Service Developer Guide Data quality and coverage Amazon Location Service has extensive global coverage of map data. All Amazon Location Map data quality is categorized as Comprehensive, Good, or Fair per country. Map data is categorized separately for Routing, Place Addresses, and Place Points-of-Interest (POI) data. Route Coverage definitions • Comprehensive - Complete coverage of the road network in a country. Providing the ability to calculate optimal routes between all addresses within a country. • Good - Coverage of most roads within a country. Providing the ability to calculate routes between all addresses within a country. • Fair - Coverage of roads in major cities and major roads between cities. Place Address definitions • Comprehensive - Complete coverage of all addresses within a country with full address details. • Good - Coverage of addresses in major and select cities and streets. • Fair - Coverage of major cities. • Unsupported - No support for addresses within a country. Place Points-of-Interest (POI) definitions • Comprehensive - Coverage of the businesses to support an optimal search experience. • Good - Coverage of businesses on a best effort basis. • Fair - Only basic and high-profile landmark POI information available. • Unsupported - No support for POIs within a country. Data quality and coverage 11 Amazon Location Service Developer Guide Country/area data quality Country/ Area Afghanist an ISO A3 ISO A2 Route coverage Place Address coverage Place POI coverage AFG AF Fair Fair Unsupported Albania ALB Algeria DZA American Samoa ASM Andorra AND Angola AGO Anguilla AIA Antarctic a ATA AL DZ AS AD AO AI AQ Comprehensive Comprehensive Good Comprehensive Comprehensive Unsupported Good Good Unsupported Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Unsupported Fair Fair Good Fair Unsupported Unsupported ATG AG Fair Fair Unsupported Antigua And Barbuda Argentina ARG Armenia ARM Aruba ABW Australia AUS Austria AUT Azerbaija n AZE AR AM AW AU AT AZ Comprehensive Comprehensive Comprehensive Good Good Good Good Unsupported Unsupported Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Unsupported Country/area data quality 12 Amazon Location Service Developer Guide Country/ Area ISO A3 ISO A2 Route coverage Place Address coverage Place POI coverage BS BH BD BB BY BE BZ BJ BM BT BO BA BW BR IO Bahamas BHS Bahrain BHR Banglades h BGD Barbados BRB Belarus BLR Belgium BEL Belize BLZ Benin BEN Bermuda BMU Bhutan BTN Bolivia BOL BIH Bosnia And Herzegovi na Botswana BWA Brazil BRA IOT British Indian Ocean Territory Comprehensive Comprehensive Good Comprehensive Comprehensive Good Comprehensive Good Unsupported Good Good Unsupported Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Good Good Good Fair Good Good Good Fair Unsupported Unsupported Unsupported Unsupported Comprehensive Comprehensive Unsupported Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Good Comprehensive Comprehensive Comprehensive Fair Fair Unsupported Country/area data quality 13 Amazon Location Service Developer Guide ISO A3 ISO A2 Route coverage Place Address coverage Place POI coverage VGB VG Fair Fair Unsupported BRN BN Comprehensive Comprehensive Fair Country/ Area British Virgin Islands Brunei Darussala m BG BF BI KH CM CA CV Comprehensive Comprehensive Comprehensive Good Good Unsupported Good Good Unsupported Comprehensive Good Fair Comprehensive Comprehensive Unsupported Comprehensive Comprehensive Comprehensive Good Good Unsupported CYM KY Comprehensive Comprehensive Good CAF CF Good Good Unsupported Bulgaria BGR Burkina Faso BFA Burundi BDI Cambodia KHM Cameroon CMR Canada CAN CPV Cape Verde Cayman Islands Central African Republic Chad Chile TCD CHL TD CL CN Good Good Unsupported Comprehensive Comprehensive Comprehensive Fair Fair Unsupported China CHN Country/area data quality 14 Amazon Location Service Developer Guide Country/ Area ISO A3 ISO A2 Route coverage Place Address coverage Place POI coverage |
amazon-location-developer-guide-007 | amazon-location-developer-guide.pdf | 7 | BG BF BI KH CM CA CV Comprehensive Comprehensive Comprehensive Good Good Unsupported Good Good Unsupported Comprehensive Good Fair Comprehensive Comprehensive Unsupported Comprehensive Comprehensive Comprehensive Good Good Unsupported CYM KY Comprehensive Comprehensive Good CAF CF Good Good Unsupported Bulgaria BGR Burkina Faso BFA Burundi BDI Cambodia KHM Cameroon CMR Canada CAN CPV Cape Verde Cayman Islands Central African Republic Chad Chile TCD CHL TD CL CN Good Good Unsupported Comprehensive Comprehensive Comprehensive Fair Fair Unsupported China CHN Country/area data quality 14 Amazon Location Service Developer Guide Country/ Area ISO A3 ISO A2 Route coverage Place Address coverage Place POI coverage Colombia COL Comoros COM Congo COG COD CO KM CG CD Comprehensive Comprehensive Fair Good Good Good Good Good Good Unsupported Unsupported Unsupported Congo, The Democrati c Republic of Cook Islands Costa Rica COK CK Fair Fair Unsupported CRI CR Comprehensive Comprehensive Good Croatia CRV Cuba CUB Curacao CUW Cyprus CYP Czechia CZE Denmark DNK Djibouti DJI Dominica DMA Dominican Republic DOM HR CU CW CY CZ DK DJ DM DO Comprehensive Comprehensive Comprehensive Good Fair Good Good Unsupported Unsupported Comprehensive Comprehensive Unsupported Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Good Fair Good Fair Unsupported Unsupported Comprehensive Comprehensive Fair Country/area data quality 15 Amazon Location Service Developer Guide Country/ Area ISO A3 ISO A2 Route coverage Place Address coverage Place POI coverage Ecuador ECU EGY CLV Egypt El Salvador Equatoria l Guinea EC EG SV Good Good Unsupported Comprehensive Comprehensive Fair Good Good Unsupported GNQ GQ Good Good Unsupported Eritrea ERI Estonia EST Eswatini SWZ Ethiopia ETH Falkland Islands FLK ER EE SZ ET FK Good Good Unsupported Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Good Comprehensive Comprehensive Unsupported Comprehensive Comprehensive Unsupported Faroe Islands FRO FO Comprehensive Comprehensive Unsupported Fiji FJI Finland FIN France FRA French Guiana GUF French Polynesia PYF FJ FI FR GF PF Good Good Unsupported Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Good Good Good Unsupported Gabon GAB GA Good Good Unsupported Country/area data quality 16 Amazon Location Service Developer Guide Country/ Area ISO A3 ISO A2 Route coverage Place Address coverage Place POI coverage Gambia GMB GM Georgia GEO Germany DEU Ghana GHA Gibraltar GIB Greece GRC Greenland GRL Grenada GRD Guadeloup e GLP Guam GUM Guatemala GTM Guernsey GGY Guinea GIN GE DE GH GI GR GL GD GP GU GT GG GN Guinea- Bissau GNB GW Guyana GUY Haiti HTI Honduras HND Hong Kong HKG GY HT HN HK Good Good Good Good Unsupported Unsupported Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Unsupported Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Fair Fair Fair Fair Unsupported Unsupported Comprehensive Comprehensive Fair Good Good Good Comprehensive Comprehensive Unsupported Comprehensive Comprehensive Comprehensive Good Good Good Good Good Good Good Good Good Good Unsupported Unsupported Unsupported Unsupported Unsupported Comprehensive Comprehensive Fair Country/area data quality 17 Amazon Location Service Developer Guide Country/ Area ISO A3 ISO A2 Route coverage Place Address coverage Place POI coverage Hungary GUN HU Comprehensive Comprehensive Comprehensive Iceland ISL India IND Indonesia IDN Iran Iraq IRN IRQ Ireland IRL Isle of Man Israel Italy Ivory Coast IMN ISR ITA CIV Jamaica JAM Japan Jersey JPN JEY Jordan JOR Kazakhsta n KAZ Kenya KEN Kiribati KIR IS IN ID IR IQ IE IM IL IT CI JM JP JE JO KZ KE KI Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Good Comprehensive Comprehensive Good Fair Good Fair Good Unsupported Unsupported Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Good Comprehensive Comprehensive Fair Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Good Good Good Unsupported Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Good Comprehensive Comprehensive Comprehensive Comprehensive Fair Fair Comprehensive Comprehensive Fair Fair Fair Unsupported Country/area data quality 18 Amazon Location Service Developer Guide Country/ Area ISO A3 ISO A2 Route coverage Place Address coverage Place POI coverage Kosovo KOS Kuwait KWT Kyrgyzsta n KGZ Laos LAO Latvia LVA Lebanon LBN Lesotho LSO Liberia LBR Libya Liechtens tein LBY LIE Lithuania LTU Luxembour g LUX Macau MAC Madagasca r MDG XK KW KG LA LV LB LS LR LY LI LT LU MO MG Comprehensive Comprehensive Unsupported Comprehensive Comprehensive Fair Good Good Unsupported Fair Fair Unsupported Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Fair Comprehensive Comprehensive Good Good Good Good Good Unsupported Unsupported Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Good Good Good Unsupported Malawi MWI MW Comprehensive Comprehensive Unsupported Malaysia MYS Maldives MDV MY MV Comprehensive Comprehensive Comprehensive Good Good Unsupported Country/area data quality 19 Amazon Location Service Developer Guide Country/ Area ISO A3 ISO A2 Route coverage Place Address coverage Place POI coverage Mali MLI Malta MLT Marshall Islands MHL ML MT MH Good Good Unsupported Comprehensive Comprehensive Comprehensive Fair Fair Unsupported Martiniqu e Mauritani a MTQ MQ Comprehensive Comprehensive Unsupported MRT MR Good Good Unsupported Mauritius MUS Mayotte MYT Mexico MEX FSM Micronesi a, Federated States of Moldova MDA Monaco MCO Mongolia MNG Montenegr o MNE MU |
amazon-location-developer-guide-008 | amazon-location-developer-guide.pdf | 8 | Good Good Good Unsupported Malawi MWI MW Comprehensive Comprehensive Unsupported Malaysia MYS Maldives MDV MY MV Comprehensive Comprehensive Comprehensive Good Good Unsupported Country/area data quality 19 Amazon Location Service Developer Guide Country/ Area ISO A3 ISO A2 Route coverage Place Address coverage Place POI coverage Mali MLI Malta MLT Marshall Islands MHL ML MT MH Good Good Unsupported Comprehensive Comprehensive Comprehensive Fair Fair Unsupported Martiniqu e Mauritani a MTQ MQ Comprehensive Comprehensive Unsupported MRT MR Good Good Unsupported Mauritius MUS Mayotte MYT Mexico MEX FSM Micronesi a, Federated States of Moldova MDA Monaco MCO Mongolia MNG Montenegr o MNE MU YT MX FM MD MC MN ME Comprehensive Comprehensive Unsupported Comprehensive Comprehensive Good Comprehensive Comprehensive Fair Fair Fair Unsupported Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Good Good Fair Comprehensive Comprehensive Comprehensive Montserra t MSR MS Fair Fair Unsupported Morocco MAR MA Comprehensive Comprehensive Fair Country/area data quality 20 Amazon Location Service Developer Guide Country/ Area ISO A3 ISO A2 Route coverage Place Address coverage Place POI coverage Mozambiqu e MOZ MZ Comprehensive Comprehensive Fair Myanmar MMR MM Comprehensive Fair Unsupported Namibia NAM Nauru NRU Nepal NPL Netherlan ds NLD NA NR NP NL Comprehensive Comprehensive Fair Fair Good Fair Good Unsupported Unsupported Comprehensive Comprehensive Comprehensive New Caledonia New Zealand NCL NC Good Good Unsupported NZL NZ Comprehensive Comprehensive Comprehensive Nicaragua NIC Niger NER Nigeria NGA NIU NFK Niue Norfolk Island North Korea North Macedonia NI NE NG NU NF Good Good Good Good Unsupported Unsupported Comprehensive Comprehensive Unsupported Fair Fair Unsupported Comprehensive Comprehensive Unsupported PRK KP Fair Fair Unsupported MKD MK Comprehensive Comprehensive Good Country/area data quality 21 Amazon Location Service Developer Guide ISO A3 ISO A2 Route coverage Place Address coverage Place POI coverage MNP MP Good Good Unsupported Country/ Area Northern Mariana Islands Norway NOR Oman OMN Pakistan PAK Palau PLW Panama PAN PNG Papua New Guinea Paraguay PRY Peru Philippin es PER PHL Pitcairn PCN Poland POL Portugal PRT Puerto Rico PRI Qatar QAT Reunion REU NO OM PK PW PA PG PY PE PH PN PL PT PR QA RE Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Fair Fair Good Fair Good Unsupported Unsupported Comprehensive Comprehensive Fair Good Good Unsupported Comprehensive Comprehensive Good Comprehensive Comprehensive Good Comprehensive Comprehensive Fair Fair Fair Unsupported Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Fair Comprehensive Comprehensive Fair Comprehensive Comprehensive Unsupported Country/area data quality 22 Amazon Location Service Developer Guide Country/ Area ISO A3 ISO A2 Route coverage Place Address coverage Place POI coverage Romania ROU Russia RUS Rwanda RWA Saint Barthélem BLM RO RU RW BL Comprehensive Comprehensive Good Comprehensive Comprehensive Good Good Good Good Comprehensive Comprehensive Unsupported SHN SH Good Good Unsupported KNA KN Good Good Unsupported LCA LC Fair MAF MF Fair SPM PM Fair Fair Fair Fair Unsupported Unsupported Unsupported VCT VC Good Good Unsupported y Saint Helena Saint Kitts And Nevis Saint Lucia Saint Martin Saint Pierre And Miquelon Saint Vincent And The Grenadine s Samoa WSM WS Fair Fair Unsupported Country/area data quality 23 Amazon Location Service Developer Guide Country/ Area San Marino Sao Tome And Principe Saudi Arabia ISO A3 ISO A2 Route coverage Place Address coverage Place POI coverage SMR SM Comprehensive Comprehensive Comprehensive STP ST Good Good Unsupported SAU SA Comprehensive Comprehensive Fair Senegal SEN Serbia SRB Seychelle s SYC SN RS SC Comprehensive Comprehensive Unsupported Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Unsupported Sierra Leone SLE SL Good Good Unsupported Singapore SGP BES Sint Eustatius , Saba, Bonaire Sint Maarten SXM Slovakia SVK Slovenia SVN Solomon Islands SLB SG BQ SX SK SI SB Comprehensive Comprehensive Comprehensive Fair Fair Unsupported Fair Fair Unsupported Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Fair Fair Unsupported Country/area data quality 24 Amazon Location Service Developer Guide Country/ Area ISO A3 ISO A2 Route coverage Place Address coverage Place POI coverage Somalia SOM ZAF SO ZA Good Good Unsupported Comprehensive Comprehensive Comprehensive KOR KR Fair Fair N/A SSD SS Good Good Unsupported South Africa South Korea South Sudan Spain ESP Sri Lanka LKA Sudan SDN Suriname SUR SJM Svalbard and Jan Mayen Islands Sweden SWE Switzerla nd CHE Syria SYR Taiwan TWN Tajikistan TJK Tanzania TZA Thailand THA ES LK SD SR SJ SE CH SY TW TJ TZ TH Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Unsupported Good Good Good Good Unsupported Unsupported Comprehensive Comprehensive Unsupported Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Good Good Unsupported Comprehensive Comprehensive Good Fair Fair Unsupported Comprehensive Comprehensive Unsupported Comprehensive Comprehensive Fair Country/area data quality 25 Amazon Location Service Developer Guide Country/ Area Timor- Leste ISO A3 ISO A2 Route coverage Place Address coverage Place POI coverage TLS TL Good Good Unsupported Togo TGO Tokelau TKL Tonga TON TTO Trinidad And Tobago Tunisia TUN Turkey TUR Turkmenis tan TKM TG TK TO TT TN TR TM Good Fair Good Good Good Fair Good Good Unsupported Unsupported |
amazon-location-developer-guide-009 | amazon-location-developer-guide.pdf | 9 | Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Unsupported Good Good Good Good Unsupported Unsupported Comprehensive Comprehensive Unsupported Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Good Good Unsupported Comprehensive Comprehensive Good Fair Fair Unsupported Comprehensive Comprehensive Unsupported Comprehensive Comprehensive Fair Country/area data quality 25 Amazon Location Service Developer Guide Country/ Area Timor- Leste ISO A3 ISO A2 Route coverage Place Address coverage Place POI coverage TLS TL Good Good Unsupported Togo TGO Tokelau TKL Tonga TON TTO Trinidad And Tobago Tunisia TUN Turkey TUR Turkmenis tan TKM TG TK TO TT TN TR TM Good Fair Good Good Good Fair Good Good Unsupported Unsupported Unsupported Unsupported Comprehensive Comprehensive Unsupported Comprehensive Comprehensive Good Fair Fair Fair Unsupported Unsupported TCA TC Fair Turks And Caicos Islands TV UG UA AE Fair Fair Unsupported Comprehensive Comprehensive Unsupported Comprehensive Comprehensive Good Comprehensive Comprehensive Fair Tuvalu TUV Uganda UGA Ukraine UKR ARE United Arab Emirates United Kingdom GBR GB Comprehensive Comprehensive Comprehensive Country/area data quality 26 Amazon Location Service Developer Guide ISO A3 ISO A2 Route coverage Place Address coverage Place POI coverage USA US Comprehensive Comprehensive Comprehensive Country/ Area United States of America Uruguay URY US Virgin Islands VIR UY VI Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Fair Uzbekista n UZB UZ Good Good Unsupported VU VA VE VN WF Good Good Unsupported Comprehensive Comprehensive Comprehensive Comprehensive Comprehensive Fair Comprehensive Comprehensive Comprehensive Good Good Unsupported Vanuatu VUT Vatican City VAT Venezuela VEN Vietnam VNM WLF Wallis And Futuna Islands Western Sahara ESH EH Comprehensive Comprehensive Unsupported Yemen YEM Zambia ZMB Zimbabwe ZWE YE ZM ZW Good Good Unsupported Comprehensive Comprehensive Unsupported Comprehensive Comprehensive Unsupported Country/area data quality 27 Amazon Location Service Developer Guide Get started with Amazon Location Service This topic helps you get started with Amazon Location Service. Follow these steps to create your first application and understand how to choose the appropriate Amazon Location API based on common use cases. 1. Set up your AWS account and access. If you don’t already have an account, you'll be prompted to create one. With the AWS free tier, you can get three months of free tier for Amazon Location Service. If you already have an account, you need to provide access to Amazon Location Service. Continue with the the section called “Set up an account for the first time” topic. 2. Understand and set up authentication. To use Amazon Location, a user must be granted access to the resources and APIs that make up Amazon Location. API Key, Amazon Cognito, and AWS Identity and Access Management (IAM) are three options to grant access to your resources and actions (APIs). Continue with the Authentication topic. 3. Create your first location application. See the section called “Create your first Maps and Places application” to build your first "Hello World" application. 4. Choose the right API. Amazon Location offers a rich set of APIs across Places, Routes, Maps, and Geofences and Trackers to solve a variety of business use cases. To learn more about how to choose an Amazon Location API, see the section called “Choose an API” for more information. Set up your account This section describes what you need to do to use Amazon Location Service. You must have an AWS account and have set up access to Amazon Location for users that want to use it. Set up an account for the first time 28 Amazon Location Service I'm new to AWS Sign up for an AWS account Developer Guide If you do not have an AWS account, complete the following steps to create one. To sign up for an AWS account 1. Open https://portal.aws.amazon.com/billing/signup. 2. Follow the online instructions. Part of the sign-up procedure involves receiving a phone call and entering a verification code on the phone keypad. When you sign up for an AWS account, an AWS account root user is created. The root user has access to all AWS services and resources in the account. As a security best practice, assign administrative access to a user, and use only the root user to perform tasks that require root user access. AWS sends you a confirmation email after the sign-up process is complete. At any time, you can view your current account activity and manage your account by going to https://aws.amazon.com/ and choosing My Account. Create a user with administrative access After you sign up for an AWS account, secure your AWS account root user, enable AWS IAM Identity Center, and create an administrative user so that you don't use the root user for everyday tasks. Secure your AWS account root user 1. Sign in to the AWS Management Console as the account owner by choosing Root user and entering your AWS account email address. On the next page, enter your password. For help signing in by using root user, see Signing in as the root user |
amazon-location-developer-guide-010 | amazon-location-developer-guide.pdf | 10 | by going to https://aws.amazon.com/ and choosing My Account. Create a user with administrative access After you sign up for an AWS account, secure your AWS account root user, enable AWS IAM Identity Center, and create an administrative user so that you don't use the root user for everyday tasks. Secure your AWS account root user 1. Sign in to the AWS Management Console as the account owner by choosing Root user and entering your AWS account email address. On the next page, enter your password. For help signing in by using root user, see Signing in as the root user in the AWS Sign-In User Guide. 2. Turn on multi-factor authentication (MFA) for your root user. For instructions, see Enable a virtual MFA device for your AWS account root user (console) in the IAM User Guide. Set up an account for the first time 29 Amazon Location Service Developer Guide Create a user with administrative access 1. Enable IAM Identity Center. For instructions, see Enabling AWS IAM Identity Center in the AWS IAM Identity Center User Guide. 2. In IAM Identity Center, grant administrative access to a user. For a tutorial about using the IAM Identity Center directory as your identity source, see Configure user access with the default IAM Identity Center directory in the AWS IAM Identity Center User Guide. Sign in as the user with administrative access • To sign in with your IAM Identity Center user, use the sign-in URL that was sent to your email address when you created the IAM Identity Center user. For help signing in using an IAM Identity Center user, see Signing in to the AWS access portal in the AWS Sign-In User Guide. Assign access to additional users 1. In IAM Identity Center, create a permission set that follows the best practice of applying least- privilege permissions. For instructions, see Create a permission set in the AWS IAM Identity Center User Guide. 2. Assign users to a group, and then assign single sign-on access to the group. For instructions, see Add groups in the AWS IAM Identity Center User Guide. I already have an AWS account Grant access to Amazon Location Service Your non-admin users have no permissions by default. Before they can access Amazon Location, you must grant permission by attaching an IAM policy with specific permissions. Make sure to follow the principle of least privilege when granting access to resources. Set up an account for the first time 30 Amazon Location Service Developer Guide Note For information about giving unauthenticated users access to Amazon Location Service functionality (for example, in a web-based application), see Authentication. The following example policy gives a user permission to access all Amazon Location operations. For more examples, see the section called “Identity-based policy examples”. { "Version": "2012-10-17", "Statement": [ { "Action": [ "geo:*" "geo-maps:*" "geo-places:*" "geo-routes:*" ], "Resource": "*", "Effect": "Allow" } ] } To provide access, add permissions to your users, groups, or roles: • Users and groups in AWS IAM Identity Center: Create a permission set. Follow the instructions in Create a permission set in the AWS IAM Identity Center User Guide. • Users managed in IAM through an identity provider: Create a role for identity federation. Follow the instructions in Create a role for a third-party identity provider (federation) in the IAM User Guide. • IAM users: • Create a role that your user can assume. Follow the instructions in Create a role for an IAM user in the IAM User Guide. Set up an account for the first time 31 Amazon Location Service Developer Guide • (Not recommended) Attach a policy directly to a user or add a user to a user group. Follow the instructions in Adding permissions to a user (console) in the IAM User Guide. When creating applications that use Amazon Location Service, you may need some users to have unauthenticated access. For these use cases, see Enabling unauthenticated access using Amazon Cognito. Use the Amazon Location Service console to authenticate Note To learn more about authentication, see Authentication. To use Amazon Location Service, a user must be granted access to the resources and APIs that make up Amazon Location. By default, the Amazon Location APIs require authentication to use. You can use either Amazon Cognito or API keys to provide authentication and authorization for anonymous users. In the the section called “Create your first Maps and Places application” tutorial, the application has anonymous usage, which means your users aren't required to sign in. In the tutorial, you create API keys for use in the sample application. Follow the procedures below to create your first API key. 1. In the Amazon Location console and choose API keys from the left menu. 2. On the API keys page, choose Create API key. 3. On the Create API key |
amazon-location-developer-guide-011 | amazon-location-developer-guide.pdf | 11 | authentication to use. You can use either Amazon Cognito or API keys to provide authentication and authorization for anonymous users. In the the section called “Create your first Maps and Places application” tutorial, the application has anonymous usage, which means your users aren't required to sign in. In the tutorial, you create API keys for use in the sample application. Follow the procedures below to create your first API key. 1. In the Amazon Location console and choose API keys from the left menu. 2. On the API keys page, choose Create API key. 3. On the Create API key page, fill in the following information: • Name – A name for your API key, such as MyHelloWorldApp. • Description – An optional description for your API key. • Actions – Specify the actions you want to authorize with this API key. You must select at least geo-maps:Get* and geo-places:Search*. • Expiration time – Optionally, add an expiration date and time for your API key. For more information, see the section called “Best practices”. Set up authentication for the first time 32 Amazon Location Service Developer Guide • Referers – Optionally, add one or more domains where you can use the API key. For example, if the API key is to allow an application running on the website example.com, then you could put *.example.com/ as an allowed referrer. • Tags – Optionally, add tags to the API key. Important We recommend that you protect your API key usage by setting either an expiration time or a referrer, if not both. 4. Choose Create API key to create the API key. 5. On the detail page for the API key, you can see information about the API key that you have created. Choose Show API key and copy the key value to use later in the the section called “Create your first Maps and Places application” tutorial. The key value will have the format v1.public.a1b2c3d4.... Choose the right API This topic helps you choose an Amazon Location Service API based on common use cases that you may want to solve with location-based data and services. Maps Maps provide access to both dynamic and static map types for a variety of applications. For more information, See Maps. • Dynamic Maps: Interactive maps that can be customized in real time, allowing users to pan, zoom, and overlay data. For more information, See the section called “Dynamic maps”. • Static Maps: Static images of maps that display specific locations or routes without interactive elements, suitable for applications with limited interactivity. For more information, See the section called “Static maps”. Routes Routes provide capabilities for calculating optimized paths between locations. These features support applications requiring logistics planning, distance calculations, and route optimization. Choose an API 33 Amazon Location Service Developer Guide Users can also snap location points to roads for improved accuracy. For more information, See Routes. • CalculateIsolines: Generates isolines based on travel time or distance, useful for defining service areas or reachability zones. For more information, See the section called “Calculate isolines”. • CalculateRouteMatrix: Provides a matrix of distances and travel times between multiple origins and destinations, supporting logistics and trip planning. For more information, See the section called “Calculate route matrix”. • CalculateRoutes: Calculates optimized routes for point-to-point or multi-stop navigation, including customizable routing preferences. For more information, See the section called “Calculate routes”. • OptimizeWaypoints: Optimizes the order of waypoints for the most efficient travel route, minimizing distance or time. For more information, See the section called “Optimize waypoints”. • SnapToRoads: Aligns coordinates to the nearest road paths, enhancing GPS accuracy by snapping points to known roads. For more information, See the section called “Snap to Roads”. Places Places enable applications to search, find, and retrieve details about points of interest, addresses, and specific locations. These capabilities enhance location-based services by providing context and improving user experience in search functions. For more information, See Places. • Geocode: Converts addresses or place names into geographic coordinates (longitude, latitude), supporting applications that require address-to-location transformation for mapping and spatial analysis. For more information, see the section called “Reverse Geocode”. • Reverse Geocode: Converts geographic coordinates to the nearest address or place name, providing context for a location. For more information, See the section called “Reverse Geocode”. • Autocomplete: Suggests potential completions for user-entered text, improving efficiency in search input. For more information, See the section called “Autocomplete”. • GetPlace: Retrieves detailed information about a specified place, including attributes like address, contact details, and opening hours. For more information, See the section called “GetPlace”. Choose an API 34 Amazon Location Service Developer Guide • SearchNearby: Finds places within a specified radius of a given geographic point, suitable for "near me" searches. For more information, See the section called “Search Nearby”. • SearchText: Allows text-based |
amazon-location-developer-guide-012 | amazon-location-developer-guide.pdf | 12 | context for a location. For more information, See the section called “Reverse Geocode”. • Autocomplete: Suggests potential completions for user-entered text, improving efficiency in search input. For more information, See the section called “Autocomplete”. • GetPlace: Retrieves detailed information about a specified place, including attributes like address, contact details, and opening hours. For more information, See the section called “GetPlace”. Choose an API 34 Amazon Location Service Developer Guide • SearchNearby: Finds places within a specified radius of a given geographic point, suitable for "near me" searches. For more information, See the section called “Search Nearby”. • SearchText: Allows text-based searching for places or points of interest based on a keyword or phrase, ideal for finding locations by name or description. For more information, See the section called “Search Text”. • Suggest: Provides search term suggestions as users type, enhancing search relevance and user experience. For more information, See the section called “Suggest”. Geofences Geofencing allows applications to define geographical boundaries and monitor entry or exit events within these regions. Features include creating, updating, and deleting geofences, as well as configuring notifications or triggers for location-based actions when tracked devices cross geofence boundaries. Ideal for proximity-based notifications, security monitoring, and asset tracking within predefined areas. For more information, See Geofences. Trackers Tracking enables real-time monitoring of device or asset locations over time. Features include adding tracked devices, updating their location data, and retrieving historical position data. Trackers are useful for managing fleets, monitoring personnel, and ensuring the security of valuable assets by providing up-to-date location data and movement patterns. For more information, See Trackers. Create your first Amazon Location Maps and Places application In this section, you will create your first application with Maps and Places. Prerequisite: If you already created an API key in the the section called “Set up authentication for the first time” steps, let's get started. If you haven't created an API key yet, follow the section called “Set up authentication for the first time” before continuing to build the application. If you have any questions, see the section called “Use API keys” and the section called “Supported regions” for more information. Create your first Maps and Places application 35 Amazon Location Service Web Developer Guide Here’s a step-by-step tutorial for creating an Amazon Location Service map application with MapLibre GL JS. This guide will walk you through setting up the map, adding styling options, and enabling place search functionality. Set up the initial page In this section, we will set up the initial page and folder structure. Add required libraries and stylesheets Create an index.html file. To render the map, you need MapLibre GL JS and MapLibre GL Geocoder. You will add the MapLibre and Geocoder stylesheets and JavaScript scripts. Copy and paste the following code into your index.html file. <!DOCTYPE html> <html lang="en"> <head> <title>Amazon Location Service - Getting Started with First Map App</title> <meta charset='utf-8'> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="description" content="Interactive map application using Amazon Location Service"> <!--Link to MapLibre CSS and JavaScript library for map rendering and visualization --> <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/maplibre-gl@4.7.1/dist/ maplibre-gl.css" /> <script src="https://cdn.jsdelivr.net/npm/maplibre-gl@4.7.1/dist/maplibre-gl.js"></ script> <!--Link to MapLibre Geocoder CSS and JavaScript library for place search and geocoding --> <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@maplibre/maplibre-gl- geocoder@1.7.0/dist/maplibre-gl-geocoder.css" /> <script src="https://cdn.jsdelivr.net/npm/@maplibre/maplibre-gl-geocoder@1.7.0/ dist/maplibre-gl-geocoder.js"></script> <!--Link to amazon-location JavaScript librarie --> <script src="https://cdn.jsdelivr.net/npm/@aws/amazon-location-utilities-auth- helper@1"></script> Create your first Maps and Places application 36 Amazon Location Service Developer Guide <script src="https://cdn.jsdelivr.net/npm/@aws/amazon-location-client@1.2"></ script> <!-- Link to the first Amazon Location Map App's CSS and JavaScript --> <script src="utils.js"></script> <link rel="stylesheet" href="style.css"/> </head> <body> <main> </main> <script> // Step 1: Setup API Key and AWS Region // Step 2.1 Add maps to application // Step 2.2 initialize the map // Step 3: Add places features to application // Step 3.1: Get GeoPlaces instance. It will be used for addion search box and map click functionality // Step 3.2: Add search box to the map // Step 3.3.: Setup map click functionality // Add functions </script> </body> </html> Create the Map container Under the <body> element of the HTML file, create a <div> element in your HTML to hold the map. You can style this <div> in your CSS to set dimensions as needed for your application. You must download the CSS file, style.css, from our GitHub repository. This will help you focus on business logic. Save the style.css and index.html files in the same folder. Download the style.css file from GitHub. <main role="main" aria-label="Map Container"> <div id="map"></div> </main> Create your first Maps and Places application 37 Amazon Location Service Developer Guide Add API key and AWS Region details Add the API key you created in the section called “Use API keys” to this file, along with the AWS Region where the key was created. <!DOCTYPE html> <html lang="en"> ..... ..... <body> <main role="main" aria-label="Map Container"> <div id="map"></div> </main> <script> // Step |
amazon-location-developer-guide-013 | amazon-location-developer-guide.pdf | 13 | file, style.css, from our GitHub repository. This will help you focus on business logic. Save the style.css and index.html files in the same folder. Download the style.css file from GitHub. <main role="main" aria-label="Map Container"> <div id="map"></div> </main> Create your first Maps and Places application 37 Amazon Location Service Developer Guide Add API key and AWS Region details Add the API key you created in the section called “Use API keys” to this file, along with the AWS Region where the key was created. <!DOCTYPE html> <html lang="en"> ..... ..... <body> <main role="main" aria-label="Map Container"> <div id="map"></div> </main> <script> // Step 1: Setup API Key and AWS Region const API_KEY = "Your_API_Key"; const AWS_REGION = "Region_where_you_created_API_Key"; // Step 2: Add maps to application // Step 2.1 initialize the map // Step 2.2 Add navigation controls to the map // Step 3: Add places feature to application // Step 3.1: Get GeoPlaces instance. It will be used for addion search box and map click functionality // Step 3.2: Add search box to the map // Step 3.3.: Setup map click functionality </script> </body> </html> Add Map to your application In this section, we will add Map capabilities to the application. Before you start, your files should be in this folder structure. If have not already done so, please download the style.css file from GitHub. |---FirstApp [Folder] |-------------- index.html [File] |-------------- style.css [File] Create your first Maps and Places application 38 Amazon Location Service Developer Guide Create a Function to Initialize the Map To set up your map, create the following function, initializeMap(...), after the line //Add functions. Choose an initial center location and zoom level. In this example, we set the map center to Vancouver, Canada, with a zoom level of 10. Add navigation controls for easy zooming. /** * Initializes the map with the specified style and color scheme. */ function initializeMap(mapStyle = "Standard", colorScheme = "Dark") { const styleUrl = `https://maps.geo.${AWS_REGION}.amazonaws.com/v2/styles/ ${mapStyle}/descriptor?key=${API_KEY}&color-scheme=${colorScheme}`; const map = new maplibregl.Map({ container: 'map', // The ID of the map container style: styleUrl, // The style URL for the map center: [-123.116226, 49.246292], // Starting center coordinates zoom: 10, // Initial zoom level validateStyle: false // Disable style validation }); return map; // Return the initialized map } Initialize the Map Call initializeMap(...) to initialize the map. Optionally, you can initialize it with your preferred style and color scheme after the initializeMap function. For more style options, see the section called “Map styles”. // Step 1: Setup API Key and AWS Region const API_KEY = "Your_API_Key"; const AWS_REGION = "Region_where_you_created_API_Key"; // Step 2.1 Add maps to application // Step 2.2 initialize the map const map = initializeMap("Standard","Light"); // Step 3: Add places features to application Create your first Maps and Places application 39 Amazon Location Service Developer Guide Open index.html in a browser to see the map in action. Add Navigation Control Optionally, you can add navigation controls (zoom and rotation) to the map. This should be done after calling initializeMap(...). // Step 2.1 initialize the map const map = initializeMap("Standard","Light"); // Step 2.2 Add navigation controls to the map map.addControl(new maplibregl.NavigationControl()); // Step 3: Add places features to application Review the Map Code Congratulations! Your first app is ready to use a map. Open index.html in a browser. Make sure style.css is in the same folder as index.html. Your final HTML should look like this: <!DOCTYPE html> <html lang="en"> <head> <title>Amazon Location Service - Getting Started with First Map App</title> <meta charset='utf-8'> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="description" content="Interactive map application using Amazon Location Service"> <!-- Link to MapLibre CSS and JavaScript library for map rendering and visualization --> <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/maplibre-gl@4.7.1/ dist/maplibre-gl.css" /> <script src="https://cdn.jsdelivr.net/npm/maplibre-gl@4.7.1/dist/maplibre- gl.js"></script> Create your first Maps and Places application 40 Amazon Location Service Developer Guide <!-- Link to MapLibre Geocoder CSS and JavaScript library for place search and geocoding --> <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@maplibre/ maplibre-gl-geocoder@1.7.0/dist/maplibre-gl-geocoder.css" /> <script src="https://cdn.jsdelivr.net/npm/@maplibre/maplibre-gl- geocoder@1.7.0/dist/maplibre-gl-geocoder.js"></script> <!-- Link to amazon-location JavaScript library --> <script src="https://cdn.jsdelivr.net/npm/@aws/amazon-location-utilities- auth-helper@1"></script> <script src="https://cdn.jsdelivr.net/npm/@aws/amazon-location- client@1.2"></script> <!-- Link to the first Amazon Location Map App's CSS and JavaScript --> <script src="utils.js"></script> <link rel="stylesheet" href="style.css"/> </head> <body> <main role="main" aria-label="Map Container"> <div id="map"></div> </main> <script> const API_KEY = "Your_API_Key"; const AWS_REGION = "Region_where_you_created_API_Key"; function initializeMap(mapStyle, colorScheme) { const styleUrl = `https://maps.geo.${AWS_REGION}.amazonaws.com/v2/ styles/${mapStyle}/descriptor?key=${API_KEY}&color-scheme=${colorScheme}`; const map = new maplibregl.Map({ container: 'map', // ID of the HTML element for the map style: styleUrl, // URL for the map style center: [-123.116226, 49.246292], // Initial map center [longitude, latitude] zoom: 10 // Initial zoom level }); map.addControl(new maplibregl.NavigationControl()); return map; } const map = initializeMap("Standard", "Light"); Create your first Maps and Places application 41 Amazon Location Service Developer Guide </script> </body> </html> Add Places to your application In this section, we will set up add places capabilities to the application. Download the JavaScript file from GitHub, utils.js. Before you |
amazon-location-developer-guide-014 | amazon-location-developer-guide.pdf | 14 | colorScheme) { const styleUrl = `https://maps.geo.${AWS_REGION}.amazonaws.com/v2/ styles/${mapStyle}/descriptor?key=${API_KEY}&color-scheme=${colorScheme}`; const map = new maplibregl.Map({ container: 'map', // ID of the HTML element for the map style: styleUrl, // URL for the map style center: [-123.116226, 49.246292], // Initial map center [longitude, latitude] zoom: 10 // Initial zoom level }); map.addControl(new maplibregl.NavigationControl()); return map; } const map = initializeMap("Standard", "Light"); Create your first Maps and Places application 41 Amazon Location Service Developer Guide </script> </body> </html> Add Places to your application In this section, we will set up add places capabilities to the application. Download the JavaScript file from GitHub, utils.js. Before you start, your files should be in this folder structure: |---FirstApp [Folder] |-------------- index.html [File] |-------------- style.css [File] |-------------- utils.js [File] Create Function to Create GeoPlaces To add search functionality, initialize the GeoPlaces class using AuthHelper and AmazonLocationClient. Add the following getGeoPlaces(map) function before the </ script> tag in index.html. /** * Gets a GeoPlaces instance for Places operations. */ function getGeoPlaces(map) { const authHelper = amazonLocationClient.withAPIKey(API_KEY, AWS_REGION); // Authenticate using the API key and AWS region const locationClient = new amazonLocationClient.GeoPlacesClient(authHelper.getClientConfig()); // Create a GeoPlaces client const geoPlaces = new GeoPlaces(locationClient, map); // Create GeoPlaces instance return geoPlaces; // Return the GeoPlaces instance } Create your first Maps and Places application 42 Amazon Location Service Developer Guide Create Function to Add Search Box to the Application Add the following addSearchBox(map, geoPlaces), renderPopup(feature), and createPopup(feature) functions before the </script> tag in index.html to complete the search functionality setup. /** * Adds search box to the map. */ function addSearchBox(map, geoPlaces) { const searchBox = new MaplibreGeocoder(geoPlaces, { maplibregl, showResultsWhileTyping: true, // Show results while typing debounceSearch: 300, // Debounce search requests limit: 30, // Limit number of results popuprender: renderPopup, // Function to render popup reverseGeocode: true, // Enable reverse geocoding zoom: 14, // Zoom level on result selection placeholder: "Search text or nearby (lat,long)" // Placeholder text for search box. }); // Add the search box to the map map.addControl(searchBox, 'top-left'); // Event listener for when a search result is selected searchBox.on('result', async (event) => { const { id, result_type } = event.result; // Get result ID and type if (result_type === "Place") { // Check if the result is a place const placeResults = await geoPlaces.searchByPlaceId(id); // Fetch details for the selected place if (placeResults.features.length) { createPopup(placeResults.features[0]).addTo(map); // Create and add popup for the place Create your first Maps and Places application 43 Amazon Location Service } } }); } /** Developer Guide * Renders the popup content for a given feature. */ function renderPopup(feature) { return ` <div class="popup-content"> <span class="${feature.place_type.toLowerCase()} badge"> ${feature.place_type}</span><br> ${feature.place_name} </div>`; } /** * Creates a popup for a given feature and sets its position. */ function createPopup(feature) { return new maplibregl.Popup({ offset: 30 }) // Create a new popup .setLngLat(feature.geometry.coordinates) // Set the popup position .setHTML(renderPopup(feature)); // Set the popup content } Add Search Box to the Application Create a GeoPlaces object by calling getGeoPlaces(map) as defined in Section 3.1 and then call addSearchBox(map, geoPlaces) to add the search box to the application. // Step 2: Add maps to application // Step 2.1 initialize the map const map = initializeMap("Standard","Light"); // Step 2.2 Add navigation controls to the map map.addControl(new maplibregl.NavigationControl()); // Step 3: Add places feature to application // Step 3.1: Get GeoPlaces instance. It will be used for adding search box and map click functionality const geoPlaces = getGeoPlaces(map); Create your first Maps and Places application 44 Amazon Location Service Developer Guide // Step 3.2: Add search box to the map addSearchBox(map, geoPlaces); Your place search is ready to use. Open index.html in a browser to see it in action. Add Function to Show Popup on User Click on the Map Create a function addMapClick(map, geoPlaces) to display a popup when the user clicks on the map. Add this function just before the </script> tag. /** * Sets up reverse geocoding on map click events. */ function addMapClick(map, geoPlaces) { map.on('click', async ({ lngLat }) => { // Listen for click events on the map const response = await geoPlaces.reverseGeocode({ query: [lngLat.lng, lngLat.lat], limit: 1, click: true }); // Perform reverse geocoding if (response.features.length) { // If there are results const clickMarker = new maplibregl.Marker({ color: "orange" }); // Create a marker const feature = response.features[0]; // Get the clicked feature const clickedPopup = createPopup(feature); // Create popup for the clicked feature clickMarker.setLngLat(feature.geometry.coordinates) // Set marker position .setPopup(clickedPopup) // Attach popup to marker .addTo(map); // Add marker to the map clickedPopup.on('close', () => clickMarker.remove()).addTo(map); // Remove marker when popup is closed } }); } Create your first Maps and Places application 45 Amazon Location Service Developer Guide Call Function to Add Map Click Feature To enable the map click action, call addMapClick(map, geoPlaces) after the line containing addSearchBox(map, geoPlaces). // Step |
amazon-location-developer-guide-015 | amazon-location-developer-guide.pdf | 15 | clickMarker = new maplibregl.Marker({ color: "orange" }); // Create a marker const feature = response.features[0]; // Get the clicked feature const clickedPopup = createPopup(feature); // Create popup for the clicked feature clickMarker.setLngLat(feature.geometry.coordinates) // Set marker position .setPopup(clickedPopup) // Attach popup to marker .addTo(map); // Add marker to the map clickedPopup.on('close', () => clickMarker.remove()).addTo(map); // Remove marker when popup is closed } }); } Create your first Maps and Places application 45 Amazon Location Service Developer Guide Call Function to Add Map Click Feature To enable the map click action, call addMapClick(map, geoPlaces) after the line containing addSearchBox(map, geoPlaces). // Step 3: Add places feature to application // Step 3.1: Get GeoPlaces instance. It will be used for adding search box and map click functionality const geoPlaces = getGeoPlaces(map); // Step 3.2: Add search box to the map addSearchBox(map, geoPlaces); // Step 3.3: Setup map click functionality addMapClick(map, geoPlaces); Review Maps and Places application Congratulations! Your first application is ready to use Maps and Places. Open index.html in a browser. Make sure style.css and utils.js are in the same folder with index.html. Your final HTML should look like this: <!DOCTYPE html> <html lang="en"> <head> <title>Amazon Location Service - Getting Started with First Map App</title> <meta charset='utf-8'> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="description" content="Interactive map application using Amazon Location Service"> <!--Link to MapLibre CSS and JavaScript library for map rendering and visualization --> <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/maplibre-gl@4.7.1/dist/ maplibre-gl.css" /> <script src="https://cdn.jsdelivr.net/npm/maplibre-gl@4.7.1/dist/maplibre-gl.js"></ script> <!--Link to MapLibre Geocoder CSS and JavaScript library for place search and geocoding --> Create your first Maps and Places application 46 Amazon Location Service Developer Guide <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@maplibre/maplibre-gl- geocoder@1.7.0/dist/maplibre-gl-geocoder.css" /> <script src="https://cdn.jsdelivr.net/npm/@maplibre/maplibre-gl-geocoder@1.7.0/ dist/maplibre-gl-geocoder.js"></script> <!--Link to amazon-location JavaScript librarie --> <script src="https://cdn.jsdelivr.net/npm/@aws/amazon-location-utilities-auth- helper@1"></script> <script src="https://cdn.jsdelivr.net/npm/@aws/amazon-location-client@1.2"></ script> <!-- Link to the first Amazon Location Map App's CSS and JavaScript --> <script src="utils.js"></script> <link rel="stylesheet" href="style.css"/> </head> <body> <main role="main" aria-label="Map Container"> <div id="map"></div> </main> <script> // Step 1: Setup API Key and AWS Region const API_KEY = "Your_API_Key"; const AWS_REGION = "Region_where_you_created_API_Key"; // Step 2: Add maps to application // Step 2.1 initialize the map const map = initializeMap("Standard","Light"); // Step 2.2 Add navigation controls to the map map.addControl(new maplibregl.NavigationControl()); // Step 3: Add places feature to application // Step 3.1: Get GeoPlaces instance. It will be used for addion search box and map click functionality const geoPlaces = getGeoPlaces(map); // Step 3.2: Add search box to the map addSearchBox(map, geoPlaces); // Step 3.3.: Setup map click functionality addMapClick(map, geoPlaces); Create your first Maps and Places application 47 Amazon Location Service /** * Functions to add maps and places feature. */ Developer Guide /** * Initializes the map with the specified style and color scheme. */ function initializeMap(mapStyle = "Standard", colorScheme = "Dark") { const styleUrl = `https://maps.geo.${AWS_REGION}.amazonaws.com/v2/styles/ ${mapStyle}/descriptor?key=${API_KEY}&color-scheme=${colorScheme}`; const map = new maplibregl.Map({ container: 'map', // The ID of the map container style: styleUrl, // The style URL for the map center: [-123.116226, 49.246292], // Starting center coordinates zoom: 10, // Initial zoom level validateStyle: false // Disable style validation }); return map; // Return the initialized map } /** * Gets a GeoPlaces instance for Places operations. */ function getGeoPlaces(map) { const authHelper = amazonLocationClient.withAPIKey(API_KEY, AWS_REGION); // Authenticate using the API key and AWS region const locationClient = new amazonLocationClient.GeoPlacesClient(authHelper.getClientConfig()); // Create a GeoPlaces client const geoPlaces = new GeoPlaces(locationClient, map); // Create GeoPlaces instance return geoPlaces; // Return the GeoPlaces instance } /** * Adds search box to the map. */ function addSearchBox(map, geoPlaces) { const searchBox = new MaplibreGeocoder(geoPlaces, { maplibregl, showResultsWhileTyping: true, // Show results while typing Create your first Maps and Places application 48 Amazon Location Service Developer Guide debounceSearch: 300, // Debounce search requests limit: 30, // Limit number of results popuprender: renderPopup, // Function to render popup reverseGeocode: true, // Enable reverse geocoding zoom: 14, // Zoom level on result selection placeholder: "Search text or nearby (lat,long)" // Place holder text for search box. }); // Add the search box to the map map.addControl(searchBox, 'top-left'); // Event listener for when a search result is selected searchBox.on('result', async (event) => { const { id, result_type } = event.result; // Get result ID and type if (result_type === "Place") { // Check if the result is a place const placeResults = await geoPlaces.searchByPlaceId(id); // Fetch details for the selected place if (placeResults.features.length) { createPopup(placeResults.features[0]).addTo(map); // Create and add popup for the place } } }); } /** * Renders the popup content for a given feature. */ function renderPopup(feature) { return ` <div class="popup-content"> <span class="${feature.place_type.toLowerCase()} badge"> ${feature.place_type}</span><br> ${feature.place_name} </div>`; } Create your first Maps and Places application 49 Amazon Location Service Developer Guide /** * Creates a popup for a given feature and sets its position. */ function createPopup(feature) { return new maplibregl.Popup({ offset: 30 }) // Create a new popup .setLngLat(feature.geometry.coordinates) // Set |
amazon-location-developer-guide-016 | amazon-location-developer-guide.pdf | 16 | is a place const placeResults = await geoPlaces.searchByPlaceId(id); // Fetch details for the selected place if (placeResults.features.length) { createPopup(placeResults.features[0]).addTo(map); // Create and add popup for the place } } }); } /** * Renders the popup content for a given feature. */ function renderPopup(feature) { return ` <div class="popup-content"> <span class="${feature.place_type.toLowerCase()} badge"> ${feature.place_type}</span><br> ${feature.place_name} </div>`; } Create your first Maps and Places application 49 Amazon Location Service Developer Guide /** * Creates a popup for a given feature and sets its position. */ function createPopup(feature) { return new maplibregl.Popup({ offset: 30 }) // Create a new popup .setLngLat(feature.geometry.coordinates) // Set the popup position .setHTML(renderPopup(feature)); // Set the popup content } /** * Sets up reverse geocoding on map click events. */ function addMapClick(map, geoPlaces) { map.on('click', async ({ lngLat }) => { // Listen for click events on the map const response = await geoPlaces.reverseGeocode({ query: [lngLat.lng, lngLat.lat], limit: 1, click:true }); // Perform reverse geocoding if (response.features.length) { // If there are results const clickMarker = new maplibregl.Marker({ color: "orange" }); // Create a marker const feature = response.features[0]; // Get the clicked feature const clickedPopup = createPopup(feature); // Create popup for the clicked feature clickMarker.setLngLat(feature.geometry.coordinates) // Set marker position .setPopup(clickedPopup) // Attach popup to marker .addTo(map); // Add marker to the map clickedPopup.on('close', () => clickMarker.remove()).addTo(map); // Remove marker when popup is closed } }); } </script> </body> </html> Create your first Maps and Places application 50 Amazon Location Service Explore more Developer Guide You have completed the quick start tutorial, and should have an idea of how Amazon Location Service is used to build applications. To get more out of Amazon Location, you can check out the following resources: • Query suggestion details - Consider extending the GeoPlaces class or using a similar approach to ReverseGeocode to get more details about results returned by the Suggestion API. • Choose the right API for your business needs - To determine the best Amazon Location API for your requirements, check out this resource: the section called “Choose an API”. • Check out Amazon Location "how-to" guides - Visit the Amazon Location Service Developer Guide for tutorials and further resources. • Documentation and product information - For complete documentation, visit the Amazon Location Service Developer Guide . To learn more about the product, go to the Amazon Location Service Product page. Create your first Geofences and Trackers application In this section, you'll create an application that demonstrates the key features of using the Amazon Location Geofences and Trackers. The applications demonstrate how a tracker and geofence interact using a combination of Lambda, AWS IoT, and Amazon Location features. Choose iOS or Android platform to get started. Before you start to build your application, follow the procedures in the section called “Set up authentication for the first time” to grant appropriate access. Continue with the procedures for your preferred operating system: • Create an iOS application • Create an Android application Create an iOS application Follow these procedures to build an iOS application using Amazon Location Service. Clone the project files from GitHub. Create your first Geofences and Trackers application 51 Amazon Location Service Developer Guide Create Amazon Location resources for your app You can generate Amazon Location Service resources once your AWS account is ready. These resources will be essential for executing the provided code snippets. Note If you haven't created an AWS account yet, please create an AWS account. To begin you will need to create a Amazon Cognito Identity Pool Id, use the following procedure: 1. In the AWS console, navigate to the Amazon Cognito service and then select Identity pools from the left side menu and select Create Identity pool. 2. Make sure Guest Access is checked, and press Next to continue. 3. Next create a new IAM role or Use an existing IAM role. 4. Enter an Identity pool name, and make sure Identity Pool has access to Amazon Location (geo) resources for the map and tracker you will be creating in the next procedure. 5. Now you need to create and style a map in the AWS Amazon Location console, use the following procedure: 1. Navigate to the Maps section in the Amazon Location console and select Create Map to preview available map styles. 2. Give the new map resource a Name and Description. Record the name you assign to the map resource, as it is used later in the tutorial. 3. When choosing a map style, consider the map data provider. Refer to section 82 of the AWS service terms for more details. 4. Accept the Amazon Location Terms and Conditions, then select Create Map. After map has been created, you can interact with the map by zooming in, out, or panning in any direction. To create a tracker using the Amazon Location console |
amazon-location-developer-guide-017 | amazon-location-developer-guide.pdf | 17 | and select Create Map to preview available map styles. 2. Give the new map resource a Name and Description. Record the name you assign to the map resource, as it is used later in the tutorial. 3. When choosing a map style, consider the map data provider. Refer to section 82 of the AWS service terms for more details. 4. Accept the Amazon Location Terms and Conditions, then select Create Map. After map has been created, you can interact with the map by zooming in, out, or panning in any direction. To create a tracker using the Amazon Location console 1. Open the Amazon Location Service console. 2. In the left navigation pane, choose Trackers. iOS 52 Amazon Location Service 3. Choose Create tracker. 4. Fill in the all the required fields. Developer Guide 5. Under Position filtering, choose the option that best fits how you intend to use your tracker resource. If you do not set Position filtering, the default setting is TimeBased. For more information, see Trackers in this guide, and PositionFiltering in the Amazon Location Service Trackers API Reference. 6. Choose Create tracker to finish. Create a Geofence Collection When creating a geofence collection you can use either the console, API or CLI. The following procedures walk you through each option. Create a geofence collection using the Amazon Location console: 1. Open the Amazon Location Service console at https://console.aws.amazon.com/location/. 2. In the left navigation pane, choose Geofence Collections. 3. Choose Create geofence collection. 4. Provide a name and description for the collection. 5. Under EventBridge rule with CloudWatch as a target, you can create an optional EventBridge rule to get started reacting to geofence events. This enables Amazon Location to publish events to Amazon CloudWatch Logs. 6. Choose Create geofence collection. Create a geofence collection using the Amazon Location APIs: Use the CreateGeofenceCollection operation from the Amazon Location Geofences APIs. The following example uses an API request to create a geofence collection called GOECOLLECTION_NAME. POST /geofencing/v0/collections Content-type: application/json { "CollectionName": "GOECOLLECTION_NAME", "Description": "Geofence collection 1 for shopping center", "Tags": { "Tag1" : "Value1" iOS 53 Amazon Location Service } } Developer Guide Create a geofence collection using AWS CLI commands: Use the create-geofence-collection command. The following example uses an AWS CLI to create a geofence collection called GOECOLLECTION_NAME. aws location \ create-geofence-collection \ --collection-name "GOECOLLECTION_NAME" \ --description "Shopping center geofence collection" \ --tags Tag1=Value1 Link a tracker to a geofence collection To link a tracker to a geofence collection you can use either the console, API, or CLI. The following procedures walk you through each option. Link a tracker resource to a geofence collection using the Amazon Location Service console: 1. Open the Amazon Location console. 2. In the left navigation pane, choose Trackers. 3. Under Device Trackers, select the name link of the target tracker. 4. Under Linked Geofence Collections, choose Link Geofence Collection. 5. In the Linked Geofence Collection window, select a geofence collection from the dropdown menu. 6. Choose Link. 7. After you link the tracker resource, it will be assigned an Active status. Link a tracker resource to a geofence collection using the Amazon Location APIs: Use the AsssociateTrackerConsumer operation from the Amazon Location Trackers APIs. The following example uses an API request that associates ExampleTracker with a geofence collection using its Amazon Resource Name (ARN). POST /tracking/v0/trackers/ExampleTracker/consumers Content-type: application/json { iOS 54 Amazon Location Service Developer Guide "ConsumerArn": "arn:aws:geo:us-west-2:123456789012:geofence- collection/GOECOLLECTION_NAME" } Link a tracker resource to a geofence collection using AWS CLI commands: Use the associate-tracker-consumer command. The following example uses an AWS CLI to create a geofence collection called GOECOLLECTION_NAME. aws location \ associate-tracker-consumer \ --consumer-arn "arn:aws:geo:us-west-2:123456789012:geofence- collection/GOECOLLECTION_NAME" \ --tracker-name "ExampleTracker" Use AWS Lambda with MQTT Create a Lambda function: To create a connection between AWS IoT Core and Amazon Location Service, you need an AWS Lambda function to process messages forwarded by EventBridge CloudWatch events. This function will extract any positional data, format it for Amazon Location Service, and submit it through the Amazon Location Tracker API. You can create this function through the AWS Lambda console, or you can use the AWS Command Line Interface (AWS CLI) or the AWS Lambda APIs. To create a Lambda function that publishes position updates to Amazon Location using the console: 1. Open the AWS Lambda console at https://console.aws.amazon.com/lambda/. 2. From the left navigation, choose Functions. 3. Choose Create Function, and make sure that Author from scratch is selected. 4. Fill out the following boxes: • a Function name • for the Runtime option, choose Node.js 16.x. 5. Choose Create function. 6. Choose the Code tab to open the editor. 7. Overwrite the placeholder code in index.js with the following: const AWS = require('aws-sdk') const iot = new AWS.Iot(); iOS 55 Amazon Location Service Developer Guide exports.handler = function(event) { console.log("event===>>>", JSON.stringify(event)); var |
amazon-location-developer-guide-018 | amazon-location-developer-guide.pdf | 18 | position updates to Amazon Location using the console: 1. Open the AWS Lambda console at https://console.aws.amazon.com/lambda/. 2. From the left navigation, choose Functions. 3. Choose Create Function, and make sure that Author from scratch is selected. 4. Fill out the following boxes: • a Function name • for the Runtime option, choose Node.js 16.x. 5. Choose Create function. 6. Choose the Code tab to open the editor. 7. Overwrite the placeholder code in index.js with the following: const AWS = require('aws-sdk') const iot = new AWS.Iot(); iOS 55 Amazon Location Service Developer Guide exports.handler = function(event) { console.log("event===>>>", JSON.stringify(event)); var param = { endpointType: "iot:Data-ATS" }; iot.describeEndpoint(param, function(err, data) { if (err) { console.log("error===>>>", err, err.stack); // an error occurred } else { var endp = data['endpointAddress']; const iotdata = new AWS.IotData({endpoint: endp}); const trackerEvent = event["detail"]["EventType"]; const src = event["source"]; const time = event["time"]; const gfId = event["detail"]["GeofenceId"]; const resources = event["resources"][0]; const splitResources = resources.split("."); const geofenceCollection = splitResources[splitResources.length - 1]; const coordinates = event["detail"]["Position"]; const deviceId = event["detail"]["DeviceId"]; console.log("deviceId===>>>", deviceId); const msg = { "trackerEventType" : trackerEvent, "source" : src, "eventTime" : time, "geofenceId" : gfId, "coordinates": coordinates, "geofenceCollection": geofenceCollection }; const params = { topic: `${deviceId}/tracker`, payload: JSON.stringify(msg), qos: 0 }; iotdata.publish(params, function(err, data) { if (err) { console.log("error===>>>", err, err.stack); // an error occurred } else { console.log("Ladmbda triggered===>>>", trackerEvent); // successful response } iOS 56 Amazon Location Service Developer Guide }); } }); } 8. Choose Deploy to save the updated function. 9. Choose the Configuration tab. 10. In the Triggers section, click on Add trigger. 11. Select EventBridge (CloudWatch Events) in Source field. 12. Select `Existing Rules` radio option. 13. Enter the rule name like this `AmazonLocationMonitor-GEOFENCECOLLECTION_NAME`. 14. Click on the Add button. 15. This will also attach `Resource-based policy statements` in permissions tab MQTT Test Client 1. Open the https://console.aws.amazon.com/iot/. 2. In the left navigation pane, choose MQTT test client. 3. You'll see a section titled MQTT test client where you can configure your MQTT connection. 4. After configuring the necessary settings, click on the Connect button to establish a connection to the MQTT broker using the provided parameters. 5. Make note of the Endpoint value. Once connected, you can subscribe to MQTT topics or publish messages to topics using the respective input fields provided in the MQTT test client interface. Next you will attach the MQTT Policy: 1. On the left side menu, under Manage expand Security option and click on Policies. 2. Click on Create Policy button. 3. Enter a policy name. 4. On Policy Document select JSON tab. 5. Copy paste the policy shown below, but make sure to update all elements with your REGION and ACCOUNT_ID: iOS 57 Amazon Location Service Developer Guide { "Version": "2012-10-17", "Statement": [ { "Action": [ "iot:Connect", "iot:Publish", "iot:Subscribe", "iot:Receive" ], "Resource": [ "arn:aws:iot:REGION:ACCOUNT_ID:client/${cognito- identity.amazonaws.com:sub}", "arn:aws:iot:REGION:ACCOUNT_ID:topic/${cognito- identity.amazonaws.com:sub}", "arn:aws:iot:REGION:ACCOUNT_ID:topicfilter/${cognito- identity.amazonaws.com:sub}/", "arn:aws:iot:REGION:ACCOUNT_ID:topic/${cognito- identity.amazonaws.com:sub}/tracker" ], "Effect": "Allow" } ] } 6. Select the Create button to finish. Set up sample app code In order to setup the sample code you must have the following tools installed: • Git • XCode 15.3 or Later • iOS Simulator 16 or later Use this procedure to set up the sample app code: 1. Clone the git repository from this URL: https://github.com/aws-geospatial/amazon-location- samples-ios/tree/main/tracking-with-geofence-notifications. 2. Open the AWSLocationSampleApp.xcodeproj project file. iOS 58 Amazon Location Service Developer Guide 3. Wait for the package resolution process. 4. Optional: On the project navigation menu rename ConfigTemplate.xcconfig to Config.xcconfig and fill in the following values: IDENTITY_POOL_ID = `YOUR_IDENTITY_POOL_ID` MAP_NAME = `YOUR_MAP_NAME` TRACKER_NAME = `YOUR_TRACKER_NAME` WEBSOCKET_URL = `YOUR_MQTT_TEST_CLIENT_ENDPOINT` GEOFENCE_ARN = `YOUR_GEOFENCE_COLLECTION_NAME` Use the sample app After setting up the sample code you can now run the app on an iOS simulator or a physical device. 1. Build and run the app. 2. 3. 4. The app will ask you for location and notification permissions. You need to allow them. Tap on `Cognito Configuration` button. If you have not filled the values in `Config.xcconfig` file you need to fill out the field with the resources values you have created previously in the configuration screen. IDENTITY_POOL_ID = `YOUR_IDENTITY_POOL_ID` MAP_NAME = `YOUR_MAP_NAME` TRACKER_NAME = `YOUR_TRACKER_NAME` WEBSOCKET_URL = `YOUR_MQTT_TEST_CLIENT_ENDPOINT` GEOFENCE_ARN = `YOUR_GEOFENCE_COLLECTION_NAME` 5. Save the configuration 6. You can now see the Filter options for time, distance and accuracy. Use them as per your need. 7. Go to `Tracking` tab in the app and you will see the map and `Start Tracking` button. 8. If you have installed the app on a simulator you may want to simulate location changes. This can be done in Features -> Location menu option. For example select Features -> Location -> Freeway Drive. 9. Tap on `Start Tracking` button. You should see the tracking points on the map. 10. The app is also tracking the locations in the background. So, when you move the |
amazon-location-developer-guide-019 | amazon-location-developer-guide.pdf | 19 | see the Filter options for time, distance and accuracy. Use them as per your need. 7. Go to `Tracking` tab in the app and you will see the map and `Start Tracking` button. 8. If you have installed the app on a simulator you may want to simulate location changes. This can be done in Features -> Location menu option. For example select Features -> Location -> Freeway Drive. 9. Tap on `Start Tracking` button. You should see the tracking points on the map. 10. The app is also tracking the locations in the background. So, when you move the app in the background it will ask for your permission to continue tracking in background mode. 11. You can stop the tracking by tapping on `Stop Tracking` button. iOS 59 Amazon Location Service Developer Guide Create an Android application Follow these procedures to build an iOS application using Amazon Location Service. Clone the project files from GitHub. Create Amazon Location resources for your app You can generate Amazon Location Service resources once your AWS account is ready. These resources will be essential for executing the provided code snippets. Note If you haven't created an AWS account yet, please create an AWS account. To begin you will need to create a Amazon Cognito Identity Pool Id, use the following procedure: 1. In the AWS console, navigate to the Amazon Cognito service and then select Identity pools from the left side menu and select Create Identity pool. 2. Make sure Guest Access is checked, and press Next to continue. 3. Next create a new IAM role or Use an existing IAM role. 4. Enter an Identity pool name, and make sure Identity Pool has access to Amazon Location (geo)resources for the map and tracker you will be creating in the next procedure. 5. Now you need to create and style a map in the AWS Amazon Location console, use the following procedure: 1. Navigate to the Maps section in the Amazon Location console and select Create Map to preview available map styles. 2. Give the new map resource a Name and Description. Record the name you assign to the map resource, as it is used later in the tutorial. 3. When choosing a map style, consider the map data provider. Refer to section 82 of the AWS service terms for more details. 4. Accept the Amazon Location Terms and Conditions, then select Create Map. After map has been created, you can interact with the map by zooming in, out, or panning in any direction. Android 60 Amazon Location Service Developer Guide To create a tracker using the Amazon Location console 1. Open the Amazon Location Service console. 2. In the left navigation pane, choose Trackers. 3. Choose Create tracker. 4. Fill in the all the required fields. 5. Under Position filtering, choose the option that best fits how you intend to use your tracker resource. If you do not set Position filtering, the default setting is TimeBased. For more information, see Trackers in this guide, and PositionFiltering in the Amazon Location Service Trackers API Reference. 6. Choose Create tracker to finish. Create a Geofence Collection When creating a geofence collection you can use either the console, API or CLI. The following procedures walk you through each option. Create a geofence collection using the Amazon Location console: 1. Open the Amazon Location Service console at https://console.aws.amazon.com/location/. 2. In the left navigation pane, choose Geofence Collections. 3. Choose Create geofence collection. 4. Provide a name and description for the collection. 5. Under EventBridge rule with CloudWatch as a target, you can create an optional EventBridge rule to get started reacting to geofence events. This enables Amazon Location to publish events to Amazon CloudWatch Logs. 6. Choose Create geofence collection. Create a geofence collection using the Amazon Location APIs: Use the CreateGeofenceCollection operation from the Amazon Location Geofences APIs. The following example uses an API request to create a geofence collection called GOECOLLECTION_NAME. POST /geofencing/v0/collections Content-type: application/json Android 61 Amazon Location Service { "CollectionName": "GOECOLLECTION_NAME", "Description": "Geofence collection 1 for shopping center", Developer Guide "Tags": { "Tag1" : "Value1" } } Create a geofence collection using AWS CLI commands: Use the create-geofence-collection command. The following example uses an AWS CLI to create a geofence collection called GOECOLLECTION_NAME. aws location \ create-geofence-collection \ --collection-name "GOECOLLECTION_NAME" \ --description "Shopping center geofence collection" \ --tags Tag1=Value1 Link a tracker to a geofence collection To link a tracker to a geofence collection you can use either the console, API, or CLI. The following procedures walk you through each option. Link a tracker resource to a geofence collection using the Amazon Location Service console: 1. Open the Amazon Location console. 2. In the left navigation pane, choose Trackers. 3. Under Device Trackers, select the name link of the target tracker. |
amazon-location-developer-guide-020 | amazon-location-developer-guide.pdf | 20 | example uses an AWS CLI to create a geofence collection called GOECOLLECTION_NAME. aws location \ create-geofence-collection \ --collection-name "GOECOLLECTION_NAME" \ --description "Shopping center geofence collection" \ --tags Tag1=Value1 Link a tracker to a geofence collection To link a tracker to a geofence collection you can use either the console, API, or CLI. The following procedures walk you through each option. Link a tracker resource to a geofence collection using the Amazon Location Service console: 1. Open the Amazon Location console. 2. In the left navigation pane, choose Trackers. 3. Under Device Trackers, select the name link of the target tracker. 4. Under Linked Geofence Collections, choose Link Geofence Collection. 5. In the Linked Geofence Collection window, select a geofence collection from the dropdown menu. 6. Choose Link. 7. After you link the tracker resource, it will be assigned an Active status. Link a tracker resource to a geofence collection using the Amazon Location APIs: Use the AsssociateTrackerConsumer operation from the Amazon Location Trackers APIs. The following example uses an API request that associates ExampleTracker with a geofence collection using its Amazon Resource Name (ARN). Android 62 Amazon Location Service Developer Guide POST /tracking/v0/trackers/ExampleTracker/consumers Content-type: application/json { "ConsumerArn": "arn:aws:geo:us-west-2:123456789012:geofence- collection/GOECOLLECTION_NAME" } Link a tracker resource to a geofence collection using AWS CLI commands: Use the associate-tracker-consumer command. The following example uses an AWS CLI to create a geofence collection called GOECOLLECTION_NAME. aws location \ associate-tracker-consumer \ --consumer-arn "arn:aws:geo:us-west-2:123456789012:geofence- collection/GOECOLLECTION_NAME" \ --tracker-name "ExampleTracker" Use AWS Lambda with MQTT Create a Lambda function: To create a connection between AWS IoT Core and Amazon Location Service, you need an AWS Lambda function to process messages forwarded by EventBridge CloudWatch events. This function will extract any positional data, format it for Amazon Location Service, and submit it through the Amazon Location Tracker API. You can create this function through the AWS Lambda console, or you can use the AWS Command Line Interface (AWS CLI) or the AWS Lambda APIs. To create a Lambda function that publishes position updates to Amazon Location using the console: 1. Open the AWS Lambda console at https://console.aws.amazon.com/lambda/. 2. From the left navigation, choose Functions. 3. Choose Create Function, and make sure that Author from scratch is selected. 4. Fill out the following boxes: • a Function name • for the Runtime option, choose Node.js 16.x. 5. Choose Create function. 6. Choose the Code tab to open the editor. 7. Overwrite the placeholder code in index.js with the following: Android 63 Amazon Location Service Developer Guide const AWS = require('aws-sdk') const iot = new AWS.Iot(); exports.handler = function(event) { console.log("event===>>>", JSON.stringify(event)); var param = { endpointType: "iot:Data-ATS" }; iot.describeEndpoint(param, function(err, data) { if (err) { console.log("error===>>>", err, err.stack); // an error occurred } else { var endp = data['endpointAddress']; const iotdata = new AWS.IotData({endpoint: endp}); const trackerEvent = event["detail"]["EventType"]; const src = event["source"]; const time = event["time"]; const gfId = event["detail"]["GeofenceId"]; const resources = event["resources"][0]; const splitResources = resources.split("."); const geofenceCollection = splitResources[splitResources.length - 1]; const coordinates = event["detail"]["Position"]; const deviceId = event["detail"]["DeviceId"]; console.log("deviceId===>>>", deviceId); const msg = { "trackerEventType" : trackerEvent, "source" : src, "eventTime" : time, "geofenceId" : gfId, "coordinates": coordinates, "geofenceCollection": geofenceCollection }; const params = { topic: `${deviceId}/tracker`, payload: JSON.stringify(msg), qos: 0 }; iotdata.publish(params, function(err, data) { if (err) { console.log("error===>>>", err, err.stack); // an error occurred } else { Android 64 Amazon Location Service Developer Guide console.log("Ladmbda triggered===>>>", trackerEvent); // successful response } }); } }); } 8. Choose Deploy to save the updated function. 9. Choose the Configuration tab. 10. In the Triggers section, click on Add trigger. 11. Select EventBridge (CloudWatch Events) in Source field. 12. Select `Existing Rules` radio option. 13. Enter the rule name like this `AmazonLocationMonitor-GEOFENCECOLLECTION_NAME`. 14. Click on the Add button. 15. This will also attach `Resource-based policy statements` in permissions tab MQTT Test Client 1. Open the https://console.aws.amazon.com/iot/. 2. In the left navigation pane, choose MQTT test client. 3. You'll see a section titled MQTT test client where you can configure your MQTT connection. 4. After configuring the necessary settings, click on the Connect button to establish a connection to the MQTT broker using the provided parameters. 5. Note down Endpoint value. Once connected, you can subscribe to MQTT topics or publish messages to topics using the respective input fields provided in the MQTT test client interface. Next you will attach the MQTT Policy: 1. On the left side menu, under Manage expand Security option and click on Policies. 2. Click on Create Policy button. 3. Enter a policy name. 4. On Policy Document select JSON tab. Android 65 Amazon Location Service Developer Guide 5. Copy paste the policy shown below, but make sure to update all elements with your REGION and ACCOUNT_ID: { "Version": "2012-10-17", "Statement": [ { "Action": [ "iot:Connect", "iot:Publish", "iot:Subscribe", "iot:Receive" ], "Resource": [ "arn:aws:iot:REGION:ACCOUNT_ID:client/${cognito- |
amazon-location-developer-guide-021 | amazon-location-developer-guide.pdf | 21 | topics or publish messages to topics using the respective input fields provided in the MQTT test client interface. Next you will attach the MQTT Policy: 1. On the left side menu, under Manage expand Security option and click on Policies. 2. Click on Create Policy button. 3. Enter a policy name. 4. On Policy Document select JSON tab. Android 65 Amazon Location Service Developer Guide 5. Copy paste the policy shown below, but make sure to update all elements with your REGION and ACCOUNT_ID: { "Version": "2012-10-17", "Statement": [ { "Action": [ "iot:Connect", "iot:Publish", "iot:Subscribe", "iot:Receive" ], "Resource": [ "arn:aws:iot:REGION:ACCOUNT_ID:client/${cognito- identity.amazonaws.com:sub}", "arn:aws:iot:REGION:ACCOUNT_ID:topic/${cognito- identity.amazonaws.com:sub}", "arn:aws:iot:REGION:ACCOUNT_ID:topicfilter/${cognito- identity.amazonaws.com:sub}/", "arn:aws:iot:REGION:ACCOUNT_ID:topic/${cognito- identity.amazonaws.com:sub}/tracker" ], "Effect": "Allow" } ] } Note Record the policy name and topic name for use in the next procedure. 6. Select the Create button to finish. After completing the previous procedure, you will now update the permissions for the guest role as follows: 1. Navigate to Amazon Cognito and open your identity pool. Then, proceed to user access and select the guest role. 2. Click on permission policies to enable editing. Android 66 Amazon Location Service Developer Guide { 'Version': '2012-10-17', 'Statement': [ { 'Action': [ 'geo:GetMap*', 'geo:BatchUpdateDevicePosition', 'geo:BatchEvaluateGeofences', 'iot:Subscribe', 'iot:Publish', 'iot:Connect', 'iot:Receive', 'iot:AttachPrincipalPolicy', 'iot:AttachPolicy', 'iot:DetachPrincipalPolicy', 'iot:DetachPolicy' ], 'Resource': [ 'arn:aws:geo:us-east-1:{USER_ID}:map/{MAP_NAME}', 'arn:aws:geo:us-east-1:{USER_ID}:tracker/{TRACKER_NAME}', 'arn:aws:geo:us-east-1:{USER_ID}:geofence-collection/ {GEOFENCE_COLLECTION_NAME}', 'arn:aws:iot:us-east-1:{USER_ID}:client/${cognito- identity.amazonaws.com:sub}', 'arn:aws:iot:us-east-1:{USER_ID}:topic/${cognito- identity.amazonaws.com:sub}', 'arn:aws:iot:us-east-1:{USER_ID}:topicfilter/${cognito- identity.amazonaws.com:sub}/*', 'arn:aws:iot:us-east-1:{USER_ID}:topic/${cognito- identity.amazonaws.com:sub}/tracker' ], 'Effect': 'Allow' }, { 'Condition': { 'StringEquals': { 'cognito-identity.amazonaws.com:sub': '${cognito- identity.amazonaws.com:sub}' } }, 'Action': [ 'iot:AttachPolicy', 'iot:DetachPolicy', Android 67 Amazon Location Service Developer Guide 'iot:AttachPrincipalPolicy', 'iot:DetachPrincipalPolicy' ], 'Resource': [ '*' ], 'Effect': 'Allow' } ] } 3. With the above policy changes, all necessary AWS resources are now configured appropriately for the application. Set up the sample app code 1. Open Android Studio and select New and then Project from Version Control. 2. Navigate to the File menu in Android Studio’s top left corner. 3. Select “New” from the dropdown menu. 4. Choose “Project from Version Control”. 5. Enter Repository URL In the dialogue box that appears, find the field marked “URL”. 6. Copy and paste the following URL for the sample app into this field:https://github.com/aws- geospatial/amazon-location-mobile-sdk-sample-app-android.git 7. Decide on the directory where you want to clone the repository. Use either the default directory or opt for a custom location. 8. After setting the repository URL and directory preferences, hit the “Clone” button. Android Studio will proceed to clone the repository to your specified location. 9. You have now cloned the application to your machine and can begin using it. Use the sample app To use the sample follow these procedures: • Create a custom.properties: To configure your custom.properties file, follow these steps: Android 68 Amazon Location Service Developer Guide 1. Open your preferred text editor or IDE. 2. Create a new file. 3. Save the file with the name custom.properties. 4. Update the custom.properties with the following code sample, and replace the MQTT_END_POINT, POLICY_NAME, GEOFENCE_COLLECTION_NAME, and TOPIC_TRACKER with actual values: MQTT_END_POINT=xxxxxxxxxxxxx-xxx.xxx.us-east-1.amazonaws.com POLICY_NAME=xxxxxxxxx GEOFENCE_COLLECTION_NAME=xxxxxxxxxxxxxxxxx TOPIC_TRACKER=xxxxxxxxxx 5. Clean and Rebuild the project. After this, you can run the project. • Sign In: To sign in to the application, follow the below steps: 1. Press the Sign In button. 2. Provide an Identity Pool Id, Tracker name, and a Map name. 3. Press Sign In again to finish. • Manage Filters: Open the configuration screen, and perform the following: 1. Toggle filters on/off using the switch UI. 2. Update Time and Distance filters when needed. • Tracking Operations: Open the tracking screen and perform the following: • You can start and stop tracking in foreground, background, or in battery-saver mode by pressing respective buttons. Android 69 Amazon Location Service Developer Guide Authenticate with Amazon Location Service To use Amazon Location Service, a user must be granted access to the resources and APIs that make up Amazon Location. There are three strategies you can use to grant access to your resources. • Use API keys – To grant access to unauthenticated users, you can create API keys that give read- only access to your Amazon Location Service resources and actions. This is useful in a case where you don't want to authenticate every user. For example, a web application. For more information about API keys, see the section called “Use API keys”. • Use Amazon Cognito – An alternative to API keys is to use Amazon Cognito to grant anonymous access. Amazon Cognito allows you to create a richer authorization with policy to define what can be done by the unauthenticated users. For more information about using Amazon Cognito, see the section called “Use Amazon Cognito”. • Use AWS Identity and Access Management (IAM) – To grant access to users authenticated with AWS IAM Identity Center or AWS Identity and Access Management (IAM), create an IAM policy that allows access to the resources that you want. For more information about IAM and |
amazon-location-developer-guide-022 | amazon-location-developer-guide.pdf | 22 | • Use Amazon Cognito – An alternative to API keys is to use Amazon Cognito to grant anonymous access. Amazon Cognito allows you to create a richer authorization with policy to define what can be done by the unauthenticated users. For more information about using Amazon Cognito, see the section called “Use Amazon Cognito”. • Use AWS Identity and Access Management (IAM) – To grant access to users authenticated with AWS IAM Identity Center or AWS Identity and Access Management (IAM), create an IAM policy that allows access to the resources that you want. For more information about IAM and Amazon Location, see the section called “Use IAM”. Choose an authentication method API keys and Amazon Cognito are used in similar ways for similar scenarios, so why would you choose one instead of the other? The following list highlights some of the differences between the two. • Performance: • API key: Relatively faster • Amazon Cognito: Relatively slower • Availability: • API key: Amazon Location APIs for Maps, Places, and Routes • Amazon Cognito: All APIs • Combines with another authentication method? Choose an authentication method 70 Amazon Location Service • API key: No • Amazon Cognito: Yes Comparison Developer Guide • API keys are available only for maps, places, and routes actions. Amazon Cognito can be used to authenticate access to most Amazon Location Service APIs. • The performance of map requests with API keys is typically faster than similar scenarios with Amazon Cognito. Simpler authentication means fewer round trips to the service and cached requests when getting the same map tile again in a short time period. • With Amazon Cognito, you can use your own authentication process or combine multiple authentication methods, using Amazon Cognito Federated Identities. For more information, see Getting Started with Federated Identities in the Amazon Cognito Developer Guide. Use API keys to authenticate Note API keys are available to use only with map, place, and route resources, and you can't modify or create those resources. If your application needs access to other resources or actions for unauthenticated users, you can use Amazon Cognito to provide access along with, or instead of, API keys. For more information, see the section called “Use Amazon Cognito”. API keys are a key value that is associated with specific Amazon Location Service resources or API in your AWS account, and specific actions that you can perform on those resources. You can use an API key in your application to make unauthenticated calls to the Amazon Location APIs for those resources. For example, if you associate an API key with a resource and/or the GetPlace* API, then an application that uses that API key will be able to call specific APIs. That same API key would not give permissions to change or update any resource or call APIs that it isn't associated with. Use API keys 71 Amazon Location Service Developer Guide When you call Amazon Location Service APIs in your applications, you typically make this call as an authenticated user who is authorized to make the API calls. However, there are some cases where you don't want to authenticate every user of your application. For example, you might want a web application that shows your business location to be available to anyone using the website, whether they are logged in or not. In this case, one alternative is to use API keys to make the API calls. See the section called “Best practices” for additional information about when to use API keys. Create an API key for Amazon Location Service You can create an API key through the Amazon Location Service console, AWS CLI, or Amazon Location API. Continue with the appropriate procedures below. Amazon Location console To create an API key using the Amazon Location Service console 1. In the Amazon Location console, choose API keys from the left menu. 2. On the API keys page, choose Create API key. 3. On the Create API key page, fill in the following information: • Name – A name for your API key, such as ExampleKey. • Description – An optional description for your API key. • Resources – In the dropdown, choose the Amazon Location resources to give access to with this API key. You can add more than one resource by choosing Add resource. • Actions – Specify the actions you want to authorize with this API key. You must select at least one action to match each resource type you have selected. For example, if you selected a place resource, you must select at least one of the choices under Places Actions. • Expiration time – Optionally, add an expiration date and time for your API key. For more information, see the section called “Best practices”. • Referrers – Optionally, add one or more domains where |
amazon-location-developer-guide-023 | amazon-location-developer-guide.pdf | 23 | access to with this API key. You can add more than one resource by choosing Add resource. • Actions – Specify the actions you want to authorize with this API key. You must select at least one action to match each resource type you have selected. For example, if you selected a place resource, you must select at least one of the choices under Places Actions. • Expiration time – Optionally, add an expiration date and time for your API key. For more information, see the section called “Best practices”. • Referrers – Optionally, add one or more domains where you can use the API key. For example, if the API key is to allow an application running on the website example.com, then you could put *.example.com/ as an allowed referrer. • Tags – Optionally, add tags to the API key. Create an API key 72 Amazon Location Service Developer Guide 4. Choose Create API key to create the API key. 5. On the detail page for the API key, you can see information about the API key that you have created. Choose Show API key to see the key value that you use when calling Amazon Location APIs. The key value will have the format v1.public.a1b2c3d4.... AWS CLI 1. Use the create-key command. The following example creates an API key called ExampleKey with no expiration date and access to a single map resource. aws location \ create-key \ --key-name ExampleKey \ --restrictions '{"AllowActions":["geo:GetMap*"],"AllowResources": ["arn:aws:geo:region:map/mapname"]}' \ --no-expiry 2. The response includes the API key value to use when accessing resources in your applications. The key value will have the format v1.public.a1b2c3d4.... To learn more about using the API key to render maps, see the section called “Call an API”. The response to create-key looks like the following: { "Key": "v1.public.a1b2c3d4...", "KeyArn": "arn:aws:geo:region:accountId:api-key/ExampleKey", "KeyName": "ExampleKey", "CreateTime": "2023-02-06T22:33:15.693Z" } 3. You can also use describe-key to find the key value at a later time. The following example shows how to call describe-key on an API key named ExampleKey. aws location describe-key \ --key-name ExampleKey Create an API key 73 Amazon Location Service Amazon Location API Developer Guide Use the CreateKey operation from the Amazon Location APIs. The following example is an API request to create an API key called ExampleKey with no expiration date and access to a single map resource. POST /metadata/v0/keys HTTP/1.1 Content-type: application/json { "KeyName": "ExampleKey", "NoExpiry": true, "Restrictions": { "AllowActions": [ "geo-places:*", "geo-routes:*", "geo-maps:*" ], "AllowResources": [ "arn:aws:geo-places:Region::provider/default", "arn:aws:geo-routes:Region::provider/default", "arn:aws:geo-maps:Region::provider/default" ] } The response includes the API key value to use when accessing resources in your applications. The key value will havethe format v1.public.a1b2c3d4.... You can also use the DescribeKey API to find the key value for a key at a later time. Use an API key to call an Amazon Location API After you create an API key, you can use the key value to make calls to Amazon Location APIs in your application. API The APIs that support API keys have an additional parameter that takes the API key value. For example, if you call the GetPlace API, you can fill in the key parameter, as follows curl --request GET —url 'https://places.geo.eu-central-1.amazonaws.com/v2/place/ {PLACEID}?key={APIKEY}&language=jp' Call an API 74 Amazon Location Service AWS CLI Developer Guide When you use the --key parameter, you should also use the --no-sign-request parameter, to avoid signing with Sig v4. aws geo-places get-place --place-id $PLACEID --language jp --key $APIKEY SDK (web) Use the following code: <!DOCTYPE html> <html lang="en"> <head> <title>Display a map</title> <meta property="og:description" content="Initialize a map in an HTML element with MapLibre GL JS." /> <meta charset='utf-8'> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel='stylesheet' href='https://unpkg.com/maplibre-gl@4.x/dist/ maplibre-gl.css' /> <script src='https://unpkg.com/maplibre-gl@4.x/dist/maplibre-gl.js'></ script> <style> body { margin: 0; } #map { height: 100vh; } </style> </head> <body> <div id="map"></div> <script> const apiKey = "<api key>"; // check how to create api key for Amazon Location const mapStyle = "Standard"; // eg. Standard, Monochrome, Hybrid, Satellite const awsRegion = "eu-central-1"; // eg. us-east-2, us-east-1, us- west-2, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ca-central-1, eu-central-1, eu-west-1, eu-west-2, eu-south-2, eu-north-1, sa-east-1 const styleUrl = `https://maps.geo.${awsRegion}.amazonaws.com/v2/styles/ ${mapStyle}/descriptor?key=${apiKey}`; Call an API 75 Amazon Location Service Developer Guide const map = new maplibregl.Map({ container: 'map', // container id style: styleUrl, // style URL center: [25.24,36.31], // starting position [lng, lat] zoom: 2, // starting zoom }); </script> </body> </html> SDK (iOS, Swift) Use the following code: import UIKit import MapLibre class ViewController: UIViewController { let apiKey = "Enter your API key" // The previously-created API Key to use let regionName = "Enter your region name" // The service region - us-east-1, ap- south-1, etc var mapView: MLNMapView! override func viewDidLoad() { super.viewDidLoad() loadMap() } func loadMap() { let styleName = "Standard" // The map style - Standard, Monochrome, Hybrid, Satellite let colorName = "Light" // The color scheme - Light, Dark // The |
amazon-location-developer-guide-024 | amazon-location-developer-guide.pdf | 24 | center: [25.24,36.31], // starting position [lng, lat] zoom: 2, // starting zoom }); </script> </body> </html> SDK (iOS, Swift) Use the following code: import UIKit import MapLibre class ViewController: UIViewController { let apiKey = "Enter your API key" // The previously-created API Key to use let regionName = "Enter your region name" // The service region - us-east-1, ap- south-1, etc var mapView: MLNMapView! override func viewDidLoad() { super.viewDidLoad() loadMap() } func loadMap() { let styleName = "Standard" // The map style - Standard, Monochrome, Hybrid, Satellite let colorName = "Light" // The color scheme - Light, Dark // The Amazon Location Service map style URL that MapLibre will use to render the maps. let styleURL = URL(string: "https://maps.geo.\(regionName).amazonaws.com/v2/ styles/\(styleName)/descriptor?key=\(apiKey)&color-scheme=\(colorName)") // Initialize MapLibre mapView = MLNMapView(frame: view.bounds) mapView.styleURL = styleURL mapView.autoresizingMask = [.flexibleWidth, .flexibleHeight] // Set the starting camera position and zoom level for the map Call an API 76 Amazon Location Service Developer Guide mapView.setCenter(CLLocationCoordinate2D(latitude: 49.246559, longitude: -123.063554), zoomLevel: 10, animated: false) view.addSubview(mapView!) } } SDK (Android, Kotlin) Use the following code: class MapActivity : Activity(), OnMapReadyCallback { private lateinit var mBinding: ActivityMapBinding override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) initializeMap(savedInstanceState) } private fun initializeMap(savedInstanceState: Bundle?) { // Init MapLibre // See the MapLibre Getting Started Guide for more details // https://maplibre.org/maplibre-native/docs/book/android/getting-started- guide.html MapLibre.getInstance(this@MapActivity) mBinding = ActivityMapBinding.inflate(layoutInflater) setContentView(mBinding.root) mBinding.mapView.onCreate(savedInstanceState) mBinding.mapView.getMapAsync(this) } override fun onMapReady(mapLibreMap: MapLibreMap) { mapLibreMap.setStyle(Style.Builder().fromUri(getMapUrl())) { // Set the starting camera position mapLibreMap.cameraPosition = CameraPosition.Builder().target(LatLng(49.246559, -123.063554)).zoom(10.0).build() mapLibreMap.uiSettings.isLogoEnabled = false mapLibreMap.uiSettings.attributionGravity = Gravity.BOTTOM or Gravity.END mapLibreMap.uiSettings.setAttributionDialogManager(AttributionDialogManager(this, mapLibreMap)) } } Call an API 77 Amazon Location Service Developer Guide // Return the Amazon Location Service map style URL // MapLibre will use this to render the maps. // awsRegion: The service region - us-east-1, ap-south-1, etc // mapStyle: The map style - Standard, Monochrome, Hybrid, Satellite // API_KEY: The previously-created API Key to use // colorName: The color scheme to use - Light, Dark private fun getMapUrl() = "https://maps.geo.${getString(R.string.awsRegion)}.amazonaws.com/v2/ styles/${getString(R.string.mapStyle)}/descriptor?key=${BuildConfig.API_KEY}&color- scheme=${getString(R.string.colorName)}" override fun onStart() { super.onStart() mBinding.mapView.onStart() } override fun onResume() { super.onResume() mBinding.mapView.onResume() } override fun onPause() { super.onPause() mBinding.mapView.onPause() } override fun onStop() { super.onStop() mBinding.mapView.onStop() } override fun onSaveInstanceState(outState: Bundle) { super.onSaveInstanceState(outState) mBinding.mapView.onSaveInstanceState(outState) } override fun onLowMemory() { super.onLowMemory() mBinding.mapView.onLowMemory() } override fun onDestroy() { super.onDestroy() Call an API 78 Amazon Location Service Developer Guide mBinding.mapView.onDestroy() } } API key best practices API keys include a plain text value that gives access to one or more resources or APIs in your AWS account. If someone copies your API key, they can access those same resources and APIs. To minimize the potential impact, review the following best practices: • Limit the API key To avoid the situation above, it is best to limit your API key. When you create the key, you can specify the domain or referrer where the key can be used. • Manage API key lifetimes You can create API keys that work indefinitely. However, if you want to create a temporary API key, rotate API keys on a regular basis, or revoke an existing API key, you can use API key expiration. • You can set the expiration time for an API key when you create or update it. • When an API key reaches its expiration time, the key is automatically deactivated. Inactive keys can no longer be used to make requests. • You can change a temporary key to a permanent key by removing the expiration time. • You can delete an API key 90 days after deactivating it. • If you attempt to deactivate an API key that has been used within the last seven days, you'll be prompted to confirm that you want to make the change. If you are using the Amazon Location Service API or the AWS CLI, set the ForceUpdate parameter to true, otherwise you'll receive an error. Use Amazon Cognito to authenticate You can use Amazon Cognito authentication as an alternative to directly using AWS Identity and Access Management (IAM) users with frontend SDK requests. Best practices 79 Amazon Location Service Developer Guide Amazon Cognito provides authentication, authorization, and user management for web and mobile apps. You can use Amazon Cognito unauthenticated identity pools with Amazon Location as a way for applications to retrieve temporary, scoped-down AWS credentials. For more information, see Getting Started with User Pools in the Amazon Cognito Developer Guide. You may want to use this form of authentication for the following reasons: • Unauthenticated users – If you have a website with anonymous users, you can use Amazon Cognito identity pools. For more information, see the section on the section called “Use Amazon Cognito”. • Your own authentication – If you would like to use your own authentication process, or combine multiple authentication methods, you can use Amazon Cognito Federated Identities. For more information, see Getting Started with Federated Identities in the |
amazon-location-developer-guide-025 | amazon-location-developer-guide.pdf | 25 | AWS credentials. For more information, see Getting Started with User Pools in the Amazon Cognito Developer Guide. You may want to use this form of authentication for the following reasons: • Unauthenticated users – If you have a website with anonymous users, you can use Amazon Cognito identity pools. For more information, see the section on the section called “Use Amazon Cognito”. • Your own authentication – If you would like to use your own authentication process, or combine multiple authentication methods, you can use Amazon Cognito Federated Identities. For more information, see Getting Started with Federated Identities in the Amazon Cognito Developer Guide. Use Amazon Cognito and Amazon Location Service You can use AWS Identity and Access Management (IAM) policies associated with unauthenticated identity roles with the following actions: Maps List of maps actions • geo-maps:GetStaticMap • geo-maps:GetTile Note Resource names for the actions above are: arn:aws:geo-maps:region::provider/default Use Amazon Cognito and Amazon Location Service 80 Developer Guide Amazon Location Service Places List of place actions: • geo-places:Geocode • geo-places:ReverseGeocode • geo-places:SearchNearby • geo-places:SearchText • geo-places:Autocomplete • geo-places:Suggest • geo-places:GetPlace Note Resource names for the actions above are: arn:aws:geo-places:region::provider/default Routes List of routes actions: • geo-routes:CalculateRoutes • geo-routes:CalculateRouteMatrix • geo-routes:CalculateIsolines • geo-routes:OptimizeWaypoints • geo-routes:SnapToRoads Note Resource names for the actions above are: arn:aws:geo-routes:region::provider/default Use Amazon Cognito and Amazon Location Service 81 Developer Guide Amazon Location Service Geofences and Trackers List of Geofences and Trackers actions • geo:GetGeofence • geo:ListGeofences • geo:PutGeofence • geo:BatchDeleteGeofence • geo:BatchPutGeofence • geo:BatchEvaluateGeofences • geo:GetDevicePosition* • geo:ListDevicePositions • geo:BatchDeleteDevicePositionHistory • geo:BatchGetDevicePosition • geo:BatchUpdateDevicePosition Note Resource names for the actions above are: arn:aws:geo:region:accountID:tracker/ExampleTracker Previous version List of previous version actions: • geo:GetMap* • geo:SearchPlaceIndexForText • geo:SearchPlaceIndexForPosition • geo:GetPlace • geo:CalculateRoute • geo:CalculateRouteMatrix Use Amazon Cognito and Amazon Location Service 82 Amazon Location Service Developer Guide Note Resource names for the actions above are: Maps arn:aws:geo:region:accountID:map/ExampleMap Places arn:aws:geo:region:accountID:place-index/ExamplePlaceIndex Routes arn:aws:geo:region:accountID:route-calculator/ExampleCalculator Create an Amazon Cognito identity pool You can create Amazon Cognito identity pools to allow unauthenticated guest access to your application through the Amazon Cognito console, the AWS CLI, or the Amazon Cognito APIs. Important The pool that you create must be in the same AWS account and AWS Region as the Amazon Location Service resources that you're using. Console To create an identity pool using the Amazon Cognito console 1. Go to the Amazon Cognito console. 2. Choose Manage Identity Pools. 3. Choose Create new identity pool, then enter a name for your identity pool. 4. From the Unauthenticated identities collapsible section, choose Enable access to unauthenticated identities. 5. Choose Create Pool. Create an Amazon Cognito identity pool 83 Amazon Location Service Developer Guide 6. Choose which IAM roles you want to use with your identity pool. 7. Expand View Details. 8. Under Unauthenticated identities, enter a role name. 9. Expand the View Policy Document section, then choose Edit to add your policy. 10. Add your policy to grant access to your resources. Note See the the section called “Use Amazon Cognito and Amazon Location Service” section above for a list of actions. { "Version": "2012-10-17", "Statement": [ { Sid": "RoutesReadOnly", Effect": "Allow", Action": [ // add comma separated value from the previous section ], Resource": "value from previous section" } ] } 11. Choose Allow to create your identity pools. Use the Amazon Cognito identity pool in web The following example exchanges the unauthenticated identity pool that you created for credentials that are then used to call CalculateIsolines. To simplify this work, the example uses the Amazon Location the section called “Use authentication helpers” procedures. This is in place of both getting and refreshing the credentials. This example uses the AWS SDK for JavaScript v3. import { GeoRoutesClient, CalculateIsolinesCommand , } from "@aws-sdk/client-geo- routes"; // ES Modules import Use the identity pool in web 84 Amazon Location Service Developer Guide import { withIdentityPoolId } from "@aws/amazon-location-utilities-auth-helper"; const identityPoolId = "<identity pool ID>"; // for example, us- east-1:1sample4-5678-90ef-aaaa-1234abcd56ef const authHelper = await withIdentityPoolId(identityPoolId); const client = new GeoRoutesClient({ ...authHelper.getClientConfig(), region: "<region>", // The region containing the identity pool }); const input = { DepartNow: true, TravelMode: "Car", Origin: [-123.12327, 49.27531], Thresholds: { Time: [5, 10, 30], }, }; const command = new CalculateIsolinesCommand(input); const response = await client.send(command); console.log(JSON.stringify(response, null, 2)) Use AWS Identity and Access Management to authenticate AWS Identity and Access Management (IAM) is an AWS service that helps an administrator securely control access to AWS resources. IAM administrators control who can be authenticated (signed in) and authorized (have permissions) to use Amazon Location resources. IAM is an AWS service that you can use with no additional charge. Topics • Audience • Authenticating with identities • Managing access using policies • How Amazon Location Service works with IAM • How Amazon Location Service works with unauthenticated users Use IAM 85 Amazon Location Service Developer Guide |
amazon-location-developer-guide-026 | amazon-location-developer-guide.pdf | 26 | client.send(command); console.log(JSON.stringify(response, null, 2)) Use AWS Identity and Access Management to authenticate AWS Identity and Access Management (IAM) is an AWS service that helps an administrator securely control access to AWS resources. IAM administrators control who can be authenticated (signed in) and authorized (have permissions) to use Amazon Location resources. IAM is an AWS service that you can use with no additional charge. Topics • Audience • Authenticating with identities • Managing access using policies • How Amazon Location Service works with IAM • How Amazon Location Service works with unauthenticated users Use IAM 85 Amazon Location Service Developer Guide • Identity-based policy examples for Amazon Location Service • Troubleshooting Amazon Location Service identity and access Audience How you use AWS Identity and Access Management (IAM) differs, depending on the work that you do in Amazon Location. Service user – If you use the Amazon Location service to do your job, then your administrator provides you with the credentials and permissions that you need. As you use more Amazon Location features to do your work, you might need additional permissions. Understanding how access is managed can help you request the right permissions from your administrator. If you cannot access a feature in Amazon Location, see Troubleshooting Amazon Location Service identity and access. Service administrator – If you're in charge of Amazon Location resources at your company, you probably have full access to Amazon Location. It's your job to determine which Amazon Location features and resources your service users should access. You must then submit requests to your IAM administrator to change the permissions of your service users. Review the information on this page to understand the basic concepts of IAM. To learn more about how your company can use IAM with Amazon Location, see How Amazon Location Service works with IAM. IAM administrator – If you're an IAM administrator, you might want to learn details about how you can write policies to manage access to Amazon Location. To view example Amazon Location identity-based policies that you can use in IAM, see Identity-based policy examples for Amazon Location Service. Authenticating with identities Authentication is how you sign in to AWS using your identity credentials. You must be authenticated (signed in to AWS) as the AWS account root user, as an IAM user, or by assuming an IAM role. You can sign in to AWS as a federated identity by using credentials provided through an identity source. AWS IAM Identity Center (IAM Identity Center) users, your company's single sign-on authentication, and your Google or Facebook credentials are examples of federated identities. When you sign in as a federated identity, your administrator previously set up identity federation using IAM roles. When you access AWS by using federation, you are indirectly assuming a role. Audience 86 Amazon Location Service Developer Guide Depending on the type of user you are, you can sign in to the AWS Management Console or the AWS access portal. For more information about signing in to AWS, see How to sign in to your AWS account in the AWS Sign-In User Guide. If you access AWS programmatically, AWS provides a software development kit (SDK) and a command line interface (CLI) to cryptographically sign your requests by using your credentials. If you don't use AWS tools, you must sign requests yourself. For more information about using the recommended method to sign requests yourself, see AWS Signature Version 4 for API requests in the IAM User Guide. Regardless of the authentication method that you use, you might be required to provide additional security information. For example, AWS recommends that you use multi-factor authentication (MFA) to increase the security of your account. To learn more, see Multi-factor authentication in the AWS IAM Identity Center User Guide and AWS Multi-factor authentication in IAM in the IAM User Guide. AWS account root user When you create an AWS account, you begin with one sign-in identity that has complete access to all AWS services and resources in the account. This identity is called the AWS account root user and is accessed by signing in with the email address and password that you used to create the account. We strongly recommend that you don't use the root user for your everyday tasks. Safeguard your root user credentials and use them to perform the tasks that only the root user can perform. For the complete list of tasks that require you to sign in as the root user, see Tasks that require root user credentials in the IAM User Guide. Federated identity As a best practice, require human users, including users that require administrator access, to use federation with an identity provider to access AWS services by using temporary credentials. A federated identity is a user from your enterprise user directory, a web identity provider, the AWS Directory |
amazon-location-developer-guide-027 | amazon-location-developer-guide.pdf | 27 | user for your everyday tasks. Safeguard your root user credentials and use them to perform the tasks that only the root user can perform. For the complete list of tasks that require you to sign in as the root user, see Tasks that require root user credentials in the IAM User Guide. Federated identity As a best practice, require human users, including users that require administrator access, to use federation with an identity provider to access AWS services by using temporary credentials. A federated identity is a user from your enterprise user directory, a web identity provider, the AWS Directory Service, the Identity Center directory, or any user that accesses AWS services by using credentials provided through an identity source. When federated identities access AWS accounts, they assume roles, and the roles provide temporary credentials. For centralized access management, we recommend that you use AWS IAM Identity Center. You can create users and groups in IAM Identity Center, or you can connect and synchronize to a set of users and groups in your own identity source for use across all your AWS accounts and applications. For Authenticating with identities 87 Amazon Location Service Developer Guide information about IAM Identity Center, see What is IAM Identity Center? in the AWS IAM Identity Center User Guide. IAM users and groups An IAM user is an identity within your AWS account that has specific permissions for a single person or application. Where possible, we recommend relying on temporary credentials instead of creating IAM users who have long-term credentials such as passwords and access keys. However, if you have specific use cases that require long-term credentials with IAM users, we recommend that you rotate access keys. For more information, see Rotate access keys regularly for use cases that require long- term credentials in the IAM User Guide. An IAM group is an identity that specifies a collection of IAM users. You can't sign in as a group. You can use groups to specify permissions for multiple users at a time. Groups make permissions easier to manage for large sets of users. For example, you could have a group named IAMAdmins and give that group permissions to administer IAM resources. Users are different from roles. A user is uniquely associated with one person or application, but a role is intended to be assumable by anyone who needs it. Users have permanent long-term credentials, but roles provide temporary credentials. To learn more, see Use cases for IAM users in the IAM User Guide. IAM roles An IAM role is an identity within your AWS account that has specific permissions. It is similar to an IAM user, but is not associated with a specific person. To temporarily assume an IAM role in the AWS Management Console, you can switch from a user to an IAM role (console). You can assume a role by calling an AWS CLI or AWS API operation or by using a custom URL. For more information about methods for using roles, see Methods to assume a role in the IAM User Guide. IAM roles with temporary credentials are useful in the following situations: • Federated user access – To assign permissions to a federated identity, you create a role and define permissions for the role. When a federated identity authenticates, the identity is associated with the role and is granted the permissions that are defined by the role. For information about roles for federation, see Create a role for a third-party identity provider (federation) in the IAM User Guide. If you use IAM Identity Center, you configure a permission set. To control what your identities can access after they authenticate, IAM Identity Center correlates the permission set to a role in IAM. For information about permissions sets, see Permission sets in the AWS IAM Identity Center User Guide. Authenticating with identities 88 Amazon Location Service Developer Guide • Temporary IAM user permissions – An IAM user or role can assume an IAM role to temporarily take on different permissions for a specific task. • Cross-account access – You can use an IAM role to allow someone (a trusted principal) in a different account to access resources in your account. Roles are the primary way to grant cross- account access. However, with some AWS services, you can attach a policy directly to a resource (instead of using a role as a proxy). To learn the difference between roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. • Cross-service access – Some AWS services use features in other AWS services. For example, when you make a call in a service, it's common for that service to run applications in Amazon EC2 or store objects in Amazon S3. A service might do this using the calling |
amazon-location-developer-guide-028 | amazon-location-developer-guide.pdf | 28 | way to grant cross- account access. However, with some AWS services, you can attach a policy directly to a resource (instead of using a role as a proxy). To learn the difference between roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. • Cross-service access – Some AWS services use features in other AWS services. For example, when you make a call in a service, it's common for that service to run applications in Amazon EC2 or store objects in Amazon S3. A service might do this using the calling principal's permissions, using a service role, or using a service-linked role. • Forward access sessions (FAS) – When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a different service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. • Service role – A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. • Service-linked role – A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. • Applications running on Amazon EC2 – You can use an IAM role to manage temporary credentials for applications that are running on an EC2 instance and making AWS CLI or AWS API requests. This is preferable to storing access keys within the EC2 instance. To assign an AWS role to an EC2 instance and make it available to all of its applications, you create an instance profile that is attached to the instance. An instance profile contains the role and enables programs that are running on the EC2 instance to get temporary credentials. For more information, see Use an IAM role to grant permissions to applications running on Amazon EC2 instances in the IAM User Guide. Authenticating with identities 89 Amazon Location Service Developer Guide Managing access using policies You control access in AWS by creating policies and attaching them to AWS identities or resources. A policy is an object in AWS that, when associated with an identity or resource, defines their permissions. AWS evaluates these policies when a principal (user, root user, or role session) makes a request. Permissions in the policies determine whether the request is allowed or denied. Most policies are stored in AWS as JSON documents. For more information about the structure and contents of JSON policy documents, see Overview of JSON policies in the IAM User Guide. Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. By default, users and roles have no permissions. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. IAM policies define permissions for an action regardless of the method that you use to perform the operation. For example, suppose that you have a policy that allows the iam:GetRole action. A user with that policy can get role information from the AWS Management Console, the AWS CLI, or the AWS API. Identity-based policies Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. Identity-based policies can be further categorized as inline policies or managed policies. Inline policies are embedded directly into a single user, group, or role. Managed policies are standalone policies that you can attach to multiple users, groups, and roles in your AWS account. Managed policies include AWS managed policies and customer managed policies. To learn |
amazon-location-developer-guide-029 | amazon-location-developer-guide.pdf | 29 | user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. Identity-based policies can be further categorized as inline policies or managed policies. Inline policies are embedded directly into a single user, group, or role. Managed policies are standalone policies that you can attach to multiple users, groups, and roles in your AWS account. Managed policies include AWS managed policies and customer managed policies. To learn how to choose between a managed policy or an inline policy, see Choose between managed policies and inline policies in the IAM User Guide. Resource-based policies Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that Managing access using policies 90 Amazon Location Service Developer Guide support resource-based policies, service administrators can use them to control access to a specific resource. For the resource where the policy is attached, the policy defines what actions a specified principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. Resource-based policies are inline policies that are located in that service. You can't use AWS managed policies from IAM in a resource-based policy. Access control lists (ACLs) Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. Amazon S3, AWS WAF, and Amazon VPC are examples of services that support ACLs. To learn more about ACLs, see Access control list (ACL) overview in the Amazon Simple Storage Service Developer Guide. Other policy types AWS supports additional, less-common policy types. These policy types can set the maximum permissions granted to you by the more common policy types. • Permissions boundaries – A permissions boundary is an advanced feature in which you set the maximum permissions that an identity-based policy can grant to an IAM entity (IAM user or role). You can set a permissions boundary for an entity. The resulting permissions are the intersection of an entity's identity-based policies and its permissions boundaries. Resource-based policies that specify the user or role in the Principal field are not limited by the permissions boundary. An explicit deny in any of these policies overrides the allow. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. • Service control policies (SCPs) – SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU) in AWS Organizations. AWS Organizations is a service for grouping and centrally managing multiple AWS accounts that your business owns. If you enable all features in an organization, then you can apply service control policies (SCPs) to any or all of your accounts. The SCP limits permissions for entities in member accounts, including each AWS account root user. For more information about Organizations and SCPs, see Service control policies in the AWS Organizations User Guide. Managing access using policies 91 Amazon Location Service Developer Guide • Resource control policies (RCPs) – RCPs are JSON policies that you can use to set the maximum available permissions for resources in your accounts without updating the IAM policies attached to each resource that you own. The RCP limits permissions for resources in member accounts and can impact the effective permissions for identities, including the AWS account root user, regardless of whether they belong to your organization. For more information about Organizations and RCPs, including a list of AWS services that support RCPs, see Resource control policies (RCPs) in the AWS Organizations User Guide. • Session policies – Session policies are advanced policies that you pass as a parameter when you programmatically create a temporary session for a role or federated user. The resulting session's permissions are the intersection of the user or role's identity-based policies and the session policies. Permissions can also come from a resource-based policy. An explicit deny in any of these policies overrides the allow. For more information, see Session policies in the IAM User Guide. Multiple policy types When multiple types of policies apply to a request, the resulting permissions are more complicated to understand. To learn how AWS determines whether to allow a request when multiple policy types are involved, see Policy evaluation logic in the IAM User Guide. How Amazon Location Service works with IAM Before you use IAM to manage access to Amazon Location, learn what IAM features are available to use with Amazon Location. IAM |
amazon-location-developer-guide-030 | amazon-location-developer-guide.pdf | 30 | from a resource-based policy. An explicit deny in any of these policies overrides the allow. For more information, see Session policies in the IAM User Guide. Multiple policy types When multiple types of policies apply to a request, the resulting permissions are more complicated to understand. To learn how AWS determines whether to allow a request when multiple policy types are involved, see Policy evaluation logic in the IAM User Guide. How Amazon Location Service works with IAM Before you use IAM to manage access to Amazon Location, learn what IAM features are available to use with Amazon Location. IAM features you can use with Amazon Location Service IAM feature Amazon Location support the section called “Identity-based policies” Resource-based policies Policy actions Policy resources Policy condition keys (service-specific) Yes No Yes Yes Yes How Amazon Location Service works with IAM 92 Amazon Location Service IAM feature ACLs ABAC (tags in policies) Temporary credentials Principal permissions Service roles Service-linked roles Amazon Location support Developer Guide No Yes Yes No No No To get a high-level view of how Amazon Location and other AWS services work with most IAM features, see AWS services that work with IAM in the IAM User Guide. Identity-based policies for Amazon Location Supports identity-based policies: Yes Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. With IAM identity-based policies, you can specify allowed or denied actions and resources as well as the conditions under which actions are allowed or denied. You can't specify the principal in an identity-based policy because it applies to the user or role to which it is attached. To learn about all of the elements that you can use in a JSON policy, see IAM JSON policy elements reference in the IAM User Guide. Identity-based policy examples for Amazon Location To view examples of Amazon Location identity-based policies, see Identity-based policy examples for Amazon Location Service. Resource-based policies within Amazon Location Supports resource-based policies: No How Amazon Location Service works with IAM 93 Amazon Location Service Developer Guide Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a specific resource. For the resource where the policy is attached, the policy defines what actions a specified principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. To enable cross-account access, you can specify an entire account or IAM entities in another account as the principal in a resource-based policy. Adding a cross-account principal to a resource- based policy is only half of establishing the trust relationship. When the principal and the resource are in different AWS accounts, an IAM administrator in the trusted account must also grant the principal entity (user or role) permission to access the resource. They grant permission by attaching an identity-based policy to the entity. However, if a resource-based policy grants access to a principal in the same account, no additional identity-based policy is required. For more information, see Cross account resource access in IAM in the IAM User Guide. Policy actions for Amazon Location Supports policy actions: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Action element of a JSON policy describes the actions that you can use to allow or deny access in a policy. Policy actions usually have the same name as the associated AWS API operation. There are some exceptions, such as permission-only actions that don't have a matching API operation. There are also some operations that require multiple actions in a policy. These additional actions are called dependent actions. Include actions in a policy to grant permissions to perform the associated operation. To see a list of Amazon Location actions, see Actions Defined by Amazon Location Service in the Service Authorization Reference. Policy actions in Amazon Location use the following prefix before the action: geo How Amazon Location Service works with IAM 94 Amazon Location Service Developer Guide To specify multiple actions in a single statement, separate them with commas. "Action": [ "geo:action1", "geo:action2" ] You can specify multiple actions using wildcards (*). For example, to specify all actions that begin with the word Get, include the following |
amazon-location-developer-guide-031 | amazon-location-developer-guide.pdf | 31 | actions. Include actions in a policy to grant permissions to perform the associated operation. To see a list of Amazon Location actions, see Actions Defined by Amazon Location Service in the Service Authorization Reference. Policy actions in Amazon Location use the following prefix before the action: geo How Amazon Location Service works with IAM 94 Amazon Location Service Developer Guide To specify multiple actions in a single statement, separate them with commas. "Action": [ "geo:action1", "geo:action2" ] You can specify multiple actions using wildcards (*). For example, to specify all actions that begin with the word Get, include the following action: "Action": "geo:Get*" To view examples of Amazon Location identity-based policies, see Identity-based policy examples for Amazon Location Service. Policy resources for Amazon Location Supports policy resources: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Resource JSON policy element specifies the object or objects to which the action applies. Statements must include either a Resource or a NotResource element. As a best practice, specify a resource using its Amazon Resource Name (ARN). You can do this for actions that support a specific resource type, known as resource-level permissions. For actions that don't support resource-level permissions, such as listing operations, use a wildcard (*) to indicate that the statement applies to all resources. "Resource": "*" To see a list of Amazon Location resource types and their ARNs, see Resources Defined by Amazon Location Service in the Service Authorization Reference. To learn with which actions you can specify the ARN of each resource, see Actions Defined by Amazon Location Service. How Amazon Location Service works with IAM 95 Amazon Location Service Developer Guide To view examples of Amazon Location identity-based policies, see Identity-based policy examples for Amazon Location Service. Policy condition keys for Amazon Location Supports service-specific policy condition keys: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Condition element (or Condition block) lets you specify conditions in which a statement is in effect. The Condition element is optional. You can create conditional expressions that use condition operators, such as equals or less than, to match the condition in the policy with values in the request. If you specify multiple Condition elements in a statement, or multiple keys in a single Condition element, AWS evaluates them using a logical AND operation. If you specify multiple values for a single condition key, AWS evaluates the condition using a logical OR operation. All of the conditions must be met before the statement's permissions are granted. You can also use placeholder variables when you specify conditions. For example, you can grant an IAM user permission to access a resource only if it is tagged with their IAM user name. For more information, see IAM policy elements: variables and tags in the IAM User Guide. AWS supports global condition keys and service-specific condition keys. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide. To see a list of Amazon Location condition keys, see Condition Keys for Amazon Location Service in the Service Authorization Reference. To learn with which actions and resources you can use a condition key, see Actions Defined by Amazon Location Service. Amazon Location supports condition keys to allow you to allow or deny access to specific geofences or devices in your policy statements. The following condition keys are available: • geo:GeofenceIds for use with Geofence actions. The type is ArrayOfString. • geo:DeviceIds for use with Tracker actions. The type is ArrayOfString. The following actions can be used with geo:GeofenceIds in your IAM policy: • BatchDeleteGeofences How Amazon Location Service works with IAM 96 Amazon Location Service • BatchPutGeofences • GetGeofence • PutGeofence Developer Guide The following actions can be used with geo:DeviceIds in your IAM policy: • BatchDeleteDevicePositionHistory • BatchGetDevicePosition • BatchUpdateDevicePosition • GetDevicePosition • GetDevicePositionHistory Note You can't use these condition keys with the BatchEvaluateGeofences, ListGeofences, or ListDevicePosition actions. To view examples of Amazon Location identity-based policies, see Identity-based policy examples for Amazon Location Service. ACLs in Amazon Location Supports ACLs: No Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. ABAC with Amazon Location Supports ABAC (tags in policies): Yes Attribute-based access control (ABAC) is an authorization strategy that defines permissions based on attributes. In AWS, these attributes are called tags. You can attach tags to IAM entities (users or roles) and to many AWS resources. Tagging entities and resources is the first step of |
amazon-location-developer-guide-032 | amazon-location-developer-guide.pdf | 32 | for Amazon Location Service. ACLs in Amazon Location Supports ACLs: No Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. ABAC with Amazon Location Supports ABAC (tags in policies): Yes Attribute-based access control (ABAC) is an authorization strategy that defines permissions based on attributes. In AWS, these attributes are called tags. You can attach tags to IAM entities (users or roles) and to many AWS resources. Tagging entities and resources is the first step of ABAC. Then How Amazon Location Service works with IAM 97 Amazon Location Service Developer Guide you design ABAC policies to allow operations when the principal's tag matches the tag on the resource that they are trying to access. ABAC is helpful in environments that are growing rapidly and helps with situations where policy management becomes cumbersome. To control access based on tags, you provide tag information in the condition element of a policy using the aws:ResourceTag/key-name, aws:RequestTag/key-name, or aws:TagKeys condition keys. If a service supports all three condition keys for every resource type, then the value is Yes for the service. If a service supports all three condition keys for only some resource types, then the value is Partial. For more information about ABAC, see Define permissions with ABAC authorization in the IAM User Guide. To view a tutorial with steps for setting up ABAC, see Use attribute-based access control (ABAC) in the IAM User Guide. For more information about tagging Amazon Location resources, see the section called “How to use tags”. To view an example identity-based policy for limiting access to a resource based on the tags on that resource, see Control resource access based on tags. Using temporary credentials with Amazon Location Supports temporary credentials: Yes Some AWS services don't work when you sign in using temporary credentials. For additional information, including which AWS services work with temporary credentials, see AWS services that work with IAM in the IAM User Guide. You are using temporary credentials if you sign in to the AWS Management Console using any method except a user name and password. For example, when you access AWS using your company's single sign-on (SSO) link, that process automatically creates temporary credentials. You also automatically create temporary credentials when you sign in to the console as a user and then switch roles. For more information about switching roles, see Switch from a user to an IAM role (console) in the IAM User Guide. You can manually create temporary credentials using the AWS CLI or AWS API. You can then use those temporary credentials to access AWS. AWS recommends that you dynamically generate How Amazon Location Service works with IAM 98 Amazon Location Service Developer Guide temporary credentials instead of using long-term access keys. For more information, see Temporary security credentials in IAM. Cross-service principal permissions for Amazon Location Supports forward access sessions (FAS): No When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a different service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. Service roles for Amazon Location Supports service roles: No A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. Warning Changing the permissions for a service role might break Amazon Location functionality. Edit service roles only when Amazon Location provides guidance to do so. Service-linked roles for Amazon Location Supports service-linked roles: No A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. For details about creating or managing service-linked roles, see AWS services that work with IAM. Find a service in the table that includes a Yes in the Service-linked role column. Choose the Yes link to view the service-linked role documentation for that service. How Amazon Location Service works with IAM 99 |
amazon-location-developer-guide-033 | amazon-location-developer-guide.pdf | 33 | of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. For details about creating or managing service-linked roles, see AWS services that work with IAM. Find a service in the table that includes a Yes in the Service-linked role column. Choose the Yes link to view the service-linked role documentation for that service. How Amazon Location Service works with IAM 99 Amazon Location Service Developer Guide How Amazon Location Service works with unauthenticated users Many scenarios for using Amazon Location Service, including showing maps on the web or in a mobile application, require allowing access to users who haven't signed in with IAM. For these unauthenticated scenarios, you have two options. • Use API keys – To grant access to unauthenticated users, you can create API Keys that give read- only access to your Amazon Location Service resources. This is useful in a case where you do not want to authenticate every user. For example, a web application. For more information about API keys, see the section called “Use API keys”. • Use Amazon Cognito – An alternative to API keys is to use Amazon Cognito to grant anonymous access. Amazon Cognito allows you to create a richer authorization with IAM policy to define what can be done by the unauthenticated users. For more information about using Amazon Cognito, see the section called “Use the identity pool in web”. For an overview of providing access to unauthenticated users, see Authentication. Identity-based policy examples for Amazon Location Service By default, users and roles don't have permission to create or modify Amazon Location resources. They also can't perform tasks by using the AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS API. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. To learn how to create an IAM identity-based policy by using these example JSON policy documents, see Create IAM policies (console) in the IAM User Guide. For details about actions and resource types defined by Amazon Location, including the format of the ARNs for each of the resource types, see Actions, Resources, and Condition Keys for Amazon Location Service in the Service Authorization Reference. Topics • Policy best practices • Using the Amazon Location console • Allow users to view their own permissions • Using Amazon Location Service resources in policy How Amazon Location Service works with unauthenticated users 100 Amazon Location Service Developer Guide • Permissions for updating device positions • Read-only policy for tracker resources • Policy for creating geofences • Read-only policy for geofences • Permissions for rendering a map resource • Permissions to allow search operations • Read-only policy for route calculators • Control resource access based on condition keys • Control resource access based on tags Policy best practices Identity-based policies determine whether someone can create, access, or delete Amazon Location resources in your account. These actions can incur costs for your AWS account. When you create or edit identity-based policies, follow these guidelines and recommendations: • Get started with AWS managed policies and move toward least-privilege permissions – To get started granting permissions to your users and workloads, use the AWS managed policies that grant permissions for many common use cases. They are available in your AWS account. We recommend that you reduce permissions further by defining AWS customer managed policies that are specific to your use cases. For more information, see AWS managed policies or AWS managed policies for job functions in the IAM User Guide. • Apply least-privilege permissions – When you set permissions with IAM policies, grant only the permissions required to perform a task. You do this by defining the actions that can be taken on specific resources under specific conditions, also known as least-privilege permissions. For more information about using IAM to apply permissions, see Policies and permissions in IAM in the IAM User Guide. • Use conditions in IAM policies to further restrict access – You can add a condition to your policies to limit access to actions and resources. For example, you can write a policy condition to specify that all requests must be sent using SSL. You can also use conditions to grant access to service actions if they are used through a specific AWS service, such as AWS CloudFormation. For more information, see IAM JSON policy elements: Condition in the IAM User Guide. • Use IAM Access Analyzer to validate your IAM policies to ensure secure and functional |
amazon-location-developer-guide-034 | amazon-location-developer-guide.pdf | 34 | IAM User Guide. • Use conditions in IAM policies to further restrict access – You can add a condition to your policies to limit access to actions and resources. For example, you can write a policy condition to specify that all requests must be sent using SSL. You can also use conditions to grant access to service actions if they are used through a specific AWS service, such as AWS CloudFormation. For more information, see IAM JSON policy elements: Condition in the IAM User Guide. • Use IAM Access Analyzer to validate your IAM policies to ensure secure and functional permissions – IAM Access Analyzer validates new and existing policies so that the policies adhere to the IAM policy language (JSON) and IAM best practices. IAM Access Analyzer provides Identity-based policy examples 101 Amazon Location Service Developer Guide more than 100 policy checks and actionable recommendations to help you author secure and functional policies. For more information, see Validate policies with IAM Access Analyzer in the IAM User Guide. • Require multi-factor authentication (MFA) – If you have a scenario that requires IAM users or a root user in your AWS account, turn on MFA for additional security. To require MFA when API operations are called, add MFA conditions to your policies. For more information, see Secure API access with MFA in the IAM User Guide. For more information about best practices in IAM, see Security best practices in IAM in the IAM User Guide. Using the Amazon Location console To access the Amazon Location Service console, you must have a minimum set of permissions. These permissions must allow you to list and view details about the Amazon Location resources in your AWS account. If you create an identity-based policy that is more restrictive than the minimum required permissions, the console won't function as intended for entities (users or roles) with that policy. You don't need to allow minimum console permissions for users that are making calls only to the AWS CLI or the AWS API. Instead, allow access to only the actions that match the API operation that they're trying to perform. To ensure that users and roles can use the Amazon Location console, attach the following policy to the entities. For more information, see Adding permissions to a user in the IAM User Guide. The following policy gives access to the Amazon Location Service console, to be able to create, delete, list and view details about Amazon Location resources in your AWS account. { "Version": "2012-10-17", "Statement": [ { "Sid": "GeoPowerUser", "Effect": "Allow", "Action": [ "geo:*", "geo-maps:*", "geo-places:*", "geo-routes:*" Identity-based policy examples 102 Amazon Location Service ], "Resource": "*" } ] } Developer Guide Alternatively, you can grant read-only permissions to facilitate read-only access. With read-only permissions, an error message will appear if the user attempts write actions such as creating or deleting resources. As an example, see the section called “Read-only policy for trackers” Allow users to view their own permissions This example shows how you might create a policy that allows IAM users to view the inline and managed policies that are attached to their user identity. This policy includes permissions to complete this action on the console or programmatically using the AWS CLI or AWS API. { "Version": "2012-10-17", "Statement": [ { "Sid": "ViewOwnUserInfo", "Effect": "Allow", "Action": [ "iam:GetUserPolicy", "iam:ListGroupsForUser", "iam:ListAttachedUserPolicies", "iam:ListUserPolicies", "iam:GetUser" ], "Resource": ["arn:aws:iam::*:user/${aws:username}"] }, { "Sid": "NavigateInConsole", "Effect": "Allow", "Action": [ "iam:GetGroupPolicy", "iam:GetPolicyVersion", "iam:GetPolicy", "iam:ListAttachedGroupPolicies", "iam:ListGroupPolicies", "iam:ListPolicyVersions", "iam:ListPolicies", "iam:ListUsers" Identity-based policy examples 103 Amazon Location Service ], "Resource": "*" } ] } Developer Guide Using Amazon Location Service resources in policy Amazon Location Service uses the following prefixes for resources: Amazon Location resource prefix Resource Map resources Place resources Route resources Resource prefix map place-index route-calculator Tracking resources tracker Geofence Collection resources geofence-collection Use the following ARN syntax: arn:Partition:geo:Region:Account:ResourcePrefix/ResourceName For more information about the format of ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces. Examples • Use the following ARN to allow access to a specified map resource. "Resource": "arn:aws:geo:us-west-2:account-id:map/map-resource-name" • To specify access to all map resources that belong to a specific account, use the wildcard (*): "Resource": "arn:aws:geo:us-west-2:account-id:map/*" Identity-based policy examples 104 Amazon Location Service Developer Guide • Some Amazon Location actions, such as those for creating resources, can't be performed on a specific resource. In those cases, you must use the wildcard (*). "Resource": "*" To see a list of Amazon Location resource types and their ARNs, see Resources Defined by Amazon Location Service in the Service Authorization Reference. To learn with which actions you can specify the ARN of each resource, see Actions Defined by Amazon Location Service. Permissions for updating device positions To update device positions for multiple trackers, you'll want to grant a user access to one or more of your tracker resources. You |
amazon-location-developer-guide-035 | amazon-location-developer-guide.pdf | 35 | Some Amazon Location actions, such as those for creating resources, can't be performed on a specific resource. In those cases, you must use the wildcard (*). "Resource": "*" To see a list of Amazon Location resource types and their ARNs, see Resources Defined by Amazon Location Service in the Service Authorization Reference. To learn with which actions you can specify the ARN of each resource, see Actions Defined by Amazon Location Service. Permissions for updating device positions To update device positions for multiple trackers, you'll want to grant a user access to one or more of your tracker resources. You will also want to allow the user to update a batch of device positions. In this example, in addition to granting access to the Tracker1 and Tracker2 resources, the following policy grants permission to use the geo:BatchUpdateDevicePosition action against the Tracker1 and Tracker2 resources. { "Version": "2012-10-17", "Statement": [ { "Sid": "UpdateDevicePositions", "Effect": "Allow", "Action": [ "geo:BatchUpdateDevicePosition" ], "Resource": [ "arn:aws:geo:us-west-2:account-id:tracker/Tracker1", "arn:aws:geo:us-west-2:account-id:tracker/Tracker2" ] } ] } If you want to limit the user to only be able to update device positions for a specific device, you can add a condition key for that device id. { "Version": "2012-10-17", Identity-based policy examples 105 Developer Guide Amazon Location Service "Statement": [ { "Sid": "UpdateDevicePositions", "Effect": "Allow", "Action": [ "geo:BatchUpdateDevicePosition" ], "Resource": [ "arn:aws:geo:us-west-2:account-id:tracker/Tracker1", "arn:aws:geo:us-west-2:account-id:tracker/Tracker2" ], "Condition":{ "ForAllValues:StringLike":{ "geo:DeviceIds":[ "deviceId" ] } } } ] } Read-only policy for tracker resources To create a read-only policy for all tracker resources in your AWS account, you'll need to grant access to all tracker resources. You'll also want to grant a user access to actions that allow them to get the device position for multiple devices, get the device position from a single device and get the position history. In this example, the following policy grants permission to the following actions: • geo:BatchGetDevicePosition to retrieve the position of multiple devices. • geo:GetDevicePosition to retrieve the position of a single device. • geo:GetDevicePositionHistory to retrieve the position history of a device. { "Version": "2012-10-17", "Statement": [ { "Sid": "GetDevicePositions", "Effect": "Allow", Identity-based policy examples 106 Amazon Location Service "Action": [ "geo:BatchGetDevicePosition", "geo:GetDevicePosition", "geo:GetDevicePositionHistory" ], "Resource": "arn:aws:geo:us-west-2:account-id:tracker/*" Developer Guide } ] } Policy for creating geofences To create a policy to allow a user to create geofences, you'll need to grant access to specific actions that allow users to create one or more geofences on a geofence collection. The policy below grants permission to the following actions on Collection: • geo:BatchPutGeofence to create multiple geofences. • geo:PutGeofence to create a single geofence. { "Version": "2012-10-17", "Statement": [ { "Sid": "CreateGeofences", "Effect": "Allow", "Action": [ "geo:BatchPutGeofence", "geo:PutGeofence" ], "Resource": "arn:aws:geo:us-west-2:account-id:geofence-collection/Collection" } ] } Read-only policy for geofences To create a read-only policy for geofences stored in a geofence collection in your AWS account, you'll need to grant access to actions that read from the geofence collection storing the geofences. The policy below grants permission to the following actions on Collection: Identity-based policy examples 107 Amazon Location Service Developer Guide • geo:ListGeofences to list geofences in the specified geofence collection. • geo:GetGeofence to retrieve a geofence from the geofence collection. { "Version": "2012-10-17", "Statement": [ { "Sid": "GetGeofences", "Effect": "Allow", "Action": [ "geo:ListGeofences", "geo:GetGeofence" ], "Resource": "arn:aws:geo:us-west-2:account-id:geofence-collection/Collection" } ] } Permissions for rendering a map resource To grant sufficient permissions to render maps, you'll need to grant access to map tiles, sprites, glyphs, and the style descriptor: • geo:GetMapTile retrieves map tiles used to selectively render features on a map. • geo:GetMapSprites retrieves the PNG sprite sheet and corresponding JSON document describing offsets within it. • geo:GetMapGlyphs retrieves the glyphs used for displaying text. • geo:GetMapStyleDescriptor retrieves the map’s style descriptor, containing rendering rules. { "Version": "2012-10-17", "Statement": [ { "Sid": "GetTiles", "Effect": "Allow", "Action": [ "geo:GetMapTile", "geo:GetMapSprites", "geo:GetMapGlyphs", Identity-based policy examples 108 Amazon Location Service Developer Guide "geo:GetMapStyleDescriptor" ], "Resource": "arn:aws:geo:us-west-2:account-id:map/Map" } ] } Permissions to allow search operations To create a policy to allow search operations, you'll first need to grant access to the place index resource in your AWS account. You'll also want to grant access to actions that let the user search using text by geocoding and search using a position by reverse geocoding. In this example, in addition to granting access to PlaceIndex, the following policy also grants permission to the following actions: • geo:SearchPlaceIndexForPosition allows you to search for places, or points of interest near a given position. • geo:SearchPlaceIndexForText allows you to search for an address, name, city or region using free-form text. { "Version": "2012-10-17", "Statement": [ { "Sid": "Search", "Effect": "Allow", "Action": [ "geo:SearchPlaceIndexForPosition", "geo:SearchPlaceIndexForText" ], "Resource": "arn:aws:geo:us-west-2:account-id:place-index/PlaceIndex" } ] } Read-only policy for route calculators You can create a read-only policy to allow a user access to a route calculator resource to calculate a route. Identity-based policy examples 109 |
amazon-location-developer-guide-036 | amazon-location-developer-guide.pdf | 36 | this example, in addition to granting access to PlaceIndex, the following policy also grants permission to the following actions: • geo:SearchPlaceIndexForPosition allows you to search for places, or points of interest near a given position. • geo:SearchPlaceIndexForText allows you to search for an address, name, city or region using free-form text. { "Version": "2012-10-17", "Statement": [ { "Sid": "Search", "Effect": "Allow", "Action": [ "geo:SearchPlaceIndexForPosition", "geo:SearchPlaceIndexForText" ], "Resource": "arn:aws:geo:us-west-2:account-id:place-index/PlaceIndex" } ] } Read-only policy for route calculators You can create a read-only policy to allow a user access to a route calculator resource to calculate a route. Identity-based policy examples 109 Amazon Location Service Developer Guide In this example, in addition to granting access to ExampleCalculator, the following policy grants permission to the following operation: • geo:CalculateRoute calculates a route given a departure position, destination positon, and a list of waypoint positions. { "Version": "2012-10-17", "Statement": [ { "Sid": "RoutesReadOnly", "Effect": "Allow", "Action": [ "geo:CalculateRoute" ], "Resource": "arn:aws:geo:us-west-2:accountID:route-calculator/ExampleCalculator" } ] } Control resource access based on condition keys When you create an IAM policy to grant access to use geofences or device positions, you can use Condition operators for more precise control over which geofences or devices a user can access. You can do this by including the geofence id or device id in the Condition element of your policy. The following example policy shows how you might create a policy that allows a user to update device positions for a specific device. { "Version": "2012-10-17", "Statement": [ { "Sid": "UpdateDevicePositions", "Effect": "Allow", "Action": [ "geo:BatchUpdateDevicePosition" ], "Resource": [ "arn:aws:geo:us-west-2:account-id:tracker/Tracker" ], Identity-based policy examples 110 Developer Guide Amazon Location Service "Condition":{ "ForAllValues:StringLike":{ "geo:DeviceIds":[ "deviceId" ] } } } ] } Control resource access based on tags When you create an IAM policy to grant access to use your Amazon Location resources, you can use attribute-based access control for better control over which resources a user can modify, use, or delete. You can do this by including tag information in the Condition element of your policy to control access based on your resource tags. The following example policy shows how you might create a policy that allows a user to create geofences. This grants the permission to the following actions to create one or more geofences on a geofence collection called Collection: • geo:BatchPutGeofence to create multiple geofences. • geo:PutGeofence to create a single geofence. However, this policy uses the Condition element to grant the permission only if the Collection tag, Owner, has the value of that user's user name. • For example, if a user named richard-roe attempts to view an Amazon Location Collection, the Collection must be tagged Owner=richard-roe or owner=richard-roe. Otherwise the user is denied access. Note The condition tag key Owner matches both Owner and owner because condition key names are not case-sensitive. For more information, see IAM JSON Policy Elements: Condition in the IAM User Guide. Identity-based policy examples 111 Amazon Location Service Developer Guide { "Version": "2012-10-17", "Statement": [ { "Sid": "CreateGeofencesIfOwner", "Effect": "Allow", "Action": [ "geo:BatchPutGeofence", "geo:PutGeofence" ], "Resource": "arn:aws:geo:us-west-2:account-id:geofence-collection/Collection", "Condition": { "StringEquals": {"geo:ResourceTag/Owner": "${aws:username}"} } } ] } For a tutorial about how to define permissions to access AWS resources based on tags, see the AWS Identity and Access Management User Guide. Troubleshooting Amazon Location Service identity and access Use the following information to help you diagnose and fix common issues that you might encounter when working with Amazon Location and IAM. Topics • I am not authorized to perform an action in Amazon Location • I am not authorized to perform iam:PassRole • I want to allow people outside of my AWS account to access my Amazon Location resources I am not authorized to perform an action in Amazon Location If you receive an error that you're not authorized to perform an action, your policies must be updated to allow you to perform the action. The following example error occurs when the mateojackson IAM user tries to use the console to view details about a fictional my-example-widget resource but doesn't have the fictional geo:GetWidget permissions. Troubleshooting 112 Amazon Location Service Developer Guide User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: geo:GetWidget on resource: my-example-widget In this case, the policy for the mateojackson user must be updated to allow access to the my- example-widget resource by using the geo:GetWidget action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. I am not authorized to perform iam:PassRole If you receive an error that you're not authorized to perform the iam:PassRole action, your policies must be updated to allow you to pass a role to Amazon Location. Some AWS services allow you to pass an existing role to that service instead of creating a new service role or service-linked role. To do this, you must have |
amazon-location-developer-guide-037 | amazon-location-developer-guide.pdf | 37 | be updated to allow access to the my- example-widget resource by using the geo:GetWidget action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. I am not authorized to perform iam:PassRole If you receive an error that you're not authorized to perform the iam:PassRole action, your policies must be updated to allow you to pass a role to Amazon Location. Some AWS services allow you to pass an existing role to that service instead of creating a new service role or service-linked role. To do this, you must have permissions to pass the role to the service. The following example error occurs when an IAM user named marymajor tries to use the console to perform an action in Amazon Location. However, the action requires the service to have permissions that are granted by a service role. Mary does not have permissions to pass the role to the service. User: arn:aws:iam::123456789012:user/marymajor is not authorized to perform: iam:PassRole In this case, Mary's policies must be updated to allow her to perform the iam:PassRole action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. I want to allow people outside of my AWS account to access my Amazon Location resources You can create a role that users in other accounts or people outside of your organization can use to access your resources. You can specify who is trusted to assume the role. For services that support resource-based policies or access control lists (ACLs), you can use those policies to grant people access to your resources. To learn more, consult the following: Troubleshooting 113 Amazon Location Service Developer Guide • To learn whether Amazon Location supports these features, see How Amazon Location Service works with IAM. • To learn how to provide access to your resources across AWS accounts that you own, see Providing access to an IAM user in another AWS account that you own in the IAM User Guide. • To learn how to provide access to your resources to third-party AWS accounts, see Providing access to AWS accounts owned by third parties in the IAM User Guide. • To learn how to provide access through identity federation, see Providing access to externally authenticated users (identity federation) in the IAM User Guide. • To learn the difference between using roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. Troubleshooting 114 Amazon Location Service Developer Guide Amazon Location Service Maps The Amazon Location Service Map gives you access to the underlying base map data for 190 countries with 5 million daily updates. Through both static and dynamic map capabilities, you gain flexibility to cater to diverse user needs and deliver immersive, contextually relevant mapping solutions. Static maps offer pre-rendered representations of geographic data, enabling you to embed high- quality visuals that enhance reports and provide spatial context in emails. Dynamic maps allow you to create interactive and responsive experiences, where users can pan, zoom, and explore the map in real-time, aligning with the requirements and preferences of your business. Whether you're showing real-time turn-by-turn navigation, visualizing location-based data, or enabling users to explore new areas, Amazon’s services equip you with the tools to deliver tailored solutions that resonate with your audience. Features The Amazon Location Service offers dynamic maps and static maps. Dynamic maps You can use AWS Map Styles such as standard, monochrome, hybrid, and satellite. You can add an interactive map to your application using AWS Map Styles with a map rendering engine such as MapLibre. Dynamic maps also support map gestures such as zoom, pan, ease, fly, pitch, rotate, and bearing. Static maps You can use static map URLs to embed simple map images on your website, report, or email without the need for a map rendering engine. Static maps allow you to overlay markers (or pins), routes, and polygon areas as needed for your application. Features 115 Amazon Location Service Political view Developer Guide To switch from the international perspective to a country-specific geopolitical view, use the political view parameter in your API query. This helps businesses comply with local laws, as certain countries require adherence to their specific geopolitical views for maps and map data. Common use cases Embed maps in your application Build maps into your applications to create location-based experiences. Visualize business locations, search for points of interest, and help users find specific addresses. Enable seamless location sharing and geotagging features to engage your customers. Use comprehensive map data, robust geocoding, and flexible rendering to create customized, interactive maps tailored to your needs. Integrate dynamic, high-quality mapping experiences that drive user engagement and business insights into your application, whether you're building a directory, ride-sharing |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.