Lists the rules for the condition. For more information about conditions, see Stage conditions. For more information about rules, see the CodePipeline rule reference.
" + "documentation":"Lists the rules for the condition. For more information about conditions, see Stage conditions and How do stage conditions work?.For more information about rules, see the CodePipeline rule reference.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -390,7 +390,7 @@ {"shape":"NotLatestPipelineExecutionException"}, {"shape":"ConcurrentPipelineExecutionsLimitExceededException"} ], - "documentation":"Used to override a stage condition.
" + "documentation":"Used to override a stage condition. For more information about conditions, see Stage conditions and How do stage conditions work?.
" }, "PollForJobs":{ "name":"PollForJobs", @@ -950,6 +950,10 @@ "timeoutInMinutes":{ "shape":"ActionTimeout", "documentation":"A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in Quotas for CodePipeline . This attribute is available only to the manual approval ActionType.
" + }, + "environmentVariables":{ + "shape":"EnvironmentVariableList", + "documentation":"The environment variables for the action.
" } }, "documentation":"Represents information about an action declaration.
" @@ -1763,7 +1767,7 @@ "documentation":"The conditions that are configured as entry conditions.
" } }, - "documentation":"The conditions for making checks for entry to a stage.
" + "documentation":"The conditions for making checks for entry to a stage. For more information about conditions, see Stage conditions and How do stage conditions work?.
" }, "BlockerDeclaration":{ "type":"structure", @@ -1848,7 +1852,7 @@ "documentation":"The rules that make up the condition.
" } }, - "documentation":"The condition for the stage. A condition is made up of the rules and the result for the condition. For more information about conditions, see Stage conditions. For more information about rules, see the CodePipeline rule reference.
" + "documentation":"The condition for the stage. A condition is made up of the rules and the result for the condition. For more information about conditions, see Stage conditions and How do stage conditions work?.. For more information about rules, see the CodePipeline rule reference.
" }, "ConditionExecution":{ "type":"structure", @@ -2208,6 +2212,42 @@ "type":"string", "enum":["KMS"] }, + "EnvironmentVariable":{ + "type":"structure", + "required":[ + "name", + "value" + ], + "members":{ + "name":{ + "shape":"EnvironmentVariableName", + "documentation":"The environment variable name in the key-value pair.
" + }, + "value":{ + "shape":"EnvironmentVariableValue", + "documentation":"The environment variable value in the key-value pair.
" + } + }, + "documentation":"The environment variables for the action.
" + }, + "EnvironmentVariableList":{ + "type":"list", + "member":{"shape":"EnvironmentVariable"}, + "max":10, + "min":1 + }, + "EnvironmentVariableName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[A-Za-z0-9_]+" + }, + "EnvironmentVariableValue":{ + "type":"string", + "max":2000, + "min":1, + "pattern":".*" + }, "ErrorDetails":{ "type":"structure", "members":{ @@ -2315,10 +2355,10 @@ }, "conditions":{ "shape":"ConditionList", - "documentation":"The conditions that are configured as failure conditions.
" + "documentation":"The conditions that are configured as failure conditions. For more information about conditions, see Stage conditions and How do stage conditions work?.
" } }, - "documentation":"The configuration that specifies the result, such as rollback, to occur upon stage failure.
" + "documentation":"The configuration that specifies the result, such as rollback, to occur upon stage failure. For more information about conditions, see Stage conditions and How do stage conditions work?.
" }, "FailureDetails":{ "type":"structure", @@ -2633,7 +2673,7 @@ "members":{ "events":{ "shape":"GitPullRequestEventTypeList", - "documentation":"The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration.
" + "documentation":"The field that specifies which pull request events to filter on (OPEN, UPDATED, CLOSED) for the trigger configuration.
" }, "branches":{ "shape":"GitBranchFilterCriteria", @@ -2644,7 +2684,7 @@ "documentation":"The field that specifies to filter on file paths for the pull request trigger configuration.
" } }, - "documentation":"The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude.
" + "documentation":"The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude.
The following are valid values for the events for this filter:
CLOSED
OPEN
UPDATED
The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState action. It is used to validate that the approval request corresponding to this token is still valid.
For a pipeline where the execution mode is set to PARALLEL, the token required to approve/reject approval request as detailed above is not available. Instead, use the externalExecutionId from the GetPipelineState action as the token in the approval request.
The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState action. It is used to validate that the approval request corresponding to this token is still valid.
For a pipeline where the execution mode is set to PARALLEL, the token required to approve/reject an approval request as detailed above is not available. Instead, use the externalExecutionId in the response output from the ListActionExecutions action as the token in the approval request.
Represents the input of a PutApprovalResult action.
The action timeout for the rule.
" } }, - "documentation":"Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage. For more information about conditions, see Stage conditions. For more information about rules, see the CodePipeline rule reference.
" + "documentation":"Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage. For more information about conditions, see Stage conditions and How do stage conditions work?. For more information about rules, see the CodePipeline rule reference.
" }, "RuleDeclarationList":{ "type":"list", @@ -4579,7 +4619,7 @@ "members":{ "ruleTypeId":{ "shape":"RuleTypeId", - "documentation":"The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
" + "documentation":"The ID for the rule type, which is made up of the combined values for category, owner, provider, and version. For more information about conditions, see Stage conditions. For more information about rules, see the CodePipeline rule reference.
" }, "configuration":{ "shape":"RuleConfigurationMap", @@ -4763,14 +4803,14 @@ }, "provider":{ "shape":"RuleProvider", - "documentation":"The rule provider, such as the DeploymentWindow rule.
The rule provider, such as the DeploymentWindow rule. For a list of rule provider names, see the rules listed in the CodePipeline rule reference.
A string that describes the rule version.
" } }, - "documentation":"The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
" + "documentation":"The ID for the rule type, which is made up of the combined values for category, owner, provider, and version. For more information about conditions, see Stage conditions. For more information about rules, see the CodePipeline rule reference.
" }, "RuleTypeList":{ "type":"list", @@ -5228,7 +5268,7 @@ "documentation":"The conditions that are success conditions.
" } }, - "documentation":"The conditions for making checks that, if met, succeed a stage.
" + "documentation":"The conditions for making checks that, if met, succeed a stage. For more information about conditions, see Stage conditions and How do stage conditions work?.
" }, "Tag":{ "type":"structure", From 66cec705d69d2e52ff5b933b18d49945899c7277 Mon Sep 17 00:00:00 2001 From: AWS <> Date: Wed, 19 Feb 2025 19:12:10 +0000 Subject: [PATCH 04/11] Amazon Location Service Update: Adds support for larger property maps for tracking and geofence positions changes. It increases the maximum number of items from 3 to 4, and the maximum value length from 40 to 150. --- ...feature-AmazonLocationService-cda6a96.json | 6 + .../codegen-resources/service-2.json | 124 ++++++++++++------ 2 files changed, 92 insertions(+), 38 deletions(-) create mode 100644 .changes/next-release/feature-AmazonLocationService-cda6a96.json diff --git a/.changes/next-release/feature-AmazonLocationService-cda6a96.json b/.changes/next-release/feature-AmazonLocationService-cda6a96.json new file mode 100644 index 000000000000..001994fc6858 --- /dev/null +++ b/.changes/next-release/feature-AmazonLocationService-cda6a96.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "Amazon Location Service", + "contributor": "", + "description": "Adds support for larger property maps for tracking and geofence positions changes. It increases the maximum number of items from 3 to 4, and the maximum value length from 40 to 150." +} diff --git a/services/location/src/main/resources/codegen-resources/service-2.json b/services/location/src/main/resources/codegen-resources/service-2.json index c9deaf2ba2b2..87fca0df3e37 100644 --- a/services/location/src/main/resources/codegen-resources/service-2.json +++ b/services/location/src/main/resources/codegen-resources/service-2.json @@ -2,6 +2,7 @@ "version":"2.0", "metadata":{ "apiVersion":"2020-11-19", + "auth":["aws.auth#sigv4"], "endpointPrefix":"geo", "protocol":"rest-json", "protocols":["rest-json"], @@ -1238,7 +1239,7 @@ "ApiKeyRestrictionsAllowActionsList":{ "type":"list", "member":{"shape":"ApiKeyAction"}, - "max":7, + "max":24, "min":1 }, "ApiKeyRestrictionsAllowReferersList":{ @@ -1250,7 +1251,7 @@ "ApiKeyRestrictionsAllowResourcesList":{ "type":"list", "member":{"shape":"GeoArnV2"}, - "max":5, + "max":8, "min":1 }, "Arn":{ @@ -2146,13 +2147,15 @@ "shape":"PricingPlan", "documentation":"No longer used. If included, the only allowed value is RequestBasedUsage.
This parameter is no longer used.
", "deprecated":true, - "deprecatedMessage":"Deprecated. No longer allowed." + "deprecatedMessage":"Deprecated. No longer allowed.", + "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", @@ -2269,7 +2272,8 @@ "shape":"PricingPlan", "documentation":"No longer used. If included, the only allowed value is RequestBasedUsage.
No longer used. If included, the only allowed value is RequestBasedUsage.
No longer used. If included, the only allowed value is RequestBasedUsage.
No longer used. If included, the only allowed value is RequestBasedUsage.
This parameter is no longer used.
", "deprecated":true, - "deprecatedMessage":"Deprecated. No longer allowed." + "deprecatedMessage":"Deprecated. No longer allowed.", + "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", @@ -2649,13 +2657,15 @@ "shape":"PricingPlan", "documentation":"No longer used. Always returns RequestBasedUsage.
No longer used. Always returns an empty string.
", "deprecated":true, - "deprecatedMessage":"Deprecated. Unused." + "deprecatedMessage":"Deprecated. Unused.", + "deprecatedSince":"2022-02-01" }, "KmsKeyId":{ "shape":"KmsKeyId", @@ -2779,7 +2789,8 @@ "shape":"PricingPlan", "documentation":"No longer used. Always returns RequestBasedUsage.
No longer used. Always returns RequestBasedUsage.
Always returns RequestBasedUsage.
Always returns RequestBasedUsage.
No longer used. Always returns an empty string.
", "deprecated":true, - "deprecatedMessage":"Deprecated. Unused." + "deprecatedMessage":"Deprecated. Unused.", + "deprecatedSince":"2022-02-01" }, "Tags":{ "shape":"TagMap", @@ -3035,7 +3050,7 @@ "documentation":"The accuracy of the device position.
" }, "PositionProperties":{ - "shape":"PropertyMap", + "shape":"PositionPropertyMap", "documentation":"The properties associated with the position.
" } }, @@ -3070,7 +3085,7 @@ "documentation":"The accuracy of the device position.
" }, "PositionProperties":{ - "shape":"PropertyMap", + "shape":"PositionPropertyMap", "documentation":"Associates one of more properties with the position update. A property is a key-value pair stored with the position update and added to any geofence event the update may trigger.
Format: \"key\" : \"value\"
The accuracy of the device position.
" }, "PositionProperties":{ - "shape":"PropertyMap", + "shape":"PositionPropertyMap", "documentation":"The properties associated with the position.
" } } @@ -4010,7 +4025,7 @@ "documentation":"The accuracy of the device position.
" }, "PositionProperties":{ - "shape":"PropertyMap", + "shape":"PositionPropertyMap", "documentation":"The properties associated with the position.
" } }, @@ -4074,13 +4089,15 @@ "shape":"PricingPlan", "documentation":"No longer used. Always returns RequestBasedUsage.
No longer used. Always returns an empty string.
", "deprecated":true, - "deprecatedMessage":"Deprecated. Unused." + "deprecatedMessage":"Deprecated. Unused.", + "deprecatedSince":"2022-02-01" }, "CreateTime":{ "shape":"Timestamp", @@ -4312,7 +4329,8 @@ "shape":"PricingPlan", "documentation":"No longer used. Always returns RequestBasedUsage.
No longer used. Always returns RequestBasedUsage.
Always returns RequestBasedUsage.
Always returns RequestBasedUsage.
No longer used. Always returns an empty string.
", "deprecated":true, - "deprecatedMessage":"Deprecated. Unused." + "deprecatedMessage":"Deprecated. Unused.", + "deprecatedSince":"2022-02-01" }, "CreateTime":{ "shape":"Timestamp", @@ -4930,6 +4952,24 @@ "AccuracyBased" ] }, + "PositionPropertyMap":{ + "type":"map", + "key":{"shape":"PositionPropertyMapKeyString"}, + "value":{"shape":"PositionPropertyMapValueString"}, + "max":4, + "min":0, + "sensitive":true + }, + "PositionPropertyMapKeyString":{ + "type":"string", + "max":20, + "min":1 + }, + "PositionPropertyMapValueString":{ + "type":"string", + "max":150, + "min":1 + }, "PositionalAccuracy":{ "type":"structure", "required":["Horizontal"], @@ -5633,7 +5673,7 @@ "type":"string", "max":128, "min":1, - "pattern":"[a-zA-Z+-=._:/]+" + "pattern":"([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)" }, "TagKeys":{ "type":"list", @@ -5676,7 +5716,7 @@ "type":"string", "max":256, "min":0, - "pattern":"[A-Za-z0-9 _=@:.+-/]*" + "pattern":"([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)" }, "ThrottlingException":{ "type":"structure", @@ -5835,13 +5875,15 @@ "shape":"PricingPlan", "documentation":"No longer used. If included, the only allowed value is RequestBasedUsage.
This parameter is no longer used.
", "deprecated":true, - "deprecatedMessage":"Deprecated. No longer allowed." + "deprecatedMessage":"Deprecated. No longer allowed.", + "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", @@ -5939,7 +5981,8 @@ "shape":"PricingPlan", "documentation":"No longer used. If included, the only allowed value is RequestBasedUsage.
No longer used. If included, the only allowed value is RequestBasedUsage.
No longer used. If included, the only allowed value is RequestBasedUsage.
No longer used. If included, the only allowed value is RequestBasedUsage.
This parameter is no longer used.
", "deprecated":true, - "deprecatedMessage":"Deprecated. No longer allowed." + "deprecatedMessage":"Deprecated. No longer allowed.", + "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", @@ -6192,7 +6239,8 @@ "Missing", "CannotParse", "FieldValidationFailed", - "Other" + "Other", + "UnknownField" ] }, "VehicleWeightUnit":{ @@ -6283,7 +6331,7 @@ "type":"string", "max":17, "min":12, - "pattern":"([0-9A-Fa-f]{2}[:-]?){5}([0-9A-Fa-f]{2})" + "pattern":"([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})" }, "WiFiAccessPointRssInteger":{ "type":"integer", From a991e789fa80f41da33df1dd2e8a6b13e2a0117c Mon Sep 17 00:00:00 2001 From: AWS <> Date: Wed, 19 Feb 2025 19:12:11 +0000 Subject: [PATCH 05/11] Amazon Lightsail Update: Documentation updates for Amazon Lightsail. --- .../feature-AmazonLightsail-a8d559f.json | 6 + .../codegen-resources/service-2.json | 260 +++++++++--------- 2 files changed, 136 insertions(+), 130 deletions(-) create mode 100644 .changes/next-release/feature-AmazonLightsail-a8d559f.json diff --git a/.changes/next-release/feature-AmazonLightsail-a8d559f.json b/.changes/next-release/feature-AmazonLightsail-a8d559f.json new file mode 100644 index 000000000000..cf00b6607b63 --- /dev/null +++ b/.changes/next-release/feature-AmazonLightsail-a8d559f.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "Amazon Lightsail", + "contributor": "", + "description": "Documentation updates for Amazon Lightsail." +} diff --git a/services/lightsail/src/main/resources/codegen-resources/service-2.json b/services/lightsail/src/main/resources/codegen-resources/service-2.json index 665fb211e034..fa80fe96e106 100644 --- a/services/lightsail/src/main/resources/codegen-resources/service-2.json +++ b/services/lightsail/src/main/resources/codegen-resources/service-2.json @@ -68,7 +68,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
The attach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Amazon Lightsail Developer Guide.
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
The attach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Amazon Lightsail Developer Guide.
Attaches one or more Lightsail instances to a load balancer.
After some time, the instances are attached to the load balancer and the health check status is available.
The attach instances to load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Developer Guide.
Attaches one or more Lightsail instances to a load balancer.
After some time, the instances are attached to the load balancer and the health check status is available.
The attach instances to load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Developer Guide.
Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL).
Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate action with the non-attached certificate, and it will replace the existing one and become the attached certificate.
The AttachLoadBalancerTlsCertificate 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.
Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL).
Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate action with the non-attached certificate, and it will replace the existing one and become the attached certificate.
The AttachLoadBalancerTlsCertificate 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.
Closes ports for a specific Amazon Lightsail instance.
The CloseInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Amazon Lightsail Developer Guide.
Closes ports for a specific Amazon Lightsail instance.
The CloseInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Amazon Lightsail Developer Guide.
Creates an Amazon Lightsail bucket.
A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such as data and its descriptive metadata. For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.
" + "documentation":"Creates an Amazon Lightsail bucket.
A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such as data and its descriptive metadata. For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.
" }, "CreateBucketAccessKey":{ "name":"CreateBucketAccessKey", @@ -196,7 +196,7 @@ {"shape":"ServiceException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key.
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 GetBucketAccessKeys action to get a list of current access keys 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.
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.
Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key.
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 GetBucketAccessKeys action to get a list of current access keys 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.
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.
Creates an email or SMS text message contact method.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
" + "documentation":"Creates an email or SMS text message contact method.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
" }, "CreateContainerService":{ "name":"CreateContainerService", @@ -267,7 +267,7 @@ {"shape":"AccessDeniedException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"Creates an Amazon Lightsail container service.
A Lightsail container service is a compute resource to which you can deploy containers. For more information, see Container services in Amazon Lightsail in the Lightsail Dev Guide.
" + "documentation":"Creates an Amazon Lightsail container service.
A Lightsail container service is a compute resource to which you can deploy containers. For more information, see Container services in Amazon Lightsail in the Lightsail Dev Guide.
" }, "CreateContainerServiceDeployment":{ "name":"CreateContainerServiceDeployment", @@ -284,7 +284,7 @@ {"shape":"AccessDeniedException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"Creates a deployment for your Amazon Lightsail container service.
A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.
You can deploy containers to your container service using container images from a public registry such as Amazon ECR Public, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
" + "documentation":"Creates a deployment for your Amazon Lightsail container service.
A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.
You can deploy containers to your container service using container images from a public registry such as Amazon ECR Public, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
" }, "CreateContainerServiceRegistryLogin":{ "name":"CreateContainerServiceRegistryLogin", @@ -301,7 +301,7 @@ {"shape":"AccessDeniedException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials.
You can only push container images to the container service registry of your Lightsail account. You cannot pull container images or perform any other container image management actions on the container service registry.
After you push your container images to the container image registry of your Lightsail account, use the RegisterContainerImage action to register the pushed images to a specific Lightsail container service.
This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials.
You can only push container images to the container service registry of your Lightsail account. You cannot pull container images or perform any other container image management actions on the container service registry.
After you push your container images to the container image registry of your Lightsail account, use the RegisterContainerImage action to register the pushed images to a specific Lightsail container service.
This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a).
The create disk operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a).
The create disk operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a).
The create disk from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by disk snapshot name. For more information, see the Amazon Lightsail Developer Guide.
Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a).
The create disk from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by disk snapshot name. For more information, see the Amazon Lightsail Developer Guide.
Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.
You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.
You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the instance name parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk.
The create disk snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.
You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.
You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the instance name parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk.
The create disk snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
Creates an Amazon Lightsail content delivery network (CDN) distribution.
A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see Content delivery networks in Amazon Lightsail.
" + "documentation":"Creates an Amazon Lightsail content delivery network (CDN) distribution.
A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see Content delivery networks in Amazon Lightsail.
" }, "CreateDomain":{ "name":"CreateDomain", @@ -395,7 +395,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"Creates a domain resource for the specified domain (example.com).
The create domain operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
Creates a domain resource for the specified domain (example.com).
The create domain operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
The create domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide.
Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
The create domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide.
Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based NICE DCV session to the virtual computer's application. The secondary URL initiates a web-based NICE DCV session to the virtual computer's operating session.
Use StartGUISession to open the session.
Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based Amazon DCV session to the virtual computer's application. The secondary URL initiates a web-based Amazon DCV session to the virtual computer's operating session.
Use StartGUISession to open the session.
Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot.
The create instance snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot.
The create instance snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
Creates one or more Amazon Lightsail instances.
The create instances operation supports tag-based access control via request tags. For more information, see the Lightsail Developer Guide.
Creates one or more Amazon Lightsail instances.
The create instances operation supports tag-based access control via request tags. For more information, see the Lightsail Developer Guide.
Creates one or more new instances from a manual or automatic snapshot of an instance.
The create instances from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by instance snapshot name. For more information, see the Amazon Lightsail Developer Guide.
Creates one or more new instances from a manual or automatic snapshot of an instance.
The create instances from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by instance snapshot name. For more information, see the Amazon Lightsail Developer Guide.
Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.
Use the DownloadDefaultKeyPair action to create a Lightsail default key pair in an Amazon Web Services Region where a default key pair does not currently exist.
The create key pair operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.
Use the DownloadDefaultKeyPair action to create a Lightsail default key pair in an Amazon Web Services Region where a default key pair does not currently exist.
The create key pair operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account.
When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute operation.
The create load balancer operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account.
When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute operation.
The create load balancer operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
The CreateLoadBalancerTlsCertificate 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.
Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
The CreateLoadBalancerTlsCertificate 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.
Creates a new database in Amazon Lightsail.
The create relational database operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
Creates a new database in Amazon Lightsail.
The create relational database operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
Creates a new database from an existing database snapshot in Amazon Lightsail.
You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan.
The create relational database from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more information, see the Amazon Lightsail Developer Guide.
Creates a new database from an existing database snapshot in Amazon Lightsail.
You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan.
The create relational database from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more information, see the Amazon Lightsail Developer Guide.
Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database.
The create relational database snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database.
The create relational database snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
Deletes an 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.
" + "documentation":"Deletes an 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.
" }, "DeleteAutoSnapshot":{ "name":"DeleteAutoSnapshot", @@ -638,7 +638,7 @@ {"shape":"AccessDeniedException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
" + "documentation":"Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
" }, "DeleteBucket":{ "name":"DeleteBucket", @@ -672,7 +672,7 @@ {"shape":"ServiceException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"Deletes an access key for the specified Amazon Lightsail bucket.
We recommend that you delete an access key if the secret access key is compromised.
For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.
" + "documentation":"Deletes an access key for the specified Amazon Lightsail bucket.
We recommend that you delete an access key if the secret access key is compromised.
For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.
" }, "DeleteCertificate":{ "name":"DeleteCertificate", @@ -707,7 +707,7 @@ {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"} ], - "documentation":"Deletes a contact method.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
" + "documentation":"Deletes a contact method.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
" }, "DeleteContainerImage":{ "name":"DeleteContainerImage", @@ -760,7 +760,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"Deletes the specified block storage disk. The disk must be in the available state (not attached to a Lightsail instance).
The disk may remain in the deleting state for several minutes.
The delete disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Amazon Lightsail Developer Guide.
Deletes the specified block storage disk. The disk must be in the available state (not attached to a Lightsail instance).
The disk may remain in the deleting state for several minutes.
The delete disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Amazon Lightsail Developer Guide.
Deletes the specified disk snapshot.
When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.
The delete disk snapshot operation supports tag-based access control via resource tags applied to the resource identified by disk snapshot name. For more information, see the Amazon Lightsail Developer Guide.
Deletes the specified disk snapshot.
When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.
The delete disk snapshot operation supports tag-based access control via resource tags applied to the resource identified by disk snapshot name. For more information, see the Amazon Lightsail Developer Guide.
Deletes the specified domain recordset and all of its domain records.
The delete domain 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.
Deletes the specified domain recordset and all of its domain records.
The delete domain 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.
Deletes a specific domain entry.
The delete 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.
Deletes a specific domain entry.
The delete 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.
Deletes an Amazon Lightsail instance.
The delete instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.
Deletes an Amazon Lightsail instance.
The delete instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.
Deletes a specific snapshot of a virtual private server (or instance).
The delete instance snapshot operation supports tag-based access control via resource tags applied to the resource identified by instance snapshot name. For more information, see the Amazon Lightsail Developer Guide.
Deletes a specific snapshot of a virtual private server (or instance).
The delete instance snapshot operation supports tag-based access control via resource tags applied to the resource identified by instance snapshot name. For more information, see the Amazon Lightsail Developer Guide.
Deletes the specified key pair by removing the public key from Amazon Lightsail.
You can delete key pairs that were created using the ImportKeyPair and CreateKeyPair actions, as well as the Lightsail default key pair. A new default key pair will not be created unless you launch an instance without specifying a custom key pair, or you call the DownloadDefaultKeyPair API.
The delete key pair operation supports tag-based access control via resource tags applied to the resource identified by key pair name. For more information, see the Amazon Lightsail Developer Guide.
Deletes the specified key pair by removing the public key from Amazon Lightsail.
You can delete key pairs that were created using the ImportKeyPair and CreateKeyPair actions, as well as the Lightsail default key pair. A new default key pair will not be created unless you launch an instance without specifying a custom key pair, or you call the DownloadDefaultKeyPair API.
The delete key pair operation supports tag-based access control via resource tags applied to the resource identified by key pair name. For more information, see the Amazon Lightsail Developer Guide.
Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch.
Perform this operation only if you were expecting the host key or certificate mismatch or if you are familiar with the new host key or certificate on the instance. For more information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client.
Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch.
Perform this operation only if you were expecting the host key or certificate mismatch or if you are familiar with the new host key or certificate on the instance. For more information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client.
Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.
The delete load balancer 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.
Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.
The delete load balancer 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.
Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
The DeleteLoadBalancerTlsCertificate 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.
Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
The DeleteLoadBalancerTlsCertificate 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.
Deletes a database in Amazon Lightsail.
The delete 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.
Deletes a database in Amazon Lightsail.
The delete 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.
Deletes a database snapshot in Amazon Lightsail.
The delete relational database snapshot 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.
Deletes a database snapshot in Amazon Lightsail.
The delete relational database snapshot 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.
Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.
The detach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Amazon Lightsail Developer Guide.
Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.
The detach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Amazon Lightsail Developer Guide.
Detaches the specified instances from a Lightsail load balancer.
This operation waits until the instances are no longer needed before they are detached from the load balancer.
The detach instances from load balancer 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.
Detaches the specified instances from a Lightsail load balancer.
This operation waits until the instances are no longer needed before they are detached from the load balancer.
The detach instances from load balancer 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.
Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.
" + "documentation":"Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.
" }, "DownloadDefaultKeyPair":{ "name":"DownloadDefaultKeyPair", @@ -1117,7 +1117,7 @@ {"shape":"AccessDeniedException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.
" + "documentation":"Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.
" }, "ExportSnapshot":{ "name":"ExportSnapshot", @@ -1136,7 +1136,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the create cloud formation stack operation to create new Amazon EC2 instances.
Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot.
The export snapshot operation supports tag-based access control via resource tags applied to the resource identified by source snapshot name. For more information, see the Amazon Lightsail Developer Guide.
Use the get instance snapshots or get disk snapshots operations to get a list of snapshots that you can export to Amazon EC2.
Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the create cloud formation stack operation to create new Amazon EC2 instances.
Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot.
The export snapshot operation supports tag-based access control via resource tags applied to the resource identified by source snapshot name. For more information, see the Amazon Lightsail Developer Guide.
Use the get instance snapshots or get disk snapshots operations to get a list of snapshots that you can export to Amazon EC2.
Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource.
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.
" + "documentation":"Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource.
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.
" }, "GetAutoSnapshots":{ "name":"GetAutoSnapshots", @@ -1191,7 +1191,7 @@ {"shape":"AccessDeniedException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"Returns the available automatic snapshots for an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
" + "documentation":"Returns the available automatic snapshots for an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
" }, "GetBlueprints":{ "name":"GetBlueprints", @@ -1277,7 +1277,7 @@ {"shape":"ServiceException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"Returns information about one or more Amazon Lightsail buckets. The information returned includes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access feature for your Lightsail buckets.
For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.
" + "documentation":"Returns information about one or more Amazon Lightsail buckets. The information returned includes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access feature for your Lightsail buckets.
For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.
" }, "GetBundles":{ "name":"GetBundles", @@ -1350,7 +1350,7 @@ {"shape":"AccessDeniedException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
" + "documentation":"Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
" }, "GetContainerAPIMetadata":{ "name":"GetContainerAPIMetadata", @@ -1727,7 +1727,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
The get instance access details operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
The get instance access details operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.
Returns a list of TLS security policies that you can apply to 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.
" + "documentation":"Returns a list of TLS security policies that you can apply to 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.
" }, "GetLoadBalancers":{ "name":"GetLoadBalancers", @@ -2388,7 +2388,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol.
The OpenInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Amazon Lightsail Developer Guide.
Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol.
The OpenInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Amazon Lightsail Developer Guide.
Creates or updates an alarm, and associates it with the specified metric.
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.
When this action creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration.
" + "documentation":"Creates or updates an alarm, and associates it with the specified metric.
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.
When this action creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration.
" }, "PutInstancePublicPorts":{ "name":"PutInstancePublicPorts", @@ -2444,7 +2444,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol. This action also closes all currently open ports that are not included in the request. Include all of the ports and the protocols you want to open in your PutInstancePublicPortsrequest. Or use the OpenInstancePublicPorts action to open ports without closing currently open ports.
The PutInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Amazon Lightsail Developer Guide.
Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol. This action also closes all currently open ports that are not included in the request. Include all of the ports and the protocols you want to open in your PutInstancePublicPortsrequest. Or use the OpenInstancePublicPorts action to open ports without closing currently open ports.
The PutInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Amazon Lightsail Developer Guide.
Restarts a specific instance.
The reboot instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.
Restarts a specific instance.
The reboot instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.
Restarts a specific database in Amazon Lightsail.
The reboot 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.
Restarts a specific database in Amazon Lightsail.
The reboot 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.
Registers a container image to your Amazon Lightsail container service.
This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
Registers a container image to your Amazon Lightsail container service.
This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
Sends a verification request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be verified.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired.
Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.
Sends a verification request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be verified.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired.
Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.
Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation.
When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.
The start instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.
Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation.
When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.
The start instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.
Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation.
The start 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.
Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation.
The start 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.
Terminates a web-based NICE DCV 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.
" + "documentation":"Terminates a web-based Amazon DCV 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.
" }, "StopInstance":{ "name":"StopInstance", @@ -2698,7 +2698,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"Stops a specific Amazon Lightsail instance that is currently running.
When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.
The stop instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.
Stops a specific Amazon Lightsail instance that is currently running.
When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.
The stop instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.
Stops a specific database that is currently running in Amazon Lightsail.
The stop 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.
Stops a specific database that is currently running in Amazon Lightsail.
If you don't manually start your database instance after it has been stopped for seven consecutive days, Amazon Lightsail automatically starts it for you. This action helps ensure that your database instance doesn't fall behind on any required maintenance updates.
The stop 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.
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.
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.
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.
" + "documentation":"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.
" }, "UnpeerVpc":{ "name":"UnpeerVpc", @@ -2792,7 +2792,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
An object that describes the last time the access key was used.
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.
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.
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.
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.
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.
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.
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.
" + "documentation":"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.
" }, "AccessType":{ "type":"string", @@ -3082,14 +3082,14 @@ }, "message":{ "shape":"BPAStatusMessage", - "documentation":"A message that provides a reason for a Failed or Defaulted synchronization status.
The following messages are possible:
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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services Support for more information.
A message that provides a reason for a Failed or Defaulted synchronization status.
The following messages are possible:
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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web ServicesSupport for more information.
A Boolean value that indicates whether account-level block public access is affecting your Lightsail buckets.
" } }, - "documentation":"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 Amazon Web Services 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.
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 Amazon Web Services 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.
Indicates whether the alarm is enabled.
" } }, - "documentation":"Describes an alarm.
An alarm is a way to monitor your Lightsail resource metrics. For more information, see Alarms in Amazon Lightsail.
" + "documentation":"Describes an alarm.
An alarm is a way to monitor your Lightsail resource metrics. For more information, see Alarms in Amazon Lightsail.
" }, "AlarmState":{ "type":"string", @@ -3711,7 +3711,7 @@ "documentation":"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 will begin with the logs/ prefix in its key (for example, logs/2021-11-01-21-32-16-E568B2907131C0C0).
This parameter can be optionally specified when enabling the access log for a bucket, and should be omitted when disabling the access log.
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.
" + "documentation":"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.
" }, "BucketAccessLogPrefix":{ "type":"string", @@ -3993,7 +3993,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" + "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" }, "supportCode":{ "shape":"string", @@ -4052,7 +4052,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" + "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" } }, "documentation":"Describes an Amazon Lightsail SSL/TLS certificate.
" @@ -4204,7 +4204,7 @@ "documentation":"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.
" } }, - "documentation":"Describes a contact method.
A contact method is a way to send you notifications. For more information, see Notifications in Amazon Lightsail.
" + "documentation":"Describes a contact method.
A contact method is a way to send you notifications. For more information, see Notifications in Amazon Lightsail.
" }, "ContactMethodStatus":{ "type":"string", @@ -4319,7 +4319,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" + "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" }, "power":{ "shape":"ContainerServicePowerName", @@ -4371,7 +4371,7 @@ }, "privateRegistryAccess":{ "shape":"PrivateRegistryAccess", - "documentation":"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.
" + "documentation":"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.
" } }, "documentation":"Describes an Amazon Lightsail container service.
" @@ -4441,7 +4441,7 @@ "documentation":"The Amazon Resource Name (ARN) of the role, if it is activated.
" } }, - "documentation":"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 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 Amazon Web Services 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.
" + "documentation":"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 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 Amazon Web Services 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.
" }, "ContainerServiceECRImagePullerRoleRequest":{ "type":"structure", @@ -4451,7 +4451,7 @@ "documentation":"A Boolean value that indicates whether to activate the role.
" } }, - "documentation":"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 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 Amazon Web Services 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.
" + "documentation":"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 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 Amazon Web Services 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.
" }, "ContainerServiceEndpoint":{ "type":"structure", @@ -4711,15 +4711,15 @@ }, "sourceResourceName":{ "shape":"string", - "documentation":"The name of the source instance or disk from which the source automatic snapshot was created.
Constraint:
Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.
The name of the source instance or disk from which the source automatic snapshot was created.
Constraint:
Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.
The date of the source automatic snapshot to copy. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.
Constraints:
Must be specified in YYYY-MM-DD format.
This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.
Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.
The date of the source automatic snapshot to copy. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.
Constraints:
Must be specified in YYYY-MM-DD format.
This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.
Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.
A Boolean value to indicate whether to use the latest available automatic snapshot of the specified source instance or disk.
Constraints:
This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.
Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.
A Boolean value to indicate whether to use the latest available automatic snapshot of the specified source instance or disk.
Constraints:
This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.
Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.
The name for the bucket.
For more information about bucket names, see Bucket naming rules in Amazon Lightsail in the Amazon Lightsail Developer Guide.
" + "documentation":"The name for the bucket.
For more information about bucket names, see Bucket naming rules in Amazon Lightsail in the Amazon Lightsail Developer Guide.
" }, "bundleId":{ "shape":"NonEmptyString", @@ -4802,7 +4802,7 @@ }, "enableObjectVersioning":{ "shape":"boolean", - "documentation":"A Boolean value that indicates whether to enable versioning of objects in the bucket.
For more information about versioning, see Enabling and suspending object versioning in a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.
" + "documentation":"A Boolean value that indicates whether to enable versioning of objects in the bucket.
For more information about versioning, see Enabling and suspending object versioning in a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.
" } } }, @@ -4885,7 +4885,7 @@ "members":{ "protocol":{ "shape":"ContactProtocol", - "documentation":"The protocol of the contact method, such as Email or SMS (text messaging).
The SMS protocol is supported only in the following Amazon Web Services Regions.
US East (N. Virginia) (us-east-1)
US West (Oregon) (us-west-2)
Europe (Ireland) (eu-west-1)
Asia Pacific (Tokyo) (ap-northeast-1)
Asia Pacific (Singapore) (ap-southeast-1)
Asia Pacific (Sydney) (ap-southeast-2)
For a list of countries/regions where SMS text messages can be sent, and the latest Amazon Web Services Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer Guide.
For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.
" + "documentation":"The protocol of the contact method, such as Email or SMS (text messaging).
The SMS protocol is supported only in the following Amazon Web Services Regions.
US East (N. Virginia) (us-east-1)
US West (Oregon) (us-west-2)
Europe (Ireland) (eu-west-1)
Asia Pacific (Tokyo) (ap-northeast-1)
Asia Pacific (Singapore) (ap-southeast-1)
Asia Pacific (Sydney) (ap-southeast-2)
For a list of countries/regions where SMS text messages can be sent, and the latest Amazon Web Services Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer Guide.
For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.
" }, "contactEndpoint":{ "shape":"StringMax256", @@ -4965,7 +4965,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"The tag keys and optional values to add to the container service during create.
Use the TagResource action to tag a resource after it's created.
For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" + "documentation":"The tag keys and optional values to add to the container service during create.
Use the TagResource action to tag a resource after it's created.
For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" }, "publicDomainNames":{ "shape":"ContainerServicePublicDomains", @@ -4977,7 +4977,7 @@ }, "privateRegistryAccess":{ "shape":"PrivateRegistryAccessRequest", - "documentation":"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.
" + "documentation":"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.
" } } }, @@ -5024,15 +5024,15 @@ }, "sourceDiskName":{ "shape":"string", - "documentation":"The name of the source disk from which the source automatic snapshot was created.
Constraints:
This parameter cannot be defined together with the disk snapshot name parameter. The source disk name and disk snapshot name parameters are mutually exclusive.
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
The name of the source disk from which the source automatic snapshot was created.
Constraints:
This parameter cannot be defined together with the disk snapshot name parameter. The source disk name and disk snapshot name parameters are mutually exclusive.
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
The date of the automatic snapshot to use for the new disk. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.
Constraints:
Must be specified in YYYY-MM-DD format.
This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
The date of the automatic snapshot to use for the new disk. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.
Constraints:
Must be specified in YYYY-MM-DD format.
This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
A Boolean value to indicate whether to use the latest available automatic snapshot.
Constraints:
This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
A Boolean value to indicate whether to use the latest available automatic snapshot.
Constraints:
This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
Returns information about the specified NICE DCV GUI session.
" + "documentation":"Returns information about the specified Amazon DCV GUI session.
" } } }, @@ -5323,7 +5323,7 @@ }, "userData":{ "shape":"string", - "documentation":"You can create a launch script that configures a server with additional user data. For example, apt-get -y update.
Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail Developer Guide.
You can create a launch script that configures a server with additional user data. For example, apt-get -y update.
Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail Developer Guide.
The name of the source instance from which the source automatic snapshot was created.
Constraints:
This parameter cannot be defined together with the instance snapshot name parameter. The source instance name and instance snapshot name parameters are mutually exclusive.
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
The name of the source instance from which the source automatic snapshot was created.
Constraints:
This parameter cannot be defined together with the instance snapshot name parameter. The source instance name and instance snapshot name parameters are mutually exclusive.
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
The date of the automatic snapshot to use for the new instance. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.
Constraints:
Must be specified in YYYY-MM-DD format.
This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
The date of the automatic snapshot to use for the new instance. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.
Constraints:
Must be specified in YYYY-MM-DD format.
This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
A Boolean value to indicate whether to use the latest available automatic snapshot.
Constraints:
This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
A Boolean value to indicate whether to use the latest available automatic snapshot.
Constraints:
This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
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.
Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail Developer Guide.
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.
Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail Developer Guide.
The name of the TLS policy to apply to the load balancer.
Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify.
For more information about load balancer TLS policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.
" + "documentation":"The name of the TLS policy to apply to the load balancer.
Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify.
For more information about load balancer TLS policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.
" } } }, @@ -6308,7 +6308,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" + "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" }, "addOns":{ "shape":"AddOnList", @@ -6436,7 +6436,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" + "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" }, "sizeInGb":{ "shape":"integer", @@ -6563,7 +6563,7 @@ "documentation":"The message that describes the reason for the status code.
" } }, - "documentation":"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.
" + "documentation":"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.
" }, "DnsRecordCreationStateCode":{ "type":"string", @@ -6602,7 +6602,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" + "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" }, "domainEntries":{ "shape":"DomainEntryList", @@ -7150,7 +7150,7 @@ }, "accountLevelBpaSync":{ "shape":"AccountLevelBpaSync", - "documentation":"An object that describes the synchronization status of the Amazon S3 account-level block public access feature for your Lightsail buckets.
For more information about this feature and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail.
" + "documentation":"An object that describes the synchronization status of the Amazon S3 account-level block public access feature for your Lightsail buckets.
For more information about this feature and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail.
" } } }, @@ -7763,7 +7763,7 @@ }, "metricName":{ "shape":"InstanceMetricName", - "documentation":"The metric for which you want to return information.
Valid instance metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.
BurstCapacityPercentage - The percentage of CPU performance available for your instance to burst above its baseline. Your instance continuously accrues and consumes burst capacity. Burst capacity stops accruing when your instance's BurstCapacityPercentage reaches 100%. For more information, see Viewing instance burst capacity in Amazon Lightsail.
Statistics: The most useful statistics are Maximum and Average.
Unit: The published unit is Percent.
BurstCapacityTime - The available amount of time for your instance to burst at 100% CPU utilization. Your instance continuously accrues and consumes burst capacity. Burst capacity time stops accruing when your instance's BurstCapacityPercentage metric reaches 100%.
Burst capacity time is consumed at the full rate only when your instance operates at 100% CPU utilization. For example, if your instance operates at 50% CPU utilization in the burstable zone for a 5-minute period, then it consumes CPU burst capacity minutes at a 50% rate in that period. Your instance consumed 2 minutes and 30 seconds of CPU burst capacity minutes in the 5-minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.
Statistics: The most useful statistics are Maximum and Average.
Unit: The published unit is Seconds.
CPUUtilization - The percentage of allocated compute units that are currently in use on the instance. This metric identifies the processing power to run the applications on the instance. Tools in your operating system can show a lower percentage than Lightsail when the instance is not allocated a full processor core.
Statistics: The most useful statistics are Maximum and Average.
Unit: The published unit is Percent.
NetworkIn - The number of bytes received on all network interfaces by the instance. This metric identifies the volume of incoming network traffic to the instance. The number reported is the number of bytes received during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Bytes.
NetworkOut - The number of bytes sent out on all network interfaces by the instance. This metric identifies the volume of outgoing network traffic from the instance. The number reported is the number of bytes sent during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Bytes.
StatusCheckFailed - Reports whether the instance passed or failed both the instance status check and the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Count.
StatusCheckFailed_Instance - Reports whether the instance passed or failed the instance status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Count.
StatusCheckFailed_System - Reports whether the instance passed or failed the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Count.
MetadataNoToken - Reports the number of times that the instance metadata service was successfully accessed without a token. This metric determines if there are any processes accessing instance metadata by using Instance Metadata Service Version 1, which doesn't use a token. If all requests use token-backed sessions, such as Instance Metadata Service Version 2, then the value is 0.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Count.
The metric for which you want to return information.
Valid instance metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.
BurstCapacityPercentage - The percentage of CPU performance available for your instance to burst above its baseline. Your instance continuously accrues and consumes burst capacity. Burst capacity stops accruing when your instance's BurstCapacityPercentage reaches 100%. For more information, see Viewing instance burst capacity in Amazon Lightsail.
Statistics: The most useful statistics are Maximum and Average.
Unit: The published unit is Percent.
BurstCapacityTime - The available amount of time for your instance to burst at 100% CPU utilization. Your instance continuously accrues and consumes burst capacity. Burst capacity time stops accruing when your instance's BurstCapacityPercentage metric reaches 100%.
Burst capacity time is consumed at the full rate only when your instance operates at 100% CPU utilization. For example, if your instance operates at 50% CPU utilization in the burstable zone for a 5-minute period, then it consumes CPU burst capacity minutes at a 50% rate in that period. Your instance consumed 2 minutes and 30 seconds of CPU burst capacity minutes in the 5-minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.
Statistics: The most useful statistics are Maximum and Average.
Unit: The published unit is Seconds.
CPUUtilization - The percentage of allocated compute units that are currently in use on the instance. This metric identifies the processing power to run the applications on the instance. Tools in your operating system can show a lower percentage than Lightsail when the instance is not allocated a full processor core.
Statistics: The most useful statistics are Maximum and Average.
Unit: The published unit is Percent.
NetworkIn - The number of bytes received on all network interfaces by the instance. This metric identifies the volume of incoming network traffic to the instance. The number reported is the number of bytes received during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Bytes.
NetworkOut - The number of bytes sent out on all network interfaces by the instance. This metric identifies the volume of outgoing network traffic from the instance. The number reported is the number of bytes sent during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Bytes.
StatusCheckFailed - Reports whether the instance passed or failed both the instance status check and the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Count.
StatusCheckFailed_Instance - Reports whether the instance passed or failed the instance status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Count.
StatusCheckFailed_System - Reports whether the instance passed or failed the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Count.
MetadataNoToken - Reports the number of times that the instance metadata service was successfully accessed without a token. This metric determines if there are any processes accessing instance metadata by using Instance Metadata Service Version 1, which doesn't use a token. If all requests use token-backed sessions, such as Instance Metadata Service Version 2, then the value is 0.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Count.
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" + "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" }, "blueprintId":{ "shape":"NonEmptyString", @@ -9025,7 +9025,7 @@ }, "httpTokens":{ "shape":"HttpTokens", - "documentation":"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.
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.
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.
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.
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.
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.
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" + "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" }, "state":{ "shape":"InstanceSnapshotState", @@ -9367,7 +9367,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" + "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" }, "fingerprint":{ "shape":"Base64", @@ -9461,7 +9461,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" + "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" }, "viewerMinimumTlsProtocolVersion":{ "shape":"string", @@ -9499,7 +9499,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" + "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" }, "dnsName":{ "shape":"NonEmptyString", @@ -9634,7 +9634,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" + "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" }, "loadBalancerName":{ "shape":"ResourceName", @@ -9900,7 +9900,7 @@ "documentation":"The ciphers used by the TLS security policy.
The ciphers are listed in order of preference.
" } }, - "documentation":"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.
" + "documentation":"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.
" }, "LoadBalancerTlsPolicyList":{ "type":"list", @@ -10059,7 +10059,7 @@ "documentation":"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.
" } }, - "documentation":"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.
" + "documentation":"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.
" }, "MonthlyTransfer":{ "type":"structure", @@ -10083,7 +10083,7 @@ "documentation":"The message that describes the reason for the status code.
" } }, - "documentation":"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.
" + "documentation":"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.
" }, "NameServersUpdateStateCode":{ "type":"string", @@ -10511,7 +10511,7 @@ "documentation":"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.
" } }, - "documentation":"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.
" + "documentation":"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.
" }, "PrivateRegistryAccessRequest":{ "type":"structure", @@ -10521,7 +10521,7 @@ "documentation":"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.
" } }, - "documentation":"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.
" + "documentation":"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.
" }, "PutAlarmRequest":{ "type":"structure", @@ -10540,7 +10540,7 @@ }, "metricName":{ "shape":"MetricName", - "documentation":"The name of the metric to associate with the alarm.
You can configure up to two alarms per metric.
The following metrics are available for each resource type:
Instances: BurstCapacityPercentage, BurstCapacityTime, CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System.
Load balancers: 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, and RequestCount.
Relational databases: CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, and NetworkTransmitThroughput.
For more information about these metrics, see Metrics available in Lightsail.
" + "documentation":"The name of the metric to associate with the alarm.
You can configure up to two alarms per metric.
The following metrics are available for each resource type:
Instances: BurstCapacityPercentage, BurstCapacityTime, CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System.
Load balancers: 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, and RequestCount.
Relational databases: CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, and NetworkTransmitThroughput.
For more information about these metrics, see Metrics available in Lightsail.
" }, "monitoredResourceName":{ "shape":"ResourceName", @@ -10795,7 +10795,7 @@ "documentation":"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.
" } }, - "documentation":"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 Amazon Web Services 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.
" + "documentation":"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 Amazon Web Services 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.
" }, "RelationalDatabase":{ "type":"structure", @@ -10826,7 +10826,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" + "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" }, "relationalDatabaseBlueprintId":{ "shape":"NonEmptyString", @@ -11143,7 +11143,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" + "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
" }, "engine":{ "shape":"NonEmptyString", @@ -11440,7 +11440,7 @@ "documentation":"When true, this Boolean value indicates the primary session for the specified resource.
" } }, - "documentation":"Describes a web-based, remote graphical user interface (GUI), NICE DCV session. The session is used to access a virtual computer’s operating system or application.
" + "documentation":"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.
" }, "Sessions":{ "type":"list", @@ -11908,7 +11908,7 @@ "documentation":"The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
" } }, - "documentation":"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.
" + "documentation":"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.
" }, "TagKey":{"type":"string"}, "TagKeyList":{ @@ -12149,7 +12149,7 @@ }, "privateRegistryAccess":{ "shape":"PrivateRegistryAccessRequest", - "documentation":"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.
" + "documentation":"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.
" } } }, @@ -12433,5 +12433,5 @@ "string":{"type":"string"}, "timestamp":{"type":"timestamp"} }, - "documentation":"Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, storage buckets, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price.
You can manage your Lightsail resources using the Lightsail console, Lightsail API, Command Line Interface (CLI), or SDKs. For more information about Lightsail concepts and tasks, see the Amazon Lightsail Developer Guide.
This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and Quotas in the Amazon Web Services General Reference.
" + "documentation":"Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, storage buckets, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price.
You can manage your Lightsail resources using the Lightsail console, Lightsail API, Command Line Interface (CLI), or SDKs. For more information about Lightsail concepts and tasks, see the Amazon Lightsail Developer Guide.
This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and Quotas in the Amazon Web Services General Reference.
" } From fdae83150d35f88c948e70cd8d97e7880b300c9a Mon Sep 17 00:00:00 2001 From: AWS <> Date: Wed, 19 Feb 2025 19:12:10 +0000 Subject: [PATCH 06/11] Amazon SageMaker Service Update: Adds r8g instance type support to SageMaker Realtime Endpoints --- ...eature-AmazonSageMakerService-ba5091b.json | 6 +++++ .../codegen-resources/service-2.json | 22 ++++++++++++++----- 2 files changed, 22 insertions(+), 6 deletions(-) create mode 100644 .changes/next-release/feature-AmazonSageMakerService-ba5091b.json diff --git a/.changes/next-release/feature-AmazonSageMakerService-ba5091b.json b/.changes/next-release/feature-AmazonSageMakerService-ba5091b.json new file mode 100644 index 000000000000..8ba31e58d2cd --- /dev/null +++ b/.changes/next-release/feature-AmazonSageMakerService-ba5091b.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "Amazon SageMaker Service", + "contributor": "", + "description": "Adds r8g instance type support to SageMaker Realtime Endpoints" +} diff --git a/services/sagemaker/src/main/resources/codegen-resources/service-2.json b/services/sagemaker/src/main/resources/codegen-resources/service-2.json index c2736086d3da..2056ec6d9a9b 100644 --- a/services/sagemaker/src/main/resources/codegen-resources/service-2.json +++ b/services/sagemaker/src/main/resources/codegen-resources/service-2.json @@ -7657,7 +7657,7 @@ }, "OverrideVpcConfig":{ "shape":"VpcConfig", - "documentation":"The customized VPC configuration at the instance group level that overrides the default VPC configuration of the SageMaker HyperPod cluster.
" + "documentation":"The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.
" } }, "documentation":"Details of an instance group in a SageMaker HyperPod cluster.
" @@ -7720,7 +7720,7 @@ }, "OverrideVpcConfig":{ "shape":"VpcConfig", - "documentation":"To configure multi-AZ deployments, customize the VPC configuration at the instance group level. You can specify different subnets and security groups across different AZs in the instance group specification to override a SageMaker HyperPod cluster's default VPC configuration. For more information about deploying a cluster in multiple AZs, see Setting up SageMaker HyperPod clusters across multiple AZs.
If you configure your VPC with IPv6 support and specify subnets with IPv6 addressing enabled in your instance group VPC configuration, the nodes automatically use IPv6 addressing for network communication.
For information about adding IPv6 support for your VPC, see IPv6 support for your VPC.
For information about creating a new VPC for use with IPv6, see Create a VPC.
To configure multi-AZ deployments, customize the Amazon VPC configuration at the instance group level. You can specify different subnets and security groups across different AZs in the instance group specification to override a SageMaker HyperPod cluster's default Amazon VPC configuration. For more information about deploying a cluster in multiple AZs, see Setting up SageMaker HyperPod clusters across multiple AZs.
When your Amazon VPC and subnets support IPv6, network communications differ based on the cluster orchestration platform:
Slurm-orchestrated clusters automatically configure nodes with dual IPv6 and IPv4 addresses, allowing immediate IPv6 network communications.
In Amazon EKS-orchestrated clusters, nodes receive dual-stack addressing, but pods can only use IPv6 when the Amazon EKS cluster is explicitly IPv6-enabled. For information about deploying an IPv6 Amazon EKS cluster, see Amazon EKS IPv6 Cluster Deployment.
Additional resources for IPv6 configuration:
For information about adding IPv6 support to your VPC, see to IPv6 Support for VPC.
For information about creating a new IPv6-compatible VPC, see Amazon VPC Creation Guide.
To configure SageMaker HyperPod with a custom Amazon VPC, see Custom Amazon VPC Setup for SageMaker HyperPod.
The specifications of an instance group that you need to define.
" @@ -7942,7 +7942,7 @@ }, "OverrideVpcConfig":{ "shape":"VpcConfig", - "documentation":"The customized VPC configuration at the instance group level that overrides the default VPC configuration of the SageMaker HyperPod cluster.
" + "documentation":"The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.
" }, "ThreadsPerCore":{ "shape":"ClusterThreadsPerCore", @@ -7958,7 +7958,7 @@ }, "PrivatePrimaryIpv6":{ "shape":"ClusterPrivatePrimaryIpv6", - "documentation":"The private primary IPv6 address of the SageMaker HyperPod cluster node when configured with an Amazon VPC that supports IPv6 and includes subnets with IPv6 addressing enabled in either the cluster VPC configuration or the instance group VPC configuration.
" + "documentation":"The private primary IPv6 address of the SageMaker HyperPod cluster node when configured with an Amazon VPC that supports IPv6 and includes subnets with IPv6 addressing enabled in either the cluster Amazon VPC configuration or the instance group Amazon VPC configuration.
" }, "PrivateDnsHostname":{ "shape":"ClusterPrivateDnsHostname", @@ -9322,7 +9322,7 @@ }, "VpcConfig":{ "shape":"VpcConfig", - "documentation":"Specifies the Amazon Virtual Private Cloud (VPC) that is associated with the Amazon SageMaker HyperPod cluster. You can control access to and from your resources by configuring your VPC. For more information, see Give SageMaker access to resources in your Amazon VPC.
If you configure your VPC with IPv6 support and specify subnets with IPv6 addressing enabled in your VPC configuration, the cluster automatically uses IPv6 addressing for network communication.
For information about adding IPv6 support for your VPC, see IPv6 support for your VPC.
For information about creating a new VPC for use with IPv6, see Create a VPC.
Specifies the Amazon Virtual Private Cloud (VPC) that is associated with the Amazon SageMaker HyperPod cluster. You can control access to and from your resources by configuring your VPC. For more information, see Give SageMaker access to resources in your Amazon VPC.
When your Amazon VPC and subnets support IPv6, network communications differ based on the cluster orchestration platform:
Slurm-orchestrated clusters automatically configure nodes with dual IPv6 and IPv4 addresses, allowing immediate IPv6 network communications.
In Amazon EKS-orchestrated clusters, nodes receive dual-stack addressing, but pods can only use IPv6 when the Amazon EKS cluster is explicitly IPv6-enabled. For information about deploying an IPv6 Amazon EKS cluster, see Amazon EKS IPv6 Cluster Deployment.
Additional resources for IPv6 configuration:
For information about adding IPv6 support to your VPC, see to IPv6 Support for VPC.
For information about creating a new IPv6-compatible VPC, see Amazon VPC Creation Guide.
To configure SageMaker HyperPod with a custom Amazon VPC, see Custom Amazon VPC Setup for SageMaker HyperPod.
Specifies an option from a collection of preconfigured Amazon Machine Image (AMI) images. Each image is configured by Amazon Web Services with a set of software and driver versions. Amazon Web Services optimizes these configurations for different machine learning workloads.
By selecting an AMI version, you can ensure that your inference environment is compatible with specific software requirements, such as CUDA driver versions, Linux kernel versions, or Amazon Web Services Neuron driver versions.
The AMI version names, and their configurations, are the following:
Accelerator: GPU
NVIDIA driver version: 535.54.03
CUDA version: 12.2
Accelerator: GPU
NVIDIA driver version: 535.54.03
CUDA driver version: 12.2
CUDA Container Toolkit with disabled CUDA-compat mounting
Accelerator: GPU
NVIDIA driver version: 550.144.01
CUDA version: 12.4
Container Toolkit with disabled CUDA-compat mounting
Specifies an option from a collection of preconfigured Amazon Machine Image (AMI) images. Each image is configured by Amazon Web Services with a set of software and driver versions. Amazon Web Services optimizes these configurations for different machine learning workloads.
By selecting an AMI version, you can ensure that your inference environment is compatible with specific software requirements, such as CUDA driver versions, Linux kernel versions, or Amazon Web Services Neuron driver versions.
The AMI version names, and their configurations, are the following:
Accelerator: GPU
NVIDIA driver version: 535
CUDA version: 12.2
Accelerator: GPU
NVIDIA driver version: 535
CUDA version: 12.2
NVIDIA Container Toolkit with disabled CUDA-compat mounting
Accelerator: GPU
NVIDIA driver version: 550
CUDA version: 12.4
NVIDIA Container Toolkit with disabled CUDA-compat mounting
Identifies a model that you want to host and the resources chosen to deploy for hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic among the models by specifying variant weights. For more information on production variants, check Production variants.
" @@ -33764,6 +33764,16 @@ "ml.g6.16xlarge", "ml.g6.24xlarge", "ml.g6.48xlarge", + "ml.r8g.medium", + "ml.r8g.large", + "ml.r8g.xlarge", + "ml.r8g.2xlarge", + "ml.r8g.4xlarge", + "ml.r8g.8xlarge", + "ml.r8g.12xlarge", + "ml.r8g.16xlarge", + "ml.r8g.24xlarge", + "ml.r8g.48xlarge", "ml.g6e.xlarge", "ml.g6e.2xlarge", "ml.g6e.4xlarge", From 412714f0faf6c3fb18c7a56267bc8c65f4a53a1e Mon Sep 17 00:00:00 2001 From: AWS <> Date: Wed, 19 Feb 2025 19:12:11 +0000 Subject: [PATCH 07/11] Amazon Simple Email Service Update: This release adds the ability for outbound email sent with SES to preserve emails to a Mail Manager archive. --- ...ture-AmazonSimpleEmailService-b0586ad.json | 6 ++ .../codegen-resources/service-2.json | 69 ++++++++++++++++++- 2 files changed, 72 insertions(+), 3 deletions(-) create mode 100644 .changes/next-release/feature-AmazonSimpleEmailService-b0586ad.json diff --git a/.changes/next-release/feature-AmazonSimpleEmailService-b0586ad.json b/.changes/next-release/feature-AmazonSimpleEmailService-b0586ad.json new file mode 100644 index 000000000000..87dad9774482 --- /dev/null +++ b/.changes/next-release/feature-AmazonSimpleEmailService-b0586ad.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "Amazon Simple Email Service", + "contributor": "", + "description": "This release adds the ability for outbound email sent with SES to preserve emails to a Mail Manager archive." +} diff --git a/services/sesv2/src/main/resources/codegen-resources/service-2.json b/services/sesv2/src/main/resources/codegen-resources/service-2.json index f666cd6be541..771494e3f35f 100644 --- a/services/sesv2/src/main/resources/codegen-resources/service-2.json +++ b/services/sesv2/src/main/resources/codegen-resources/service-2.json @@ -1052,6 +1052,22 @@ ], "documentation":"Update your Amazon SES account VDM attributes.
You can execute this operation no more than once per second.
" }, + "PutConfigurationSetArchivingOptions":{ + "name":"PutConfigurationSetArchivingOptions", + "http":{ + "method":"PUT", + "requestUri":"/v2/email/configuration-sets/{ConfigurationSetName}/archiving-options" + }, + "input":{"shape":"PutConfigurationSetArchivingOptionsRequest"}, + "output":{"shape":"PutConfigurationSetArchivingOptionsResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"Associate the configuration set with a MailManager archive. When you send email using the SendEmail or SendBulkEmail operations the message as it will be given to the receiving SMTP server will be archived, along with the recipient information.
The Amazon Resource Name (ARN) of the MailManager archive where the Amazon SES API v2 will archive sent emails.
" + } + }, + "documentation":"Used to associate a configuration set with a MailManager archive.
" + }, "AttributesData":{"type":"string"}, "BadRequestException":{ "type":"structure", @@ -2054,6 +2086,10 @@ "VdmOptions":{ "shape":"VdmOptions", "documentation":"An object that defines the VDM options for emails that you send using the configuration set.
" + }, + "ArchivingOptions":{ + "shape":"ArchivingOptions", + "documentation":"An object that defines the MailManager archiving options for emails that you send using the configuration set.
" } }, "documentation":"A request to create a configuration set.
" @@ -3718,6 +3754,10 @@ "VdmOptions":{ "shape":"VdmOptions", "documentation":"An object that contains information about the VDM preferences for your configuration set.
" + }, + "ArchivingOptions":{ + "shape":"ArchivingOptions", + "documentation":"An object that defines the MailManager archive where sent emails are archived that you send using the configuration set.
" } }, "documentation":"Information about a configuration set.
" @@ -5187,7 +5227,7 @@ }, "ListRecommendationsFilterKey":{ "type":"string", - "documentation":"The ListRecommendations filter type. This can be one of the following:
TYPE – The recommendation type, with values like DKIM, SPF, DMARC or BIMI.
IMPACT – The recommendation impact, with values like HIGH or LOW.
STATUS – The recommendation status, with values like OPEN or FIXED.
RESOURCE_ARN – The resource affected by the recommendation, with values like arn:aws:ses:us-east-1:123456789012:identity/example.com.
The ListRecommendations filter type. This can be one of the following:
TYPE – The recommendation type, with values like DKIM, SPF, DMARC, BIMI, or COMPLAINT.
IMPACT – The recommendation impact, with values like HIGH or LOW.
STATUS – The recommendation status, with values like OPEN or FIXED.
RESOURCE_ARN – The resource affected by the recommendation, with values like arn:aws:ses:us-east-1:123456789012:identity/example.com.
The name of the configuration set to associate with a MailManager archive.
", + "location":"uri", + "locationName":"ConfigurationSetName" + }, + "ArchiveArn":{ + "shape":"ArchiveArn", + "documentation":"The Amazon Resource Name (ARN) of the MailManager archive that the Amazon SES API v2 sends email to.
" + } + }, + "documentation":"A request to associate a configuration set with a MailManager archive.
" + }, + "PutConfigurationSetArchivingOptionsResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"An HTTP 200 response if the request succeeds, or an error message if the request fails.
" + }, "PutConfigurationSetDeliveryOptionsRequest":{ "type":"structure", "required":["ConfigurationSetName"], @@ -6344,7 +6407,7 @@ }, "Type":{ "shape":"RecommendationType", - "documentation":"The recommendation type, with values like DKIM, SPF, DMARC or BIMI.
The recommendation type, with values like DKIM, SPF, DMARC, BIMI, or COMPLAINT.
Provides the reason for the failure describing why Amazon SES was not able to successfully verify the identity. Below are the possible values:
INVALID_VALUE – Amazon SES was able to find the record, but the value contained within the record was invalid. Ensure you have published the correct values for the record.
TYPE_NOT_FOUND – The queried hostname exists but does not have the requested type of DNS record. Ensure that you have published the correct type of DNS record.
HOST_NOT_FOUND – The queried hostname does not exist or was not reachable at the time of the request. Ensure that you have published the required DNS record(s).
SERVICE_ERROR – A temporary issue is preventing Amazon SES from determining the verification status of the domain.
DNS_SERVER_ERROR – The DNS server encountered an issue and was unable to complete the request.
REPLICATION_ACCESS_DENIED – The verification failed because the user does not have the required permissions to replicate the DKIM key from the primary region. Ensure you have the necessary permissions in both primary and replica regions.
REPLICATION_PRIMARY_NOT_FOUND – The verification failed because no corresponding identity was found in the specified primary region. Ensure the identity exists in the primary region before attempting replication.
REPLICATION_PRIMARY_BYO_DKIM_NOT_SUPPORTED – The verification failed because the identity in the primary region is configured with Bring Your Own DKIM (BYODKIM). DKIM key replication is only supported for identities using Easy DKIM.
REPLICATION_REPLICA_AS_PRIMARY_NOT_SUPPORTED – The verification failed because the specified primary identity is a replica of another identity, and multi-level replication is not supported; the primary identity must be a non-replica identity.
REPLICATION_PRIMARY_INVALID_REGION – The verification failed due to an invalid primary region specified. Ensure you provide a valid AWS region where Amazon SES is available and different from the replica region.
Provides the reason for the failure describing why Amazon SES was not able to successfully verify the identity. Below are the possible values:
INVALID_VALUE – Amazon SES was able to find the record, but the value contained within the record was invalid. Ensure you have published the correct values for the record.
TYPE_NOT_FOUND – The queried hostname exists but does not have the requested type of DNS record. Ensure that you have published the correct type of DNS record.
HOST_NOT_FOUND – The queried hostname does not exist or was not reachable at the time of the request. Ensure that you have published the required DNS record(s).
SERVICE_ERROR – A temporary issue is preventing Amazon SES from determining the verification status of the domain.
DNS_SERVER_ERROR – The DNS server encountered an issue and was unable to complete the request.
REPLICATION_ACCESS_DENIED – The verification failed because the user does not have the required permissions to replicate the DKIM key from the primary region. Ensure you have the necessary permissions in both primary and replica regions.
REPLICATION_PRIMARY_NOT_FOUND – The verification failed because no corresponding identity was found in the specified primary region. Ensure the identity exists in the primary region before attempting replication.
REPLICATION_PRIMARY_BYO_DKIM_NOT_SUPPORTED – The verification failed because the identity in the primary region is configured with Bring Your Own DKIM (BYODKIM). DKIM key replication is only supported for identities using Easy DKIM.
REPLICATION_REPLICA_AS_PRIMARY_NOT_SUPPORTED – The verification failed because the specified primary identity is a replica of another identity, and multi-level replication is not supported; the primary identity must be a non-replica identity.
REPLICATION_PRIMARY_INVALID_REGION – The verification failed due to an invalid primary region specified. Ensure you provide a valid Amazon Web Services region where Amazon SES is available and different from the replica region.
Whether the task's elastic network interface receives a public IP address. The default value is ENABLED.
Whether the task's elastic network interface receives a public IP address.
Consider the following when you set this value:
When you use create-service or update-service, the default is DISABLED.
When the service deploymentController is ECS, the value must be DISABLED.
When you use create-service or update-service, the default is ENABLED.
An object representing the networking details for a task or service. For example awsVpcConfiguration={subnets=[\"subnet-12344321\"],securityGroups=[\"sg-12344321\"]}.
Your Amazon Web Services account was blocked. For more information, contact Amazon Web Services Support.
", + "documentation":"Your Amazon Web Services account was blocked. For more information, contact Amazon Web ServicesSupport.
", "exception":true }, "Boolean":{"type":"boolean"}, @@ -4861,7 +4861,7 @@ }, "cpu":{ "shape":"String", - "documentation":"The number of CPU units used by the task. It can be expressed as an integer using CPU units (for example, 1024) or as a string using vCPUs (for example, 1 vCPU or 1 vcpu) in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.
Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If you're using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). If you do not specify a value, the parameter is ignored.
If you're using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or later.
The number of CPU units used by the task. It can be expressed as an integer using CPU units (for example, 1024) or as a string using vCPUs (for example, 1 vCPU or 1 vcpu) in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.
Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If you're using the EC2 launch type or external launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 196608 CPU units (192 vCPUs). If you do not specify a value, the parameter is ignored.
If you're using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or later.
The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units (for example, 1024). It can also be expressed as a string using vCPUs (for example, 1 vCPU or 1 vcpu). String values are converted to an integer that indicates the CPU units when the task definition is registered.
If you use the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).
If you use the Fargate launch type, this field is required. You must use one of the following values. These values determine the range of supported values for the memory parameter:
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or later.
The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units (for example, 1024). It can also be expressed as a string using vCPUs (for example, 1 vCPU or 1 vcpu). String values are converted to an integer that indicates the CPU units when the task definition is registered.
If you're using the EC2 launch type or the external launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 196608 CPU units (192 vCPUs). If you do not specify a value, the parameter is ignored.
If you're using the Fargate launch type, this field is required. You must use one of the following values. These values determine the range of supported values for the memory parameter:
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or later.
The number of cpu units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the memory parameter.
If you use the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or later.
The number of cpu units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the memory parameter.
If you're using the EC2 launch type or the external launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 196608 CPU units (192 vCPUs).
If you're using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter. The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or later.
The name of the configuration set used when sent through a configuration set with archiving enabled.
" + }, "IngressPointId":{ "shape":"IngressPointId", "documentation":"The ID of the ingress endpoint through which the email was received.
" @@ -3592,6 +3596,22 @@ "shape":"SenderIpAddress", "documentation":"The IP address of the host from which the email was received.
" }, + "SendingMethod":{ + "shape":"String", + "documentation":"The name of the API call used when sent through a configuration set with archiving enabled.
" + }, + "SendingPool":{ + "shape":"String", + "documentation":"The name of the dedicated IP pool used when sent through a configuration set with archiving enabled.
" + }, + "SourceArn":{ + "shape":"String", + "documentation":"Specifies the archived email source, identified by either a Rule Set's ARN with an Archive action, or a Configuration Set's Archive ARN.
" + }, + "SourceIdentity":{ + "shape":"String", + "documentation":"The identity name used to authorize the sending action when sent through a configuration set with archiving enabled.
" + }, "Timestamp":{ "shape":"Timestamp", "documentation":"The timestamp of when the email was received.
" @@ -3911,7 +3931,11 @@ }, "SenderIpAddress":{ "shape":"SenderIpAddress", - "documentation":"The IP address of the host from which the email was received.
" + "documentation":"Mail archived with Mail Manager: The IP address of the client that connects to the ingress endpoint.
Mail sent through a configuration set with the archiving option enabled: The IP address of the client that makes the SendEmail API call.
Specifies the archived email source, identified by either a Rule Set's ARN with an Archive action, or a Configuration Set's Archive ARN.
" }, "Subject":{ "shape":"String", From 662f68604ae08e8d8fa93513f9d5831feae07b61 Mon Sep 17 00:00:00 2001 From: AWS <> Date: Wed, 19 Feb 2025 19:12:26 +0000 Subject: [PATCH 10/11] AWS Network Firewall Update: This release introduces Network Firewall's Automated Domain List feature. New APIs include UpdateFirewallAnalysisSettings, StartAnalysisReport, GetAnalysisReportResults, and ListAnalysisReports. These allow customers to enable analysis on firewalls to identify and report frequently accessed domain. --- .../feature-AWSNetworkFirewall-3ff63b6.json | 6 + .../codegen-resources/paginators-1.json | 12 + .../codegen-resources/service-2.json | 363 +++++++++++++++++- 3 files changed, 371 insertions(+), 10 deletions(-) create mode 100644 .changes/next-release/feature-AWSNetworkFirewall-3ff63b6.json diff --git a/.changes/next-release/feature-AWSNetworkFirewall-3ff63b6.json b/.changes/next-release/feature-AWSNetworkFirewall-3ff63b6.json new file mode 100644 index 000000000000..2f4b9e986dae --- /dev/null +++ b/.changes/next-release/feature-AWSNetworkFirewall-3ff63b6.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "AWS Network Firewall", + "contributor": "", + "description": "This release introduces Network Firewall's Automated Domain List feature. New APIs include UpdateFirewallAnalysisSettings, StartAnalysisReport, GetAnalysisReportResults, and ListAnalysisReports. These allow customers to enable analysis on firewalls to identify and report frequently accessed domain." +} diff --git a/services/networkfirewall/src/main/resources/codegen-resources/paginators-1.json b/services/networkfirewall/src/main/resources/codegen-resources/paginators-1.json index e4d9aeeec76a..a7739b3ffbd0 100644 --- a/services/networkfirewall/src/main/resources/codegen-resources/paginators-1.json +++ b/services/networkfirewall/src/main/resources/codegen-resources/paginators-1.json @@ -1,5 +1,17 @@ { "pagination": { + "GetAnalysisReportResults": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "AnalysisReportResults" + }, + "ListAnalysisReports": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "AnalysisReports" + }, "ListFirewallPolicies": { "input_token": "NextToken", "output_token": "NextToken", diff --git a/services/networkfirewall/src/main/resources/codegen-resources/service-2.json b/services/networkfirewall/src/main/resources/codegen-resources/service-2.json index 834fa0f83a91..504888d20826 100644 --- a/services/networkfirewall/src/main/resources/codegen-resources/service-2.json +++ b/services/networkfirewall/src/main/resources/codegen-resources/service-2.json @@ -69,7 +69,7 @@ {"shape":"InsufficientCapacityException"}, {"shape":"InvalidOperationException"} ], - "documentation":"Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC.
The firewall defines the configuration settings for an Network Firewall firewall. The settings that you can define at creation include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource.
After you create a firewall, you can provide additional settings, like the logging configuration.
To update the settings for a firewall, you use the operations that apply to the settings themselves, for example UpdateLoggingConfiguration, AssociateSubnets, and UpdateFirewallDeleteProtection.
To manage a firewall's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.
To retrieve information about firewalls, use ListFirewalls and DescribeFirewall.
" + "documentation":"Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC.
The firewall defines the configuration settings for an Network Firewall firewall. The settings that you can define at creation include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource.
After you create a firewall, you can provide additional settings, like the logging configuration.
To update the settings for a firewall, you use the operations that apply to the settings themselves, for example UpdateLoggingConfiguration, AssociateSubnets, and UpdateFirewallDeleteProtection.
To manage a firewall's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.
To retrieve information about firewalls, use ListFirewalls and DescribeFirewall.
To generate a report on the last 30 days of traffic monitored by a firewall, use StartAnalysisReport.
" }, "CreateFirewallPolicy":{ "name":"CreateFirewallPolicy", @@ -340,6 +340,38 @@ ], "documentation":"Removes the specified subnet associations from the firewall. This removes the firewall endpoints from the subnets and removes any network filtering protections that the endpoints were providing.
" }, + "GetAnalysisReportResults":{ + "name":"GetAnalysisReportResults", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAnalysisReportResultsRequest"}, + "output":{"shape":"GetAnalysisReportResultsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalServerError"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"The results of a COMPLETED analysis report generated with StartAnalysisReport.
For more information, see AnalysisTypeReportResult.
" + }, + "ListAnalysisReports":{ + "name":"ListAnalysisReports", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAnalysisReportsRequest"}, + "output":{"shape":"ListAnalysisReportsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalServerError"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Returns a list of all traffic analysis reports generated within the last 30 days.
" + }, "ListFirewallPolicies":{ "name":"ListFirewallPolicies", "http":{ @@ -433,6 +465,22 @@ ], "documentation":"Creates or updates an IAM policy for your rule group or firewall policy. Use this to share rule groups and firewall policies between accounts. This operation works in conjunction with the Amazon Web Services Resource Access Manager (RAM) service to manage resource sharing for Network Firewall.
Use this operation to create or update a resource policy for your rule group or firewall policy. In the policy, you specify the accounts that you want to share the resource with and the operations that you want the accounts to be able to perform.
When you add an account in the resource policy, you then run the following Resource Access Manager (RAM) operations to access and accept the shared rule group or firewall policy.
GetResourceShareInvitations - Returns the Amazon Resource Names (ARNs) of the resource share invitations.
AcceptResourceShareInvitation - Accepts the share invitation for a specified resource share.
For additional information about resource sharing using RAM, see Resource Access Manager User Guide.
" }, + "StartAnalysisReport":{ + "name":"StartAnalysisReport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartAnalysisReportRequest"}, + "output":{"shape":"StartAnalysisReportResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalServerError"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Generates a traffic analysis report for the timeframe and traffic type you specify.
For information on the contents of a traffic analysis report, see AnalysisReport.
" + }, "TagResource":{ "name":"TagResource", "http":{ @@ -465,6 +513,22 @@ ], "documentation":"Removes the tags with the specified keys from the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can manage tags for the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.
" }, + "UpdateFirewallAnalysisSettings":{ + "name":"UpdateFirewallAnalysisSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateFirewallAnalysisSettingsRequest"}, + "output":{"shape":"UpdateFirewallAnalysisSettingsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalServerError"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Enables specific types of firewall analysis on a specific firewall you define.
" + }, "UpdateFirewallDeleteProtection":{ "name":"UpdateFirewallDeleteProtection", "http":{ @@ -662,6 +726,47 @@ "type":"list", "member":{"shape":"Address"} }, + "AnalysisReport":{ + "type":"structure", + "members":{ + "AnalysisReportId":{ + "shape":"AnalysisReportId", + "documentation":"The unique ID of the query that ran when you requested an analysis report.
" + }, + "AnalysisType":{ + "shape":"EnabledAnalysisType", + "documentation":"The type of traffic that will be used to generate a report.
" + }, + "ReportTime":{ + "shape":"ReportTime", + "documentation":"The date and time the analysis report was ran.
" + }, + "Status":{ + "shape":"Status", + "documentation":"The status of the analysis report you specify. Statuses include RUNNING, COMPLETED, or FAILED.
A report that captures key activity from the last 30 days of network traffic monitored by your firewall.
You can generate up to one report per traffic type, per 30 day period. For example, when you successfully create an HTTP traffic report, you cannot create another HTTP traffic report until 30 days pass. Alternatively, if you generate a report that combines metrics on both HTTP and HTTPS traffic, you cannot create another report for either traffic type until 30 days pass.
" + }, + "AnalysisReportId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"\\S+" + }, + "AnalysisReportNextToken":{ + "type":"string", + "max":1024, + "min":1 + }, + "AnalysisReportResults":{ + "type":"list", + "member":{"shape":"AnalysisTypeReportResult"} + }, + "AnalysisReports":{ + "type":"list", + "member":{"shape":"AnalysisReport"} + }, "AnalysisResult":{ "type":"structure", "members":{ @@ -678,12 +783,42 @@ "documentation":"Provides analysis details for the identified rule.
" } }, - "documentation":"The analysis result for Network Firewall's stateless rule group analyzer. Every time you call CreateRuleGroup, UpdateRuleGroup, or DescribeRuleGroup on a stateless rule group, Network Firewall analyzes the stateless rule groups in your account and identifies the rules that might adversely effect your firewall's functionality. For example, if Network Firewall detects a rule that's routing traffic asymmetrically, which impacts the service's ability to properly process traffic, the service includes the rule in a list of analysis results.
" + "documentation":"The analysis result for Network Firewall's stateless rule group analyzer. Every time you call CreateRuleGroup, UpdateRuleGroup, or DescribeRuleGroup on a stateless rule group, Network Firewall analyzes the stateless rule groups in your account and identifies the rules that might adversely effect your firewall's functionality. For example, if Network Firewall detects a rule that's routing traffic asymmetrically, which impacts the service's ability to properly process traffic, the service includes the rule in a list of analysis results.
The AnalysisResult data type is not related to traffic analysis reports you generate using StartAnalysisReport. For information on traffic analysis report results, see AnalysisTypeReportResult.
The type of traffic captured by the analysis report.
" + }, + "FirstAccessed":{ + "shape":"FirstAccessed", + "documentation":"The date and time any domain was first accessed (within the last 30 day period).
" + }, + "LastAccessed":{ + "shape":"LastAccessed", + "documentation":"The date and time any domain was last accessed (within the last 30 day period).
" + }, + "Domain":{ + "shape":"Domain", + "documentation":"The most frequently accessed domains.
" + }, + "Hits":{ + "shape":"Hits", + "documentation":"The number of attempts made to access a observed domain.
" + }, + "UniqueSources":{ + "shape":"UniqueSources", + "documentation":"The number of unique source IP addresses that connected to a domain.
" + } + }, + "documentation":"The results of a COMPLETED analysis report generated with StartAnalysisReport.
For an example of traffic analysis report results, see the response syntax of GetAnalysisReportResults.
" + }, "AssociateFirewallPolicyRequest":{ "type":"structure", "required":["FirewallPolicyArn"], @@ -875,6 +1010,7 @@ "CAPACITY_CONSTRAINED" ] }, + "Count":{"type":"integer"}, "CreateFirewallPolicyRequest":{ "type":"structure", "required":[ @@ -929,9 +1065,7 @@ "type":"structure", "required":[ "FirewallName", - "FirewallPolicyArn", - "VpcId", - "SubnetMappings" + "FirewallPolicyArn" ], "members":{ "FirewallName":{ @@ -973,6 +1107,10 @@ "EncryptionConfiguration":{ "shape":"EncryptionConfiguration", "documentation":"A complex type that contains settings for encryption of your firewall resources.
" + }, + "EnabledAnalysisTypes":{ + "shape":"EnabledAnalysisTypes", + "documentation":"An optional setting indicating the specific traffic analysis types to enable on the firewall.
" } } }, @@ -1543,6 +1681,18 @@ } } }, + "Domain":{"type":"string"}, + "EnabledAnalysisType":{ + "type":"string", + "enum":[ + "TLS_SNI", + "HTTP_HOST" + ] + }, + "EnabledAnalysisTypes":{ + "type":"list", + "member":{"shape":"EnabledAnalysisType"} + }, "EncryptionConfiguration":{ "type":"structure", "required":["Type"], @@ -1565,6 +1715,7 @@ "AWS_OWNED_KMS_KEY" ] }, + "EndTime":{"type":"timestamp"}, "EndpointId":{"type":"string"}, "ErrorMessage":{"type":"string"}, "Firewall":{ @@ -1623,6 +1774,10 @@ "EncryptionConfiguration":{ "shape":"EncryptionConfiguration", "documentation":"A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
" + }, + "EnabledAnalysisTypes":{ + "shape":"EnabledAnalysisTypes", + "documentation":"An optional setting indicating the specific traffic analysis types to enable on the firewall.
" } }, "documentation":"The firewall defines the configuration settings for an Network Firewall firewall. These settings include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource.
The status of the firewall, for example whether it's ready to filter network traffic, is provided in the corresponding FirewallStatus. You can retrieve both objects by calling DescribeFirewall.
" @@ -1798,6 +1953,7 @@ "type":"list", "member":{"shape":"FirewallMetadata"} }, + "FirstAccessed":{"type":"timestamp"}, "Flags":{ "type":"list", "member":{"shape":"TCPFlag"} @@ -1819,6 +1975,65 @@ "DENYLIST" ] }, + "GetAnalysisReportResultsRequest":{ + "type":"structure", + "required":["AnalysisReportId"], + "members":{ + "FirewallName":{ + "shape":"ResourceName", + "documentation":"The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
" + }, + "AnalysisReportId":{ + "shape":"AnalysisReportId", + "documentation":"The unique ID of the query that ran when you requested an analysis report.
" + }, + "FirewallArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
" + }, + "NextToken":{ + "shape":"AnalysisReportNextToken", + "documentation":"When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
The status of the analysis report you specify. Statuses include RUNNING, COMPLETED, or FAILED.
The date and time within the last 30 days from which to start retrieving analysis data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ.
The date and time, up to the current date, from which to stop retrieving analysis data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
The date and time the analysis report was ran.
" + }, + "AnalysisType":{ + "shape":"EnabledAnalysisType", + "documentation":"The type of traffic that will be used to generate a report.
" + }, + "NextToken":{ + "shape":"AnalysisReportNextToken", + "documentation":"When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
Retrieves the results of a traffic analysis report.
" + } + } + }, "HashMapKey":{ "type":"string", "max":50, @@ -1869,6 +2084,16 @@ }, "documentation":"The basic rule criteria for Network Firewall to use to inspect packet headers in stateful traffic flow inspection. Traffic flows that match the criteria are a match for the corresponding StatefulRule.
" }, + "Hits":{ + "type":"structure", + "members":{ + "Count":{ + "shape":"Count", + "documentation":"The number of attempts made to access a domain.
" + } + }, + "documentation":"Attempts made to a access domain.
" + }, "IPAddressType":{ "type":"string", "enum":[ @@ -1999,6 +2224,7 @@ "min":1, "pattern":".*" }, + "LastAccessed":{"type":"timestamp"}, "LastUpdateTime":{"type":"timestamp"}, "LimitExceededException":{ "type":"structure", @@ -2008,6 +2234,40 @@ "documentation":"Unable to perform the operation because doing so would violate a limit setting.
", "exception":true }, + "ListAnalysisReportsRequest":{ + "type":"structure", + "members":{ + "FirewallName":{ + "shape":"ResourceName", + "documentation":"The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
" + }, + "FirewallArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
The id and ReportTime associated with a requested analysis report. Does not provide the status of the analysis report.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
Contains a set of IP set references.
" }, + "ReportTime":{"type":"timestamp"}, "ResourceArn":{ "type":"string", "max":256, @@ -2630,11 +2891,11 @@ "members":{ "Keyword":{ "shape":"Keyword", - "documentation":"The keyword for the Suricata compatible rule option. You must include a sid (signature ID), and can optionally include other keywords. For information about Suricata compatible keywords, see Rule options in the Suricata documentation.
The keyword for the Suricata compatible rule option. You must include a sid (signature ID), and can optionally include other keywords. For information about Suricata compatible keywords, see Rule options in the Suricata documentation.
The settings of the Suricata compatible rule option. Rule options have zero or more setting values, and the number of possible and required settings depends on the Keyword. For more information about the settings for specific options, see Rule options.
The settings of the Suricata compatible rule option. Rule options have zero or more setting values, and the number of possible and required settings depends on the Keyword. For more information about the settings for specific options, see Rule options.
Additional settings for a stateful rule. This is part of the StatefulRule configuration.
" @@ -2687,7 +2948,7 @@ }, "StatefulRules":{ "shape":"StatefulRules", - "documentation":"An array of individual stateful rules inspection criteria to be used together in a stateful rule group. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options. For information about the Suricata Rules format, see Rules Format.
An array of individual stateful rules inspection criteria to be used together in a stateful rule group. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options. For information about the Suricata Rules format, see Rules Format.
High-level information about the managed rule group that your own rule group is copied from. You can use the the metadata to track version updates made to the originating rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
" }, + "StartAnalysisReportRequest":{ + "type":"structure", + "required":["AnalysisType"], + "members":{ + "FirewallName":{ + "shape":"ResourceName", + "documentation":"The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
" + }, + "FirewallArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
" + }, + "AnalysisType":{ + "shape":"EnabledAnalysisType", + "documentation":"The type of traffic that will be used to generate a report.
" + } + } + }, + "StartAnalysisReportResponse":{ + "type":"structure", + "required":["AnalysisReportId"], + "members":{ + "AnalysisReportId":{ + "shape":"AnalysisReportId", + "documentation":"The unique ID of the query that ran when you requested an analysis report.
" + } + } + }, + "StartTime":{"type":"timestamp"}, "StatefulAction":{ "type":"string", "enum":[ @@ -2876,7 +3166,7 @@ "documentation":"Additional options for the rule. These are the Suricata RuleOptions settings.
A single Suricata rules specification, for use in a stateful rule group. Use this option to specify a simple Suricata rule with protocol, source and destination, ports, direction, and rule options. For information about the Suricata Rules format, see Rules Format.
A single Suricata rules specification, for use in a stateful rule group. Use this option to specify a simple Suricata rule with protocol, source and destination, ports, direction, and rule options. For information about the Suricata Rules format, see Rules Format.
Stateless inspection criteria. Each stateless rule group uses exactly one of these data types to define its stateless rules.
" }, + "Status":{"type":"string"}, "StatusMessage":{"type":"string"}, "StatusReason":{ "type":"string", @@ -3301,6 +3592,16 @@ }, "documentation":"Contains metadata about an Certificate Manager certificate.
" }, + "UniqueSources":{ + "type":"structure", + "members":{ + "Count":{ + "shape":"Count", + "documentation":"The number of unique source IP addresses that connected to a domain.
" + } + }, + "documentation":"A unique source IP address that connected to a domain.
" + }, "UnsupportedOperationException":{ "type":"structure", "members":{ @@ -3331,6 +3632,48 @@ "members":{ } }, + "UpdateFirewallAnalysisSettingsRequest":{ + "type":"structure", + "members":{ + "EnabledAnalysisTypes":{ + "shape":"EnabledAnalysisTypes", + "documentation":"An optional setting indicating the specific traffic analysis types to enable on the firewall.
" + }, + "FirewallArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
" + }, + "FirewallName":{ + "shape":"ResourceName", + "documentation":"The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
" + }, + "UpdateToken":{ + "shape":"UpdateToken", + "documentation":"An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional setting indicating the specific traffic analysis types to enable on the firewall.
" + }, + "FirewallArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
" + }, + "FirewallName":{ + "shape":"ResourceName", + "documentation":"The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
" + }, + "UpdateToken":{ + "shape":"UpdateToken", + "documentation":"An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
This is the API Reference for Network Firewall. This guide is for developers who need detailed information about the Network Firewall API actions, data types, and errors.
The REST API requires you to handle connection details, such as calculating signatures, handling request retries, and error handling. For general information about using the Amazon Web Services REST APIs, see Amazon Web Services APIs.
To view the complete list of Amazon Web Services Regions where Network Firewall is available, see Service endpoints and quotas in the Amazon Web Services General Reference.
To access Network Firewall using the IPv4 REST API endpoint: https://network-firewall.<region>.amazonaws.com
To access Network Firewall using the Dualstack (IPv4 and IPv6) REST API endpoint: https://network-firewall.<region>.aws.api
Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see Amazon Web Services SDKs.
For descriptions of Network Firewall features, including and step-by-step instructions on how to use them through the Network Firewall console, see the Network Firewall Developer Guide.
Network Firewall is a stateful, managed, network firewall and intrusion detection and prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the perimeter of your VPC. This includes filtering traffic going to and coming from an internet gateway, NAT gateway, or over VPN or Direct Connect. Network Firewall uses rules that are compatible with Suricata, a free, open source network analysis and threat detection engine.
You can use Network Firewall to monitor and protect your VPC traffic in a number of ways. The following are just a few examples:
Allow domains or IP addresses for known Amazon Web Services service endpoints, such as Amazon S3, and block all other forms of traffic.
Use custom lists of known bad domains to limit the types of domain names that your applications can access.
Perform deep packet inspection on traffic entering or leaving your VPC.
Use stateful protocol detection to filter protocols like HTTPS, regardless of the port used.
To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in Network Firewall. For information about using Amazon VPC, see Amazon VPC User Guide.
To start using Network Firewall, do the following:
(Optional) If you don't already have a VPC that you want to protect, create it in Amazon VPC.
In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a subnet for the sole use of Network Firewall.
In Network Firewall, create stateless and stateful rule groups, to define the components of the network traffic filtering behavior that you want your firewall to have.
In Network Firewall, create a firewall policy that uses your rule groups and specifies additional default traffic filtering behavior.
In Network Firewall, create a firewall and specify your new firewall policy and VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you specify, with the behavior that's defined in the firewall policy.
In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall endpoints.
This is the API Reference for Network Firewall. This guide is for developers who need detailed information about the Network Firewall API actions, data types, and errors.
The REST API requires you to handle connection details, such as calculating signatures, handling request retries, and error handling. For general information about using the Amazon Web Services REST APIs, see Amazon Web Services APIs.
To view the complete list of Amazon Web Services Regions where Network Firewall is available, see Service endpoints and quotas in the Amazon Web Services General Reference.
To access Network Firewall using the IPv4 REST API endpoint: https://network-firewall.<region>.amazonaws.com
To access Network Firewall using the Dualstack (IPv4 and IPv6) REST API endpoint: https://network-firewall.<region>.aws.api
Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see Amazon Web Services SDKs.
For descriptions of Network Firewall features, including and step-by-step instructions on how to use them through the Network Firewall console, see the Network Firewall Developer Guide.
Network Firewall is a stateful, managed, network firewall and intrusion detection and prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the perimeter of your VPC. This includes filtering traffic going to and coming from an internet gateway, NAT gateway, or over VPN or Direct Connect. Network Firewall uses rules that are compatible with Suricata, a free, open source network analysis and threat detection engine. Network Firewall supports Suricata version 7.0.3. For information about Suricata, see the Suricata website and the Suricata User Guide.
You can use Network Firewall to monitor and protect your VPC traffic in a number of ways. The following are just a few examples:
Allow domains or IP addresses for known Amazon Web Services service endpoints, such as Amazon S3, and block all other forms of traffic.
Use custom lists of known bad domains to limit the types of domain names that your applications can access.
Perform deep packet inspection on traffic entering or leaving your VPC.
Use stateful protocol detection to filter protocols like HTTPS, regardless of the port used.
To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in Network Firewall. For information about using Amazon VPC, see Amazon VPC User Guide.
To start using Network Firewall, do the following:
(Optional) If you don't already have a VPC that you want to protect, create it in Amazon VPC.
In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a subnet for the sole use of Network Firewall.
In Network Firewall, create stateless and stateful rule groups, to define the components of the network traffic filtering behavior that you want your firewall to have.
In Network Firewall, create a firewall policy that uses your rule groups and specifies additional default traffic filtering behavior.
In Network Firewall, create a firewall and specify your new firewall policy and VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you specify, with the behavior that's defined in the firewall policy.
In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall endpoints.