From 8fceddcb9513f36d7162a679eb037e9d829e6c23 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Wed, 31 Jan 2024 19:04:12 +0000 Subject: [PATCH 1/4] feat: update AWS API models --- codegen/sdk/aws-models/cloudformation.json | 2353 +++++++++++++++-- .../aws-models/elastic-load-balancing-v2.json | 260 +- codegen/sdk/aws-models/glue.json | 30 +- codegen/sdk/aws-models/ssm.json | 69 +- 4 files changed, 2439 insertions(+), 273 deletions(-) diff --git a/codegen/sdk/aws-models/cloudformation.json b/codegen/sdk/aws-models/cloudformation.json index 3f93316e0ce..09d2c3711b6 100644 --- a/codegen/sdk/aws-models/cloudformation.json +++ b/codegen/sdk/aws-models/cloudformation.json @@ -1084,6 +1084,9 @@ { "target": "com.amazonaws.cloudformation#CreateChangeSet" }, + { + "target": "com.amazonaws.cloudformation#CreateGeneratedTemplate" + }, { "target": "com.amazonaws.cloudformation#CreateStack" }, @@ -1102,6 +1105,9 @@ { "target": "com.amazonaws.cloudformation#DeleteChangeSet" }, + { + "target": "com.amazonaws.cloudformation#DeleteGeneratedTemplate" + }, { "target": "com.amazonaws.cloudformation#DeleteStack" }, @@ -1123,12 +1129,18 @@ { "target": "com.amazonaws.cloudformation#DescribeChangeSetHooks" }, + { + "target": "com.amazonaws.cloudformation#DescribeGeneratedTemplate" + }, { "target": "com.amazonaws.cloudformation#DescribeOrganizationsAccess" }, { "target": "com.amazonaws.cloudformation#DescribePublisher" }, + { + "target": "com.amazonaws.cloudformation#DescribeResourceScan" + }, { "target": "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatus" }, @@ -1177,6 +1189,9 @@ { "target": "com.amazonaws.cloudformation#ExecuteChangeSet" }, + { + "target": "com.amazonaws.cloudformation#GetGeneratedTemplate" + }, { "target": "com.amazonaws.cloudformation#GetStackPolicy" }, @@ -1195,9 +1210,21 @@ { "target": "com.amazonaws.cloudformation#ListExports" }, + { + "target": "com.amazonaws.cloudformation#ListGeneratedTemplates" + }, { "target": "com.amazonaws.cloudformation#ListImports" }, + { + "target": "com.amazonaws.cloudformation#ListResourceScanRelatedResources" + }, + { + "target": "com.amazonaws.cloudformation#ListResourceScanResources" + }, + { + "target": "com.amazonaws.cloudformation#ListResourceScans" + }, { "target": "com.amazonaws.cloudformation#ListStackInstanceResourceDrifts" }, @@ -1255,12 +1282,18 @@ { "target": "com.amazonaws.cloudformation#SignalResource" }, + { + "target": "com.amazonaws.cloudformation#StartResourceScan" + }, { "target": "com.amazonaws.cloudformation#StopStackSetOperation" }, { "target": "com.amazonaws.cloudformation#TestType" }, + { + "target": "com.amazonaws.cloudformation#UpdateGeneratedTemplate" + }, { "target": "com.amazonaws.cloudformation#UpdateStack" }, @@ -2330,6 +2363,23 @@ } } }, + "com.amazonaws.cloudformation#ConcurrentResourcesLimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ConcurrentResourcesLimitExceeded", + "httpResponseCode": 429 + }, + "smithy.api#documentation": "

No more than 5 generated templates can be in an InProgress or Pending status at one\n time. This error is also returned if a generated template that is in an InProgress or\n Pending status is attempted to be updated or deleted.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, "com.amazonaws.cloudformation#ConfigurationSchema": { "type": "string", "traits": { @@ -2581,6 +2631,103 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudformation#CreateGeneratedTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#CreateGeneratedTemplateInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#CreateGeneratedTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#AlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudformation#ConcurrentResourcesLimitExceededException" + }, + { + "target": "com.amazonaws.cloudformation#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a template from existing resources that are not already managed with CloudFormation. You can check the status of\n the template generation using the DescribeGeneratedTemplate API action.

", + "smithy.api#examples": [ + { + "title": "To create a generated template", + "documentation": "This example creates a generated template with a resources file.", + "input": { + "Resources": [ + { + "ResourceType": "AWS::S3::Bucket", + "ResourceIdentifier": { + "BucketName": "jazz-bucket" + } + }, + { + "ResourceType": "AWS::EC2::DHCPOptions", + "ResourceIdentifier": { + "DhcpOptionsId": "random-id123" + } + } + ], + "GeneratedTemplateName": "JazzyTemplate" + }, + "output": { + "GeneratedTemplateId": "arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/88f09db1-d211-4cb7-964b-434e2b8469ca" + } + } + ] + } + }, + "com.amazonaws.cloudformation#CreateGeneratedTemplateInput": { + "type": "structure", + "members": { + "Resources": { + "target": "com.amazonaws.cloudformation#ResourceDefinitions", + "traits": { + "smithy.api#documentation": "

An optional list of resources to be included in the generated template.

\n

If no resources are specified,the template will be created without any resources. Resources can be added to the\n template using the UpdateGeneratedTemplate API action.

" + } + }, + "GeneratedTemplateName": { + "target": "com.amazonaws.cloudformation#GeneratedTemplateName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name assigned to the generated template.

", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", + "traits": { + "smithy.api#documentation": "

An optional name or ARN of a stack to use as the base stack for the generated template.

" + } + }, + "TemplateConfiguration": { + "target": "com.amazonaws.cloudformation#TemplateConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration details of the generated template, including the DeletionPolicy and\n UpdateReplacePolicy.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#CreateGeneratedTemplateOutput": { + "type": "structure", + "members": { + "GeneratedTemplateId": { + "target": "com.amazonaws.cloudformation#GeneratedTemplateId", + "traits": { + "smithy.api#documentation": "

The ID of the generated template.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudformation#CreateStack": { "type": "operation", "input": { @@ -2651,7 +2798,7 @@ "TimeoutInMinutes": { "target": "com.amazonaws.cloudformation#TimeoutMinutes", "traits": { - "smithy.api#documentation": "

The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback\n is not set or is set to false, the stack will be rolled back.

" + "smithy.api#documentation": "

The amount of time that can pass before the stack status becomes CREATE_FAILED; if\n DisableRollback is not set or is set to false, the stack will be rolled back.

" } }, "NotificationARNs": { @@ -3142,6 +3289,51 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudformation#DeleteGeneratedTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DeleteGeneratedTemplateInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#ConcurrentResourcesLimitExceededException" + }, + { + "target": "com.amazonaws.cloudformation#GeneratedTemplateNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deleted a generated template.

", + "smithy.api#examples": [ + { + "title": "To delete a generated template", + "documentation": "This example deletes a generated template", + "input": { + "GeneratedTemplateName": "JazzyTemplate" + } + } + ] + } + }, + "com.amazonaws.cloudformation#DeleteGeneratedTemplateInput": { + "type": "structure", + "members": { + "GeneratedTemplateName": { + "target": "com.amazonaws.cloudformation#GeneratedTemplateName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of a generated template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.cloudformation#DeleteStack": { "type": "operation", "input": { @@ -3833,6 +4025,113 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudformation#DescribeGeneratedTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DescribeGeneratedTemplateInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DescribeGeneratedTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#GeneratedTemplateNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a generated template. The output includes details about the progress of the creation of a generated\n template started by a CreateGeneratedTemplate API action or the update of a generated template started\n with an UpdateGeneratedTemplate API action.

" + } + }, + "com.amazonaws.cloudformation#DescribeGeneratedTemplateInput": { + "type": "structure", + "members": { + "GeneratedTemplateName": { + "target": "com.amazonaws.cloudformation#GeneratedTemplateName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of a generated template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#DescribeGeneratedTemplateOutput": { + "type": "structure", + "members": { + "GeneratedTemplateId": { + "target": "com.amazonaws.cloudformation#GeneratedTemplateId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .

" + } + }, + "GeneratedTemplateName": { + "target": "com.amazonaws.cloudformation#GeneratedTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the generated template.

" + } + }, + "Resources": { + "target": "com.amazonaws.cloudformation#ResourceDetails", + "traits": { + "smithy.api#documentation": "

A list of objects describing the details of the resources in the template generation.

" + } + }, + "Status": { + "target": "com.amazonaws.cloudformation#GeneratedTemplateStatus", + "traits": { + "smithy.api#documentation": "

The status of the template generation. Supported values are:

\n " + } + }, + "StatusReason": { + "target": "com.amazonaws.cloudformation#TemplateStatusReason", + "traits": { + "smithy.api#documentation": "

The reason for the current template generation status. This will provide more details if a failure\n happened.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.cloudformation#CreationTime", + "traits": { + "smithy.api#documentation": "

The time the generated template was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.cloudformation#LastUpdatedTime", + "traits": { + "smithy.api#documentation": "

The time the generated template was last updated.

" + } + }, + "Progress": { + "target": "com.amazonaws.cloudformation#TemplateProgress", + "traits": { + "smithy.api#documentation": "

An object describing the progress of the template generation.

" + } + }, + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "

The stack ARN of the base stack if a base stack was provided when generating the template.

" + } + }, + "TemplateConfiguration": { + "target": "com.amazonaws.cloudformation#TemplateConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration details of the generated template, including the DeletionPolicy and\n UpdateReplacePolicy.

" + } + }, + "TotalWarnings": { + "target": "com.amazonaws.cloudformation#TotalWarnings", + "traits": { + "smithy.api#documentation": "

The number of warnings generated for this template. The warnings are found in the details of each of the\n resources in the template.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudformation#DescribeOrganizationsAccess": { "type": "operation", "input": { @@ -3945,26 +4244,31 @@ "smithy.api#output": {} } }, - "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatus": { + "com.amazonaws.cloudformation#DescribeResourceScan": { "type": "operation", "input": { - "target": "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusInput" + "target": "com.amazonaws.cloudformation#DescribeResourceScanInput" }, "output": { - "target": "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusOutput" + "target": "com.amazonaws.cloudformation#DescribeResourceScanOutput" }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#ResourceScanNotFoundException" + } + ], "traits": { - "smithy.api#documentation": "

Returns information about a stack drift detection operation. A stack drift detection operation detects whether a\n stack's actual configuration differs, or has drifted, from its expected configuration, as\n defined in the stack template and any values specified as template parameters. A stack is considered to have drifted\n if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated\n Configuration Changes to Stacks and Resources.

\n

Use DetectStackDrift to initiate a stack drift detection operation.\n DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of\n the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed,\n use DescribeStackResourceDrifts to return drift information about the stack and its\n resources.

" + "smithy.api#documentation": "

Describes details of a resource scan.

" } }, - "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusInput": { + "com.amazonaws.cloudformation#DescribeResourceScanInput": { "type": "structure", "members": { - "StackDriftDetectionId": { - "target": "com.amazonaws.cloudformation#StackDriftDetectionId", + "ResourceScanId": { + "target": "com.amazonaws.cloudformation#ResourceScanId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the drift detection results of this operation.

\n

CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number\n of drift results CloudFormation retains for any given stack, and for how long, may vary.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource scan.

", "smithy.api#required": {} } } @@ -3973,57 +4277,61 @@ "smithy.api#input": {} } }, - "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusOutput": { + "com.amazonaws.cloudformation#DescribeResourceScanOutput": { "type": "structure", "members": { - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", + "ResourceScanId": { + "target": "com.amazonaws.cloudformation#ResourceScanId", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the stack.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource scan. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is\n arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772\n .

" } }, - "StackDriftDetectionId": { - "target": "com.amazonaws.cloudformation#StackDriftDetectionId", + "Status": { + "target": "com.amazonaws.cloudformation#ResourceScanStatus", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the drift detection results of this operation.

\n

CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number\n of reports CloudFormation retains for any given stack, and for how long, may vary.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Status of the resource scan.

\n
\n
INPROGRESS
\n
\n

The resource scan is still in progress.

\n
\n
COMPLETE
\n
\n

The resource scan is complete.

\n
\n
EXPIRED
\n
\n

The resource scan has expired.

\n
\n
FAILED
\n
\n

The resource scan has failed.

\n
\n
" } }, - "StackDriftStatus": { - "target": "com.amazonaws.cloudformation#StackDriftStatus", + "StatusReason": { + "target": "com.amazonaws.cloudformation#ResourceScanStatusReason", "traits": { - "smithy.api#documentation": "

Status of the stack's actual configuration compared to its expected configuration.

\n " + "smithy.api#documentation": "

The reason for the resource scan status, providing more information if a failure happened.

" } }, - "DetectionStatus": { - "target": "com.amazonaws.cloudformation#StackDriftDetectionStatus", + "StartTime": { + "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The status of the stack drift detection operation.

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

The time that the resource scan was started.

" } }, - "DetectionStatusReason": { - "target": "com.amazonaws.cloudformation#StackDriftDetectionStatusReason", + "EndTime": { + "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

The reason the stack drift detection operation has its current status.

" + "smithy.api#documentation": "

The time that the resource scan was finished.

" } }, - "DriftedStackResourceCount": { - "target": "com.amazonaws.cloudformation#BoxedInteger", + "PercentageCompleted": { + "target": "com.amazonaws.cloudformation#PercentageCompleted", "traits": { - "smithy.api#documentation": "

Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a\n status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is\n IN_SYNC.

" + "smithy.api#documentation": "

The percentage of the resource scan that has been completed.

" } }, - "Timestamp": { - "target": "com.amazonaws.cloudformation#Timestamp", + "ResourceTypes": { + "target": "com.amazonaws.cloudformation#ResourceTypes", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Time at which the stack drift detection operation was initiated.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The list of resource types for the specified scan. Resource types are only available for scans with a\n Status set to COMPLETE or FAILED .

" + } + }, + "ResourcesScanned": { + "target": "com.amazonaws.cloudformation#ResourcesScanned", + "traits": { + "smithy.api#documentation": "

The number of resources that were listed. This is only available for scans with a Status set to\n COMPLETE, EXPIRED, or FAILED .

" + } + }, + "ResourcesRead": { + "target": "com.amazonaws.cloudformation#ResourcesRead", + "traits": { + "smithy.api#documentation": "

The number of resources that were read. This is only available for scans with a Status set to\n COMPLETE, EXPIRED, or FAILED .

\n \n

This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException.

\n " } } }, @@ -4031,13 +4339,99 @@ "smithy.api#output": {} } }, - "com.amazonaws.cloudformation#DescribeStackEvents": { + "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatus": { "type": "operation", "input": { - "target": "com.amazonaws.cloudformation#DescribeStackEventsInput" + "target": "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusInput" }, "output": { - "target": "com.amazonaws.cloudformation#DescribeStackEventsOutput" + "target": "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns information about a stack drift detection operation. A stack drift detection operation detects whether a\n stack's actual configuration differs, or has drifted, from its expected configuration, as\n defined in the stack template and any values specified as template parameters. A stack is considered to have drifted\n if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated\n Configuration Changes to Stacks and Resources.

\n

Use DetectStackDrift to initiate a stack drift detection operation.\n DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of\n the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed,\n use DescribeStackResourceDrifts to return drift information about the stack and its\n resources.

" + } + }, + "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusInput": { + "type": "structure", + "members": { + "StackDriftDetectionId": { + "target": "com.amazonaws.cloudformation#StackDriftDetectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the drift detection results of this operation.

\n

CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number\n of drift results CloudFormation retains for any given stack, and for how long, may vary.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusOutput": { + "type": "structure", + "members": { + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the stack.

", + "smithy.api#required": {} + } + }, + "StackDriftDetectionId": { + "target": "com.amazonaws.cloudformation#StackDriftDetectionId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the drift detection results of this operation.

\n

CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number\n of reports CloudFormation retains for any given stack, and for how long, may vary.

", + "smithy.api#required": {} + } + }, + "StackDriftStatus": { + "target": "com.amazonaws.cloudformation#StackDriftStatus", + "traits": { + "smithy.api#documentation": "

Status of the stack's actual configuration compared to its expected configuration.

\n " + } + }, + "DetectionStatus": { + "target": "com.amazonaws.cloudformation#StackDriftDetectionStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the stack drift detection operation.

\n ", + "smithy.api#required": {} + } + }, + "DetectionStatusReason": { + "target": "com.amazonaws.cloudformation#StackDriftDetectionStatusReason", + "traits": { + "smithy.api#documentation": "

The reason the stack drift detection operation has its current status.

" + } + }, + "DriftedStackResourceCount": { + "target": "com.amazonaws.cloudformation#BoxedInteger", + "traits": { + "smithy.api#documentation": "

Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a\n status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is\n IN_SYNC.

" + } + }, + "Timestamp": { + "target": "com.amazonaws.cloudformation#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Time at which the stack drift detection operation was initiated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#DescribeStackEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DescribeStackEventsInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DescribeStackEventsOutput" }, "traits": { "smithy.api#documentation": "

Returns all stack related events for a specified stack in reverse chronological order. For more information\n about a stack's event history, go to Stacks in the\n CloudFormation User Guide.

\n \n

You can list events for stacks that have failed to create or have been deleted by specifying the unique stack\n identifier (stack ID).

\n ", @@ -5789,163 +6183,398 @@ } } }, - "com.amazonaws.cloudformation#GetStackPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#GetStackPolicyInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#GetStackPolicyOutput" - }, - "traits": { - "smithy.api#documentation": "

Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is\n returned.

" - } - }, - "com.amazonaws.cloudformation#GetStackPolicyInput": { - "type": "structure", + "com.amazonaws.cloudformation#GeneratedTemplateDeletionPolicy": { + "type": "enum", "members": { - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", + "DELETE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or unique stack ID that's associated with the stack whose policy you want to get.

", - "smithy.api#required": {} + "smithy.api#enumValue": "DELETE" + } + }, + "RETAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETAIN" } } - }, - "traits": { - "smithy.api#documentation": "

The input for the GetStackPolicy action.

", - "smithy.api#input": {} } }, - "com.amazonaws.cloudformation#GetStackPolicyOutput": { - "type": "structure", - "members": { - "StackPolicyBody": { - "target": "com.amazonaws.cloudformation#StackPolicyBody", - "traits": { - "smithy.api#documentation": "

Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in\n the CloudFormation User Guide.)

" - } + "com.amazonaws.cloudformation#GeneratedTemplateId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 } - }, + } + }, + "com.amazonaws.cloudformation#GeneratedTemplateName": { + "type": "string", "traits": { - "smithy.api#documentation": "

The output for the GetStackPolicy action.

", - "smithy.api#output": {} + "smithy.api#length": { + "min": 1, + "max": 128 + } } }, - "com.amazonaws.cloudformation#GetTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#GetTemplateInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#GetTemplateOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#ChangeSetNotFoundException" + "com.amazonaws.cloudformation#GeneratedTemplateNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" } - ], + }, "traits": { - "smithy.api#documentation": "

Returns the template body for a specified stack. You can get the template for running or deleted stacks.

\n

For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been\n deleted.

\n \n

If the template doesn't exist, a ValidationError is returned.

\n " + "aws.protocols#awsQueryError": { + "code": "GeneratedTemplateNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The generated template was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 } }, - "com.amazonaws.cloudformation#GetTemplateInput": { - "type": "structure", + "com.amazonaws.cloudformation#GeneratedTemplateResourceStatus": { + "type": "enum", "members": { - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", + "PENDING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

\n \n

Default: There is no default value.

" + "smithy.api#enumValue": "PENDING" } }, - "ChangeSetName": { - "target": "com.amazonaws.cloudformation#ChangeSetNameOrId", + "IN_PROGRESS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated\n template. If you specify a name, you must also specify the StackName.

" + "smithy.api#enumValue": "IN_PROGRESS" } }, - "TemplateStage": { - "target": "com.amazonaws.cloudformation#TemplateStage", - "traits": { - "smithy.api#documentation": "

For templates that include transforms, the stage of the template that CloudFormation returns. To get the\n user-submitted template, specify Original. To get the template after CloudFormation has\n processed all transforms, specify Processed.

\n

If the template doesn't include transforms, Original and Processed return the same\n template. By default, CloudFormation specifies Processed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The input for a GetTemplate action.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#GetTemplateOutput": { - "type": "structure", - "members": { - "TemplateBody": { - "target": "com.amazonaws.cloudformation#TemplateBody", + "FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Structure containing the template body. (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)

\n

CloudFormation returns the same template that was used when the stack was created.

" + "smithy.api#enumValue": "FAILED" } }, - "StagesAvailable": { - "target": "com.amazonaws.cloudformation#StageList", + "COMPLETE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The stage of the template that you can retrieve. For stacks, the Original and\n Processed templates are always available. For change sets, the Original template is always\n available. After CloudFormation finishes creating the change set, the Processed template becomes\n available.

" + "smithy.api#enumValue": "COMPLETE" } } - }, - "traits": { - "smithy.api#documentation": "

The output for GetTemplate action.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#GetTemplateSummary": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#GetTemplateSummaryInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#GetTemplateSummaryOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#StackSetNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a new or existing template. The GetTemplateSummary action is useful for\n viewing parameter information, such as default parameter values and parameter types, before you create or update a\n stack or stack set.

\n

You can use the GetTemplateSummary action when you submit a template, or you can get template\n information for a stack set, or a running or deleted stack.

\n

For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the\n stack has been deleted. If the template doesn't exist, a ValidationError is returned.

" } }, - "com.amazonaws.cloudformation#GetTemplateSummaryInput": { - "type": "structure", + "com.amazonaws.cloudformation#GeneratedTemplateStatus": { + "type": "enum", "members": { - "TemplateBody": { - "target": "com.amazonaws.cloudformation#TemplateBody", + "CREATE_PENDING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information about templates, see Template anatomy in the\n CloudFormation User Guide.

\n

Conditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.

" + "smithy.api#enumValue": "CREATE_PENDING" } }, - "TemplateURL": { - "target": "com.amazonaws.cloudformation#TemplateURL", + "UPDATE_PENDING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see\n Template anatomy\n in the CloudFormation User Guide.

\n

Conditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.

" + "smithy.api#enumValue": "UPDATE_PENDING" } }, - "StackName": { - "target": "com.amazonaws.cloudformation#StackNameOrId", + "DELETE_PENDING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running\n stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the\n unique stack ID.

\n

Conditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.

" + "smithy.api#enumValue": "DELETE_PENDING" } }, - "StackSetName": { - "target": "com.amazonaws.cloudformation#StackSetNameOrId", + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The name or unique ID of the stack set from which the stack was created.

\n

Conditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.

" + "smithy.api#enumValue": "CREATE_IN_PROGRESS" } }, - "CallAs": { - "target": "com.amazonaws.cloudformation#CallAs", + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.

\n " + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + } + } + }, + "com.amazonaws.cloudformation#GeneratedTemplateUpdateReplacePolicy": { + "type": "enum", + "members": { + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + }, + "RETAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETAIN" + } + } + } + }, + "com.amazonaws.cloudformation#GetGeneratedTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#GetGeneratedTemplateInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#GetGeneratedTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#GeneratedTemplateNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a generated template. If the template is in an InProgress or Pending status\n then the template returned will be the template when the template was last in a Complete status. If the\n template has not yet been in a Complete status then an empty template will be returned.

", + "smithy.api#examples": [ + { + "title": "To get a generated template in JSON format", + "documentation": "This example gets a generated template ins JSON format.", + "input": { + "GeneratedTemplateName": "JazzyTemplate" + }, + "output": { + "Status": "COMPLETE", + "TemplateBody": "{\"Metadata\":{\"TemplateId\":\"arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/*\"},\"Parameters\":{\"Stage\":{\"Default\":\"beta\",\"Type\":\"String\"}},\"Resources\":{\"TestRole\":{\"Properties\":{\"AssumeRolePolicyDocument\":{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":{\"Fn::Sub\":[\"arn:${AWS::Partition}:iam::${AccountId}:root\",{\"AccountId\":{\"Fn::AccountIdFromAlias\":\"test-account-alias\"}}]}},\"Action\":\"sts:AssumeRole\"}]}},\"Type\":\"AWS::IAM::Role\",\"DeletionPolicy\":\"Delete\"},\"DocumentationPartl7ob4vsd76vs\":{\"UpdateReplacePolicy\":\"Retain\",\"Type\":\"AWS::ApiGateway::DocumentationPart\",\"DeletionPolicy\":\"Retain\",\"Properties\":{\"RestApiId\":\"l7ob4vsd76\",\"Properties\":\"{\\n \\\"description\\\" : \\\"ListGeneratedTemplates 200 response\\\"\\n}\",\"Location\":{\"Path\":\"/ListGeneratedTemplates\",\"Type\":\"RESPONSE\",\"Method\":\"POST\",\"StatusCode\":\"200\"}}}}}" + } + }, + { + "title": "To get a generated template in YAML format", + "documentation": "This example gets a generated template in YAML format.", + "input": { + "GeneratedTemplateName": "JazzyTemplate", + "Format": "YAML" + }, + "output": { + "Status": "COMPLETE", + "TemplateBody": "---\nMetadata:\n TemplateId: \"arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/*\"\nParameters:\n Stage:\n Default: \"beta\"\n Type: \"String\"\nResources:\n TestRole:\n Properties:\n AssumeRolePolicyDocument:\n Version: \"2012-10-17\"\n Statement:\n - Effect: \"Allow\"\n Principal:\n AWS:\n Fn::Sub:\n - \"arn:${AWS::Partition}:iam::${AccountId}:root\"\n - AccountId:\n Fn::AccountIdFromAlias: \"test-account-alias\"\n Action: \"sts:AssumeRole\"\n Type: \"AWS::IAM::Role\"\n DeletionPolicy: \"Delete\"\n DocumentationPartl7ob4vsd76vsnAlFMLXKVm:\n UpdateReplacePolicy: \"Retain\"\n Type: \"AWS::ApiGateway::DocumentationPart\"\n DeletionPolicy: \"Retain\"\n Properties:\n RestApiId: \"l7ob4vsd76\"\n Properties: \"{\\n \\\"description\\\" : \\\"ListGeneratedTemplates 200 response\\\"\\n\\\n }\"\n Location:\n Path: \"/ListGeneratedTemplates\"\n Type: \"RESPONSE\"\n Method: \"POST\"\n StatusCode: \"200\"\n" + } + } + ] + } + }, + "com.amazonaws.cloudformation#GetGeneratedTemplateInput": { + "type": "structure", + "members": { + "Format": { + "target": "com.amazonaws.cloudformation#TemplateFormat", + "traits": { + "smithy.api#documentation": "

The language to use to retrieve for the generated template. Supported values are:

\n " + } + }, + "GeneratedTemplateName": { + "target": "com.amazonaws.cloudformation#GeneratedTemplateName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#GetGeneratedTemplateOutput": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.cloudformation#GeneratedTemplateStatus", + "traits": { + "smithy.api#documentation": "

The status of the template generation. Supported values are:

\n " + } + }, + "TemplateBody": { + "target": "com.amazonaws.cloudformation#TemplateBody", + "traits": { + "smithy.api#documentation": "

The template body of the generated template, in the language specified by the Language\n parameter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#GetStackPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#GetStackPolicyInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#GetStackPolicyOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is\n returned.

" + } + }, + "com.amazonaws.cloudformation#GetStackPolicyInput": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or unique stack ID that's associated with the stack whose policy you want to get.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The input for the GetStackPolicy action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#GetStackPolicyOutput": { + "type": "structure", + "members": { + "StackPolicyBody": { + "target": "com.amazonaws.cloudformation#StackPolicyBody", + "traits": { + "smithy.api#documentation": "

Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in\n the CloudFormation User Guide.)

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The output for the GetStackPolicy action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#GetTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#GetTemplateInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#GetTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#ChangeSetNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the template body for a specified stack. You can get the template for running or deleted stacks.

\n

For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been\n deleted.

\n \n

If the template doesn't exist, a ValidationError is returned.

\n " + } + }, + "com.amazonaws.cloudformation#GetTemplateInput": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", + "traits": { + "smithy.api#documentation": "

The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

\n \n

Default: There is no default value.

" + } + }, + "ChangeSetName": { + "target": "com.amazonaws.cloudformation#ChangeSetNameOrId", + "traits": { + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated\n template. If you specify a name, you must also specify the StackName.

" + } + }, + "TemplateStage": { + "target": "com.amazonaws.cloudformation#TemplateStage", + "traits": { + "smithy.api#documentation": "

For templates that include transforms, the stage of the template that CloudFormation returns. To get the\n user-submitted template, specify Original. To get the template after CloudFormation has\n processed all transforms, specify Processed.

\n

If the template doesn't include transforms, Original and Processed return the same\n template. By default, CloudFormation specifies Processed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The input for a GetTemplate action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#GetTemplateOutput": { + "type": "structure", + "members": { + "TemplateBody": { + "target": "com.amazonaws.cloudformation#TemplateBody", + "traits": { + "smithy.api#documentation": "

Structure containing the template body. (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)

\n

CloudFormation returns the same template that was used when the stack was created.

" + } + }, + "StagesAvailable": { + "target": "com.amazonaws.cloudformation#StageList", + "traits": { + "smithy.api#documentation": "

The stage of the template that you can retrieve. For stacks, the Original and\n Processed templates are always available. For change sets, the Original template is always\n available. After CloudFormation finishes creating the change set, the Processed template becomes\n available.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The output for GetTemplate action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#GetTemplateSummary": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#GetTemplateSummaryInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#GetTemplateSummaryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#StackSetNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a new or existing template. The GetTemplateSummary action is useful for\n viewing parameter information, such as default parameter values and parameter types, before you create or update a\n stack or stack set.

\n

You can use the GetTemplateSummary action when you submit a template, or you can get template\n information for a stack set, or a running or deleted stack.

\n

For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the\n stack has been deleted. If the template doesn't exist, a ValidationError is returned.

" + } + }, + "com.amazonaws.cloudformation#GetTemplateSummaryInput": { + "type": "structure", + "members": { + "TemplateBody": { + "target": "com.amazonaws.cloudformation#TemplateBody", + "traits": { + "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information about templates, see Template anatomy in the\n CloudFormation User Guide.

\n

Conditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.

" + } + }, + "TemplateURL": { + "target": "com.amazonaws.cloudformation#TemplateURL", + "traits": { + "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see\n Template anatomy\n in the CloudFormation User Guide.

\n

Conditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.

" + } + }, + "StackName": { + "target": "com.amazonaws.cloudformation#StackNameOrId", + "traits": { + "smithy.api#documentation": "

The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running\n stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the\n unique stack ID.

\n

Conditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.

" + } + }, + "StackSetName": { + "target": "com.amazonaws.cloudformation#StackSetNameOrId", + "traits": { + "smithy.api#documentation": "

The name or unique ID of the stack set from which the stack was created.

\n

Conditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.

" + } + }, + "CallAs": { + "target": "com.amazonaws.cloudformation#CallAs", + "traits": { + "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.

\n " } }, "TemplateSummaryConfig": { @@ -6512,6 +7141,33 @@ "com.amazonaws.cloudformation#IsDefaultVersion": { "type": "boolean" }, + "com.amazonaws.cloudformation#JazzLogicalResourceIds": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#LogicalResourceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.cloudformation#JazzResourceIdentifierProperties": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudformation#JazzResourceIdentifierPropertyKey" + }, + "value": { + "target": "com.amazonaws.cloudformation#JazzResourceIdentifierPropertyValue" + } + }, + "com.amazonaws.cloudformation#JazzResourceIdentifierPropertyKey": { + "type": "string" + }, + "com.amazonaws.cloudformation#JazzResourceIdentifierPropertyValue": { + "type": "string" + }, "com.amazonaws.cloudformation#Key": { "type": "string" }, @@ -6526,106 +7182,516 @@ } }, "traits": { - "aws.protocols#awsQueryError": { - "code": "LimitExceededException", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The quota for the resource has already been reached.

\n

For information about resource and stack limitations, see CloudFormation quotas in the\n CloudFormation User Guide.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "aws.protocols#awsQueryError": { + "code": "LimitExceededException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The quota for the resource has already been reached.

\n

For information about resource and stack limitations, see CloudFormation quotas in the\n CloudFormation User Guide.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudformation#LimitName": { + "type": "string" + }, + "com.amazonaws.cloudformation#LimitValue": { + "type": "integer" + }, + "com.amazonaws.cloudformation#ListChangeSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#ListChangeSetsInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#ListChangeSetsOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change\n sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Summaries" + } + } + }, + "com.amazonaws.cloudformation#ListChangeSetsInput": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.cloudformation#StackNameOrId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "

A string (provided by the ListChangeSets response output) that identifies the next page of\n change sets that you want to retrieve.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The input for the ListChangeSets action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#ListChangeSetsOutput": { + "type": "structure", + "members": { + "Summaries": { + "target": "com.amazonaws.cloudformation#ChangeSetSummaries", + "traits": { + "smithy.api#documentation": "

A list of ChangeSetSummary structures that provides the ID and status of each change set for the\n specified stack.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "

If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional\n page, this value is null.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The output for the ListChangeSets action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#ListExports": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#ListExportsInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#ListExportsOutput" + }, + "traits": { + "smithy.api#documentation": "

Lists all exported output values in the account and Region in which you call this action. Use this action to see\n the exported output values that you can import into other stacks. To import values, use the \n Fn::ImportValue function.

\n

For more information, see \n CloudFormation export stack output values.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Exports" + } + } + }, + "com.amazonaws.cloudformation#ListExportsInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "

A string (provided by the ListExports response output) that identifies the next page of\n exported output values that you asked to retrieve.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#ListExportsOutput": { + "type": "structure", + "members": { + "Exports": { + "target": "com.amazonaws.cloudformation#Exports", + "traits": { + "smithy.api#documentation": "

The output for the ListExports action.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "

If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is\n no additional page, this value is null.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#ListGeneratedTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#ListGeneratedTemplatesInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#ListGeneratedTemplatesOutput" + }, + "traits": { + "smithy.api#documentation": "

Lists your generated templates in this Region.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Summaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.cloudformation#ListGeneratedTemplatesInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "

A string that identifies the next page of resource scan results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudformation#MaxResults", + "traits": { + "smithy.api#documentation": "

If the number of available results exceeds this maximum, the response includes a NextToken value\n that you can use for the NextToken parameter to get the next set of results. By default the\n ListGeneratedTemplates API action will return at most 50 results in each response. The maximum value is\n 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#ListGeneratedTemplatesOutput": { + "type": "structure", + "members": { + "Summaries": { + "target": "com.amazonaws.cloudformation#TemplateSummaries", + "traits": { + "smithy.api#documentation": "

A list of summaries of the generated templates.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call ListGeneratedTemplates again and use that value for the\n NextToken parameter. If the request returns all results, NextToken is set to an empty\n string.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#ListImports": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#ListImportsInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#ListImportsOutput" + }, + "traits": { + "smithy.api#documentation": "

Lists all stacks that are importing an exported output value. To modify or remove an exported output value,\n first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.

\n

For more information about importing an exported output value, see the Fn::ImportValue\n function.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Imports" + } + } + }, + "com.amazonaws.cloudformation#ListImportsInput": { + "type": "structure", + "members": { + "ExportName": { + "target": "com.amazonaws.cloudformation#ExportName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the exported output value. CloudFormation returns the stack names that are importing this\n value.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "

A string (provided by the ListImports response output) that identifies the next page of stacks\n that are importing the specified exported output value.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#ListImportsOutput": { + "type": "structure", + "members": { + "Imports": { + "target": "com.amazonaws.cloudformation#Imports", + "traits": { + "smithy.api#documentation": "

A list of stack names that are importing the specified exported output value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "

A string that identifies the next page of exports. If there is no additional page, this value is null.

" + } + } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.cloudformation#LimitName": { - "type": "string" - }, - "com.amazonaws.cloudformation#LimitValue": { - "type": "integer" - }, - "com.amazonaws.cloudformation#ListChangeSets": { + "com.amazonaws.cloudformation#ListResourceScanRelatedResources": { "type": "operation", "input": { - "target": "com.amazonaws.cloudformation#ListChangeSetsInput" + "target": "com.amazonaws.cloudformation#ListResourceScanRelatedResourcesInput" }, "output": { - "target": "com.amazonaws.cloudformation#ListChangeSetsOutput" + "target": "com.amazonaws.cloudformation#ListResourceScanRelatedResourcesOutput" }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#ResourceScanInProgressException" + }, + { + "target": "com.amazonaws.cloudformation#ResourceScanNotFoundException" + } + ], "traits": { - "smithy.api#documentation": "

Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change\n sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.

", + "smithy.api#documentation": "

Lists the related resources for a list of resources from a resource scan. The response indicates whether each\n returned resource is already managed by CloudFormation.

", + "smithy.api#examples": [ + { + "title": "To list resource scan related resources", + "documentation": "This example lists the resources related to the passed in resources", + "input": { + "ResourceScanId": "arn:aws:cloudformation:us-east-1:123456789012:resourceScan/c19304f6-c4f1-4ff8-8e1f-35162e41d7e1", + "Resources": [ + { + "ResourceType": "AWS::S3::Bucket", + "ResourceIdentifier": { + "BucketName": "jazz-bucket" + } + }, + { + "ResourceType": "AWS::EC2::DHCPOptions", + "ResourceIdentifier": { + "DhcpOptionsId": "random-id123" + } + } + ] + }, + "output": { + "RelatedResources": [ + { + "ResourceType": "AWS::EC2::VPCDHCPOptionsAssociation", + "ResourceIdentifier": { + "VpcId": "vpc-0123456abcdefg", + "DhcpOptionsId": "dopt-98765edcba" + }, + "ManagedByStack": false + }, + { + "ResourceType": "AWS::EC2::VPC", + "ResourceIdentifier": { + "VpcId": "vpc-0123456abcdefgabc" + }, + "ManagedByStack": false + }, + { + "ResourceType": "AWS::EC2::VPCDHCPOptionsAssociation", + "ResourceIdentifier": { + "VpcId": "vpc-123456abcdef", + "DhcpOptionsId": "dopt-98765edcba" + }, + "ManagedByStack": false + }, + { + "ResourceType": "AWS::EC2::VPC", + "ResourceIdentifier": { + "VpcId": "vpc-12345678abcd" + }, + "ManagedByStack": false + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "Summaries" + "items": "RelatedResources", + "pageSize": "MaxResults" } } }, - "com.amazonaws.cloudformation#ListChangeSetsInput": { + "com.amazonaws.cloudformation#ListResourceScanRelatedResourcesInput": { "type": "structure", "members": { - "StackName": { - "target": "com.amazonaws.cloudformation#StackNameOrId", + "ResourceScanId": { + "target": "com.amazonaws.cloudformation#ResourceScanId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource scan.

", + "smithy.api#required": {} + } + }, + "Resources": { + "target": "com.amazonaws.cloudformation#ScannedResourceIdentifiers", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The list of resources for which you want to get the related resources. Up to 100 resources can be\n provided.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "

A string (provided by the ListChangeSets response output) that identifies the next page of\n change sets that you want to retrieve.

" + "smithy.api#documentation": "

A string that identifies the next page of resource scan results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudformation#BoxedMaxResults", + "traits": { + "smithy.api#documentation": "

If the number of available results exceeds this maximum, the response includes a NextToken value\n that you can use for the NextToken parameter to get the next set of results. By default the\n ListResourceScanRelatedResources API action will return up to 100 results in each response. The maximum\n value is 100.

" } } }, "traits": { - "smithy.api#documentation": "

The input for the ListChangeSets action.

", "smithy.api#input": {} } }, - "com.amazonaws.cloudformation#ListChangeSetsOutput": { + "com.amazonaws.cloudformation#ListResourceScanRelatedResourcesOutput": { "type": "structure", "members": { - "Summaries": { - "target": "com.amazonaws.cloudformation#ChangeSetSummaries", + "RelatedResources": { + "target": "com.amazonaws.cloudformation#RelatedResources", "traits": { - "smithy.api#documentation": "

A list of ChangeSetSummary structures that provides the ID and status of each change set for the\n specified stack.

" + "smithy.api#documentation": "

List of up to MaxResults resources in the specified resource scan related to the specified\n resources.

" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "

If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional\n page, this value is null.

" + "smithy.api#documentation": "

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call ListResourceScanRelatedResources again and use that value for the\n NextToken parameter. If the request returns all results, NextToken is set to an empty\n string.

" } } }, "traits": { - "smithy.api#documentation": "

The output for the ListChangeSets action.

", "smithy.api#output": {} } }, - "com.amazonaws.cloudformation#ListExports": { + "com.amazonaws.cloudformation#ListResourceScanResources": { "type": "operation", "input": { - "target": "com.amazonaws.cloudformation#ListExportsInput" + "target": "com.amazonaws.cloudformation#ListResourceScanResourcesInput" }, "output": { - "target": "com.amazonaws.cloudformation#ListExportsOutput" + "target": "com.amazonaws.cloudformation#ListResourceScanResourcesOutput" }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#ResourceScanInProgressException" + }, + { + "target": "com.amazonaws.cloudformation#ResourceScanNotFoundException" + } + ], "traits": { - "smithy.api#documentation": "

Lists all exported output values in the account and Region in which you call this action. Use this action to see\n the exported output values that you can import into other stacks. To import values, use the \n Fn::ImportValue function.

\n

For more information, see \n CloudFormation export stack output values.

", + "smithy.api#documentation": "

Lists the resources from a resource scan. The results can be filtered by resource identifier, resource type\n prefix, tag key, and tag value. Only resources that match all specified filters are returned. The response indicates\n whether each returned resource is already managed by CloudFormation.

", + "smithy.api#examples": [ + { + "title": "To list the resources in your resource scan", + "documentation": "This example lists the resources in your resource scan", + "input": { + "ResourceScanId": "arn:aws:cloudformation:us-east-1:123456789012:resourceScan/c19304f6-c4f1-4ff8-8e1f-35162e41d7e1" + }, + "output": { + "Resources": [ + { + "ResourceType": "AWS::Amplify::App", + "ResourceIdentifier": { + "Arn": "arn:aws:amplify:us-east-1:123456789012:apps/12345678" + }, + "ManagedByStack": false + }, + { + "ResourceType": "AWS::ApiGateway::Deployment", + "ResourceIdentifier": { + "DeploymentId": "1234567", + "RestApiId": "abcdefgh" + }, + "ManagedByStack": true + } + ], + "NextToken": "AQICAHjOiFofVZCZ0aEN1VnF1m9jq/xxpTY7MyPexz72BHuAkgETVS8c+PVCFpE6uGVJDxCFAAACbjCCAmoGCSqGSIb3DQEHBqCCAlswggJXAgEAMIICUAYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAwJ9QJAYeDzUoBeimECARCAggIh8brcL6H6uMvcZafRTB79hUkdJlOoFavrhYA2U7qdlPUwyvaVqN2DvFMxsl2XC1SaWmr5esMKxg1fLjbOEF32lVQn0Jp8QuoFUvREnqEsR32ZQmiI/Oc9HmwIr/BS3rzljki2Kr8Y0nriS7aFDLUCYsdsRdQ9iL5/iCc6oW7IisCzq1VKcHijlXvuiEipZAinsxEbmYBjmWgT7UYZdrrb6Hq3COEgPzS490ucndtwPjyvuCIMiAfTLMuBgjkzEfp4U97aLwPWaiKw94dMXj/3K67uuH9BjWZO+j6d3nnyZ14FOgI7SQvvVBnxARbTmINttHWjXPrIuE9YuuSWgn6GmuzEEDqkuglOS/OeTHYSPvLPRrFieUiawblljLVoVY9/HDjL/EErSTWiCnytGXIRoMI9Ozp2Yjfm3MBwSDXvMIrscw6QAa3bUA6uJSV2skCBnDoqV8EXd8umh788OgEtDxQ7d/NlUYEhN6AJ0K9TVz/2rZgOlzLCmtvmbIy7loAZCmf/uPNkyu6WuoLWTzQz78SnA8jWPKnxrzhNyPuaIgUH23U3mExhfMRDczitpOo5JM81oHVPECslGoqktLhP55BQqMbJy4w16SZJfr993TXhF5jOZenRN1zDsK3J5cLdJgPK1Ds1Z9DnRKMfXOqoAyme2l94/h0kLIxgAtxOeJFP/g/9hUtt1qGkZeV3Xqw1nkFQnafGIg4fJoWg74Sr7yo=" + } + }, + { + "title": "To list the resources in your resource scan for specific resource type", + "documentation": "This example lists the resources in your resource scan filtering only the resources that start with the passed in prefix", + "input": { + "ResourceScanId": "arn:aws:cloudformation:us-east-1:123456789012:resourceScan/c19304f6-c4f1-4ff8-8e1f-35162e41d7e1", + "ResourceTypePrefix": "AWS::S3" + }, + "output": { + "Resources": [ + { + "ResourceType": "AWS::S3::AccessPoint", + "ResourceIdentifier": { + "Name": "test-access-point" + }, + "ManagedByStack": true + }, + { + "ResourceType": "AWS::S3::BucketPolicy", + "ResourceIdentifier": { + "Bucket": "a-random-bucket" + }, + "ManagedByStack": false + } + ], + "NextToken": "AQICAHjOiFofVZCZ0aEN1VnF1m9jq/xxpTY7MyPexz72BHuAkgETVS8c+PVCFpE6uGVJDxCFAAACbjCCAmoGCSqGSIb3DQEHBqCCAlswggJXAgEAMIICUAYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAwJ9QJAYeDzUoBeimECARCAggIh8brcL6H6uMvcZafRTB79hUkdJlOoFavrhYA2U7qdlPUwyvaVqN2DvFMxsl2XC1SaWmr5esMKxg1fLjbOEF32lVQn0Jp8QuoFUvREnqEsR32ZQmiI/Oc9HmwIr/BS3rzljki2Kr8Y0nriS7aFDLUCYsdsRdQ9iL5/iCc6oW7IisCzq1VKcHijlXvuiEipZAinsxEbmYBjmWgT7UYZdrrb6Hq3COEgPzS490ucndtwPjyvuCIMiAfTLMuBgjkzEfp4U97aLwPWaiKw94dMXj/3K67uuH9BjWZO+j6d3nnyZ14FOgI7SQvvVBnxARbTmINttHWjXPrIuE9YuuSWgn6GmuzEEDqkuglOS/OeTHYSPvLPRrFieUiawblljLVoVY9/HDjL/EErSTWiCnytGXIRoMI9Ozp2Yjfm3MBwSDXvMIrscw6QAa3bUA6uJSV2skCBnDoqV8EXd8umh788OgEtDxQ7d/NlUYEhN6AJ0K9TVz/2rZgOlzLCmtvmbIy7loAZCmf/uPNkyu6WuoLWTzQz78SnA8jWPKnxrzhNyPuaIgUH23U3mExhfMRDczitpOo5JM81oHVPECslGoqktLhP55BQqMbJy4w16SZJfr993TXhF5jOZenRN1zDsK3J5cLdJgPK1Ds1Z9DnRKMfXOqoAyme2l94/h0kLIxgAtxOeJFP/g/9hUtt1qGkZeV3Xqw1nkFQnafGIg4fJoWg74Sr7yo=" + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "Exports" + "items": "Resources", + "pageSize": "MaxResults" } } }, - "com.amazonaws.cloudformation#ListExportsInput": { + "com.amazonaws.cloudformation#ListResourceScanResourcesInput": { "type": "structure", "members": { + "ResourceScanId": { + "target": "com.amazonaws.cloudformation#ResourceScanId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource scan.

", + "smithy.api#required": {} + } + }, + "ResourceIdentifier": { + "target": "com.amazonaws.cloudformation#ResourceIdentifier", + "traits": { + "smithy.api#documentation": "

If specified, the returned resources will have the specified resource identifier (or one of them in the case\n where the resource has multiple identifiers).

" + } + }, + "ResourceTypePrefix": { + "target": "com.amazonaws.cloudformation#ResourceTypePrefix", + "traits": { + "smithy.api#documentation": "

If specified, the returned resources will be of any of the resource types with the specified prefix.

" + } + }, + "TagKey": { + "target": "com.amazonaws.cloudformation#TagKey", + "traits": { + "smithy.api#documentation": "

If specified, the returned resources will have a matching tag key.

" + } + }, + "TagValue": { + "target": "com.amazonaws.cloudformation#TagValue", + "traits": { + "smithy.api#documentation": "

If specified, the returned resources will have a matching tag value.

" + } + }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "

A string (provided by the ListExports response output) that identifies the next page of\n exported output values that you asked to retrieve.

" + "smithy.api#documentation": "

A string that identifies the next page of resource scan results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudformation#ResourceScannerMaxResults", + "traits": { + "smithy.api#documentation": "

If the number of available results exceeds this maximum, the response includes a NextToken value\n that you can use for the NextToken parameter to get the next set of results. By default the\n ListResourceScanResources API action will return at most 100 results in each response. The maximum value\n is 100.

" } } }, @@ -6633,19 +7699,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.cloudformation#ListExportsOutput": { + "com.amazonaws.cloudformation#ListResourceScanResourcesOutput": { "type": "structure", "members": { - "Exports": { - "target": "com.amazonaws.cloudformation#Exports", + "Resources": { + "target": "com.amazonaws.cloudformation#ScannedResources", "traits": { - "smithy.api#documentation": "

The output for the ListExports action.

" + "smithy.api#documentation": "

List of up to MaxResults resources in the specified resource scan that match all of the specified\n filters.

" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "

If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is\n no additional page, this value is null.

" + "smithy.api#documentation": "

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call ListResourceScanResources again and use that value for the\n NextToken parameter. If the request returns all results, NextToken is set to an empty\n string.

" } } }, @@ -6653,38 +7719,37 @@ "smithy.api#output": {} } }, - "com.amazonaws.cloudformation#ListImports": { + "com.amazonaws.cloudformation#ListResourceScans": { "type": "operation", "input": { - "target": "com.amazonaws.cloudformation#ListImportsInput" + "target": "com.amazonaws.cloudformation#ListResourceScansInput" }, "output": { - "target": "com.amazonaws.cloudformation#ListImportsOutput" + "target": "com.amazonaws.cloudformation#ListResourceScansOutput" }, "traits": { - "smithy.api#documentation": "

Lists all stacks that are importing an exported output value. To modify or remove an exported output value,\n first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.

\n

For more information about importing an exported output value, see the Fn::ImportValue\n function.

", + "smithy.api#documentation": "

List the resource scans from newest to oldest. By default it will return up to 10 resource scans.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "Imports" + "items": "ResourceScanSummaries", + "pageSize": "MaxResults" } } }, - "com.amazonaws.cloudformation#ListImportsInput": { + "com.amazonaws.cloudformation#ListResourceScansInput": { "type": "structure", "members": { - "ExportName": { - "target": "com.amazonaws.cloudformation#ExportName", + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the exported output value. CloudFormation returns the stack names that are importing this\n value.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A string that identifies the next page of resource scan results.

" } }, - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", + "MaxResults": { + "target": "com.amazonaws.cloudformation#ResourceScannerMaxResults", "traits": { - "smithy.api#documentation": "

A string (provided by the ListImports response output) that identifies the next page of stacks\n that are importing the specified exported output value.

" + "smithy.api#documentation": "

If the number of available results exceeds this maximum, the response includes a NextToken value\n that you can use for the NextToken parameter to get the next set of results. The default value is 10.\n The maximum value is 100.

" } } }, @@ -6692,19 +7757,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.cloudformation#ListImportsOutput": { + "com.amazonaws.cloudformation#ListResourceScansOutput": { "type": "structure", "members": { - "Imports": { - "target": "com.amazonaws.cloudformation#Imports", + "ResourceScanSummaries": { + "target": "com.amazonaws.cloudformation#ResourceScanSummaries", "traits": { - "smithy.api#documentation": "

A list of stack names that are importing the specified exported output value.

" + "smithy.api#documentation": "

The list of scans returned.

" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "

A string that identifies the next page of exports. If there is no additional page, this value is null.

" + "smithy.api#documentation": "

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call ListResourceScans again and use that value for the NextToken\n parameter. If the request returns all results, NextToken is set to an empty string.

" } } }, @@ -7610,6 +8675,9 @@ } } }, + "com.amazonaws.cloudformation#ManagedByStack": { + "type": "boolean" + }, "com.amazonaws.cloudformation#ManagedExecution": { "type": "structure", "members": { @@ -7729,6 +8797,14 @@ } } }, + "com.amazonaws.cloudformation#NumberOfResources": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.cloudformation#OnFailure": { "type": "enum", "members": { @@ -8124,6 +9200,9 @@ "target": "com.amazonaws.cloudformation#Parameter" } }, + "com.amazonaws.cloudformation#PercentageCompleted": { + "type": "double" + }, "com.amazonaws.cloudformation#PermissionModels": { "type": "enum", "members": { @@ -8193,6 +9272,9 @@ "com.amazonaws.cloudformation#Properties": { "type": "string" }, + "com.amazonaws.cloudformation#PropertyDescription": { + "type": "string" + }, "com.amazonaws.cloudformation#PropertyDifference": { "type": "structure", "members": { @@ -8479,6 +9561,9 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudformation#RefreshAllResources": { + "type": "boolean" + }, "com.amazonaws.cloudformation#Region": { "type": "string", "traits": { @@ -8702,6 +9787,12 @@ } } }, + "com.amazonaws.cloudformation#RelatedResources": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#ScannedResource" + } + }, "com.amazonaws.cloudformation#Replacement": { "type": "enum", "members": { @@ -8773,6 +9864,9 @@ "target": "com.amazonaws.cloudformation#RequiredActivatedType" } }, + "com.amazonaws.cloudformation#RequiredProperty": { + "type": "boolean" + }, "com.amazonaws.cloudformation#RequiresRecreation": { "type": "enum", "members": { @@ -8920,29 +10014,130 @@ "smithy.api#documentation": "

Indicates whether CloudFormation can determine the target value, and whether the target value will change\n before you execute a change set.

\n

For Static evaluations, CloudFormation can determine that the target value will change, and its\n value. For example, if you directly modify the InstanceType property of an EC2 instance, CloudFormation knows that this property value will change, and its value, so this is a Static\n evaluation.

\n

For Dynamic evaluations, can't determine the target value because it depends on the result of an\n intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is\n updated. For example, if your template includes a reference to a resource that's conditionally recreated, the value\n of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the\n resource is recreated, it will have a new physical ID, so all references to that resource will also be\n updated.

" } }, - "ChangeSource": { - "target": "com.amazonaws.cloudformation#ChangeSource", + "ChangeSource": { + "target": "com.amazonaws.cloudformation#ChangeSource", + "traits": { + "smithy.api#documentation": "

The group to which the CausingEntity value belongs. There are five entity groups:

\n " + } + }, + "CausingEntity": { + "target": "com.amazonaws.cloudformation#CausingEntity", + "traits": { + "smithy.api#documentation": "

The identity of the entity that triggered this change. This entity is a member of the group that's specified by\n the ChangeSource field. For example, if you modified the value of the KeyPairName\n parameter, the CausingEntity is the name of the parameter (KeyPairName).

\n

If the ChangeSource value is DirectModification, no value is given for\n CausingEntity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

For a resource with Modify as the action, the ResourceChange structure describes the\n changes CloudFormation will make to that resource.

" + } + }, + "com.amazonaws.cloudformation#ResourceChangeDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#ResourceChangeDetail" + } + }, + "com.amazonaws.cloudformation#ResourceDefinition": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.cloudformation#ResourceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types in the CloudFormation User Guide\n

", + "smithy.api#required": {} + } + }, + "LogicalResourceId": { + "target": "com.amazonaws.cloudformation#LogicalResourceId", + "traits": { + "smithy.api#documentation": "

The logical resource id for this resource in the generated template.

" + } + }, + "ResourceIdentifier": { + "target": "com.amazonaws.cloudformation#ResourceIdentifierProperties", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of up to 256 key-value pairs that identifies the scanned resource. The key is the name of one of the\n primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list\n in the resource schema.) The value is the value of that primary identifier. For example, for a\n AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair\n could be \"TableName\": \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension\n development.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A resource included in a generated template. This data type is used with the\n CreateGeneratedTemplate and UpdateGeneratedTemplate API actions.

" + } + }, + "com.amazonaws.cloudformation#ResourceDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#ResourceDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.cloudformation#ResourceDetail": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.cloudformation#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types In the CloudFormation User Guide\n

" + } + }, + "LogicalResourceId": { + "target": "com.amazonaws.cloudformation#LogicalResourceId", + "traits": { + "smithy.api#documentation": "

The logical id for this resource in the final generated template.

" + } + }, + "ResourceIdentifier": { + "target": "com.amazonaws.cloudformation#ResourceIdentifierProperties", + "traits": { + "smithy.api#documentation": "

A list of up to 256 key-value pairs that identifies the resource in the generated template. The key is the name\n of one of the primary identifiers for the resource. (Primary identifiers are specified in the\n primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For\n example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the\n key-value pair could be \"TableName\": \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension\n development.

" + } + }, + "ResourceStatus": { + "target": "com.amazonaws.cloudformation#GeneratedTemplateResourceStatus", + "traits": { + "smithy.api#documentation": "

Status of the processing of a resource in a generated template.

\n
\n
InProgress
\n
\n

The resource processing is still in progress.

\n
\n
Complete
\n
\n

The resource processing is complete.

\n
\n
Pending
\n
\n

The resource processing is pending.

\n
\n
Failed
\n
\n

The resource processing has failed.

\n
\n
" + } + }, + "ResourceStatusReason": { + "target": "com.amazonaws.cloudformation#ResourceStatusReason", "traits": { - "smithy.api#documentation": "

The group to which the CausingEntity value belongs. There are five entity groups:

\n " + "smithy.api#documentation": "

The reason for the resource detail, providing more information if a failure happened.

" } }, - "CausingEntity": { - "target": "com.amazonaws.cloudformation#CausingEntity", + "Warnings": { + "target": "com.amazonaws.cloudformation#WarningDetails", "traits": { - "smithy.api#documentation": "

The identity of the entity that triggered this change. This entity is a member of the group that's specified by\n the ChangeSource field. For example, if you modified the value of the KeyPairName\n parameter, the CausingEntity is the name of the parameter (KeyPairName).

\n

If the ChangeSource value is DirectModification, no value is given for\n CausingEntity.

" + "smithy.api#documentation": "

The warnings generated for this resource.

" } } }, "traits": { - "smithy.api#documentation": "

For a resource with Modify as the action, the ResourceChange structure describes the\n changes CloudFormation will make to that resource.

" + "smithy.api#documentation": "

Details about a resource in a generated template

" } }, - "com.amazonaws.cloudformation#ResourceChangeDetails": { + "com.amazonaws.cloudformation#ResourceDetails": { "type": "list", "member": { - "target": "com.amazonaws.cloudformation#ResourceChangeDetail" + "target": "com.amazonaws.cloudformation#ResourceDetail" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } } }, + "com.amazonaws.cloudformation#ResourceIdentifier": { + "type": "string" + }, "com.amazonaws.cloudformation#ResourceIdentifierProperties": { "type": "map", "key": { @@ -9026,6 +10221,145 @@ "com.amazonaws.cloudformation#ResourceProperties": { "type": "string" }, + "com.amazonaws.cloudformation#ResourceScanId": { + "type": "string" + }, + "com.amazonaws.cloudformation#ResourceScanInProgressException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceScanInProgress", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A resource scan is currently in progress. Only one can be run at a time for an account in a Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudformation#ResourceScanLimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceScanLimitExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The limit on resource scans has been exceeded. Reasons include:

\n ", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudformation#ResourceScanNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceScanNotFound", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The resource scan was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudformation#ResourceScanStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + } + } + }, + "com.amazonaws.cloudformation#ResourceScanStatusReason": { + "type": "string" + }, + "com.amazonaws.cloudformation#ResourceScanSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#ResourceScanSummary" + } + }, + "com.amazonaws.cloudformation#ResourceScanSummary": { + "type": "structure", + "members": { + "ResourceScanId": { + "target": "com.amazonaws.cloudformation#ResourceScanId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource scan.

" + } + }, + "Status": { + "target": "com.amazonaws.cloudformation#ResourceScanStatus", + "traits": { + "smithy.api#documentation": "

Status of the resource scan.

\n
\n
INPROGRESS
\n
\n

The resource scan is still in progress.

\n
\n
COMPLETE
\n
\n

The resource scan is complete.

\n
\n
EXPIRED
\n
\n

The resource scan has expired.

\n
\n
FAILED
\n
\n

The resource scan has failed.

\n
\n
" + } + }, + "StatusReason": { + "target": "com.amazonaws.cloudformation#ResourceScanStatusReason", + "traits": { + "smithy.api#documentation": "

The reason for the resource scan status, providing more information if a failure happened.

" + } + }, + "StartTime": { + "target": "com.amazonaws.cloudformation#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the resource scan was started.

" + } + }, + "EndTime": { + "target": "com.amazonaws.cloudformation#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the resource scan was finished.

" + } + }, + "PercentageCompleted": { + "target": "com.amazonaws.cloudformation#PercentageCompleted", + "traits": { + "smithy.api#documentation": "

The percentage of the resource scan that has been completed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the resource scan. This is returned by the ListResourceScan API action.

" + } + }, + "com.amazonaws.cloudformation#ResourceScannerMaxResults": { + "type": "integer" + }, "com.amazonaws.cloudformation#ResourceSignalStatus": { "type": "enum", "members": { @@ -9265,12 +10599,53 @@ } } }, + "com.amazonaws.cloudformation#ResourceTypePrefix": { + "type": "string" + }, "com.amazonaws.cloudformation#ResourceTypes": { "type": "list", "member": { "target": "com.amazonaws.cloudformation#ResourceType" } }, + "com.amazonaws.cloudformation#ResourcesFailed": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.cloudformation#ResourcesPending": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.cloudformation#ResourcesProcessing": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.cloudformation#ResourcesRead": { + "type": "integer" + }, + "com.amazonaws.cloudformation#ResourcesScanned": { + "type": "integer" + }, + "com.amazonaws.cloudformation#ResourcesSucceeded": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.cloudformation#ResourcesToImport": { "type": "list", "member": { @@ -9466,6 +10841,68 @@ } } }, + "com.amazonaws.cloudformation#ScannedResource": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.cloudformation#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types In the CloudFormation User Guide\n

" + } + }, + "ResourceIdentifier": { + "target": "com.amazonaws.cloudformation#JazzResourceIdentifierProperties", + "traits": { + "smithy.api#documentation": "

A list of up to 256 key-value pairs that identifies for the scanned resource. The key is the name of one of the\n primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list\n in the resource schema.) The value is the value of that primary identifier. For example, for a\n AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair\n could be \"TableName\": \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension\n development.

" + } + }, + "ManagedByStack": { + "target": "com.amazonaws.cloudformation#ManagedByStack", + "traits": { + "smithy.api#documentation": "

If true, the resource is managed by a CloudFormation stack.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A scanned resource returned by ListResourceScanResources or\n ListResourceScanRelatedResources.

" + } + }, + "com.amazonaws.cloudformation#ScannedResourceIdentifier": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.cloudformation#ResourceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types In the CloudFormation User Guide\n

", + "smithy.api#required": {} + } + }, + "ResourceIdentifier": { + "target": "com.amazonaws.cloudformation#JazzResourceIdentifierProperties", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of up to 256 key-value pairs that identifies the scanned resource. The key is the name of one of the\n primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list\n in the resource schema.) The value is the value of that primary identifier. For example, for a\n AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair\n could be \"TableName\": \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension\n development.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Identifies a scanned resource. This is used with the ListResourceScanRelatedResources API\n action.

" + } + }, + "com.amazonaws.cloudformation#ScannedResourceIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#ScannedResourceIdentifier" + } + }, + "com.amazonaws.cloudformation#ScannedResources": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#ScannedResource" + } + }, "com.amazonaws.cloudformation#Scope": { "type": "list", "member": { @@ -11387,7 +12824,7 @@ "RegionOrder": { "target": "com.amazonaws.cloudformation#RegionList", "traits": { - "smithy.api#documentation": "

The order of the Regions where you want to perform the stack operation.

" + "smithy.api#documentation": "

The order of the Regions where you want to perform the stack operation.

\n \n

\n RegionOrder isn't followed if AutoDeployment is enabled.

\n " } }, "FailureToleranceCount": { @@ -11945,41 +13382,98 @@ "DriftInformation": { "target": "com.amazonaws.cloudformation#StackDriftInformationSummary", "traits": { - "smithy.api#documentation": "

Summarizes information about whether a stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.

" + "smithy.api#documentation": "

Summarizes information about whether a stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The StackSummary Data Type

" + } + }, + "com.amazonaws.cloudformation#Stacks": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#Stack" + } + }, + "com.amazonaws.cloudformation#StageList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#TemplateStage" + } + }, + "com.amazonaws.cloudformation#StaleRequestException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "StaleRequestException", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "

Another operation has been performed on this stack set since the specified operation was performed.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.cloudformation#StartResourceScan": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#StartResourceScanInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#StartResourceScanOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#ResourceScanInProgressException" + }, + { + "target": "com.amazonaws.cloudformation#ResourceScanLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a scan of the resources in this account in this Region. You can the status of a scan using the\n ListResourceScans API action.

", + "smithy.api#examples": [ + { + "title": "To start a resource scan", + "documentation": "This example shows how to start a new resource scan", + "output": { + "ResourceScanId": "arn:aws:cloudformation:us-east-1:123456789012:resourceScan/88f09db1-d211-4cb7-964b-434e2b8469ca" + } + } + ] + } + }, + "com.amazonaws.cloudformation#StartResourceScanInput": { + "type": "structure", + "members": { + "ClientRequestToken": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

A unique identifier for this StartResourceScan request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to start a new resource scan.

" } } }, "traits": { - "smithy.api#documentation": "

The StackSummary Data Type

" - } - }, - "com.amazonaws.cloudformation#Stacks": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#Stack" - } - }, - "com.amazonaws.cloudformation#StageList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#TemplateStage" + "smithy.api#input": {} } }, - "com.amazonaws.cloudformation#StaleRequestException": { + "com.amazonaws.cloudformation#StartResourceScanOutput": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage" + "ResourceScanId": { + "target": "com.amazonaws.cloudformation#ResourceScanId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource scan. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is\n arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772\n .

" + } } }, "traits": { - "aws.protocols#awsQueryError": { - "code": "StaleRequestException", - "httpResponseCode": 409 - }, - "smithy.api#documentation": "

Another operation has been performed on this stack set since the specified operation was performed.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 + "smithy.api#output": {} } }, "com.amazonaws.cloudformation#StatusMessage": { @@ -12128,9 +13622,46 @@ } } }, + "com.amazonaws.cloudformation#TemplateConfiguration": { + "type": "structure", + "members": { + "DeletionPolicy": { + "target": "com.amazonaws.cloudformation#GeneratedTemplateDeletionPolicy", + "traits": { + "smithy.api#documentation": "

The DeletionPolicy assigned to resources in the generated template. Supported values are:

\n \n

For more information, see \n DeletionPolicy\n attribute in the CloudFormation User Guide.

" + } + }, + "UpdateReplacePolicy": { + "target": "com.amazonaws.cloudformation#GeneratedTemplateUpdateReplacePolicy", + "traits": { + "smithy.api#documentation": "

The UpdateReplacePolicy assigned to resources in the generated template. Supported values\n are:

\n \n

For more information, see \n UpdateReplacePolicy\n attribute in the CloudFormation User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration details of a generated template.

" + } + }, "com.amazonaws.cloudformation#TemplateDescription": { "type": "string" }, + "com.amazonaws.cloudformation#TemplateFormat": { + "type": "enum", + "members": { + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + }, + "YAML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YAML" + } + } + } + }, "com.amazonaws.cloudformation#TemplateParameter": { "type": "structure", "members": { @@ -12169,6 +13700,38 @@ "target": "com.amazonaws.cloudformation#TemplateParameter" } }, + "com.amazonaws.cloudformation#TemplateProgress": { + "type": "structure", + "members": { + "ResourcesSucceeded": { + "target": "com.amazonaws.cloudformation#ResourcesSucceeded", + "traits": { + "smithy.api#documentation": "

The number of resources that succeeded the template generation.

" + } + }, + "ResourcesFailed": { + "target": "com.amazonaws.cloudformation#ResourcesFailed", + "traits": { + "smithy.api#documentation": "

The number of resources that failed the template generation.

" + } + }, + "ResourcesProcessing": { + "target": "com.amazonaws.cloudformation#ResourcesProcessing", + "traits": { + "smithy.api#documentation": "

The number of resources that are in-process for the template generation.

" + } + }, + "ResourcesPending": { + "target": "com.amazonaws.cloudformation#ResourcesPending", + "traits": { + "smithy.api#documentation": "

The number of resources that are still pending the template generation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the progress of the template generation.

" + } + }, "com.amazonaws.cloudformation#TemplateStage": { "type": "enum", "members": { @@ -12186,6 +13749,71 @@ } } }, + "com.amazonaws.cloudformation#TemplateStatusReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.cloudformation#TemplateSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#TemplateSummary" + } + }, + "com.amazonaws.cloudformation#TemplateSummary": { + "type": "structure", + "members": { + "GeneratedTemplateId": { + "target": "com.amazonaws.cloudformation#GeneratedTemplateId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .

" + } + }, + "GeneratedTemplateName": { + "target": "com.amazonaws.cloudformation#GeneratedTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the generated template.

" + } + }, + "Status": { + "target": "com.amazonaws.cloudformation#GeneratedTemplateStatus", + "traits": { + "smithy.api#documentation": "

The status of the template generation. Supported values are:

\n " + } + }, + "StatusReason": { + "target": "com.amazonaws.cloudformation#TemplateStatusReason", + "traits": { + "smithy.api#documentation": "

The reason for the current template generation status. This will provide more details if a failure\n happened.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.cloudformation#CreationTime", + "traits": { + "smithy.api#documentation": "

The time the generated template was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.cloudformation#LastUpdatedTime", + "traits": { + "smithy.api#documentation": "

The time the generated template was last updated.

" + } + }, + "NumberOfResources": { + "target": "com.amazonaws.cloudformation#NumberOfResources", + "traits": { + "smithy.api#documentation": "

The number of resources in the generated template. This is a total of resources in pending, in-progress,\n completed, and failed states.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The summary of a generated template.

" + } + }, "com.amazonaws.cloudformation#TemplateSummaryConfig": { "type": "structure", "members": { @@ -12351,6 +13979,14 @@ } } }, + "com.amazonaws.cloudformation#TotalWarnings": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.cloudformation#TransformName": { "type": "string" }, @@ -12818,6 +14454,140 @@ "target": "com.amazonaws.cloudformation#TypeConfigurationIdentifier" } }, + "com.amazonaws.cloudformation#UpdateGeneratedTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#UpdateGeneratedTemplateInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#UpdateGeneratedTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#AlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudformation#GeneratedTemplateNotFoundException" + }, + { + "target": "com.amazonaws.cloudformation#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a generated template. This can be used to change the name, add and remove resources, refresh resources,\n and change the DeletionPolicy and UpdateReplacePolicy settings. You can check the status of\n the update to the generated template using the DescribeGeneratedTemplate API action.

", + "smithy.api#examples": [ + { + "title": "To update a generated template's name", + "documentation": "This example updates a generated template with a new name.", + "input": { + "GeneratedTemplateName": "JazzyTemplate", + "NewGeneratedTemplateName": "JazzierTemplate" + }, + "output": { + "GeneratedTemplateId": "arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/88f09db1-d211-4cb7-964b-434e2b8469ca" + } + }, + { + "title": "To remove resources from a generated template", + "documentation": "This example removes resources from a generated template", + "input": { + "GeneratedTemplateName": "JazzyTemplate", + "RemoveResources": [ + "LogicalResourceId1", + "LogicalResourceId2" + ] + }, + "output": { + "GeneratedTemplateId": "arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/88f09db1-d211-4cb7-964b-434e2b8469ca" + } + }, + { + "title": "To add resources to a generated template", + "documentation": "This example adds resources to a generated template", + "input": { + "GeneratedTemplateName": "JazzyTemplate", + "AddResources": [ + { + "ResourceType": "AWS::S3::Bucket", + "ResourceIdentifier": { + "BucketName": "jazz-bucket" + } + }, + { + "ResourceType": "AWS::EC2::DHCPOptions", + "ResourceIdentifier": { + "DhcpOptionsId": "random-id123" + } + } + ] + }, + "output": { + "GeneratedTemplateId": "arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/88f09db1-d211-4cb7-964b-434e2b8469ca" + } + } + ] + } + }, + "com.amazonaws.cloudformation#UpdateGeneratedTemplateInput": { + "type": "structure", + "members": { + "GeneratedTemplateName": { + "target": "com.amazonaws.cloudformation#GeneratedTemplateName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of a generated template.

", + "smithy.api#required": {} + } + }, + "NewGeneratedTemplateName": { + "target": "com.amazonaws.cloudformation#GeneratedTemplateName", + "traits": { + "smithy.api#documentation": "

An optional new name to assign to the generated template.

" + } + }, + "AddResources": { + "target": "com.amazonaws.cloudformation#ResourceDefinitions", + "traits": { + "smithy.api#documentation": "

An optional list of resources to be added to the generated template.

" + } + }, + "RemoveResources": { + "target": "com.amazonaws.cloudformation#JazzLogicalResourceIds", + "traits": { + "smithy.api#documentation": "

A list of logical ids for resources to remove from the generated template.

" + } + }, + "RefreshAllResources": { + "target": "com.amazonaws.cloudformation#RefreshAllResources", + "traits": { + "smithy.api#documentation": "

If true, update the resource properties in the generated template with their current live state.\n This feature is useful when the resource properties in your generated a template does not reflect the live state of\n the resource properties. This happens when a user update the resource properties after generating a template.

" + } + }, + "TemplateConfiguration": { + "target": "com.amazonaws.cloudformation#TemplateConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#UpdateGeneratedTemplateOutput": { + "type": "structure", + "members": { + "GeneratedTemplateId": { + "target": "com.amazonaws.cloudformation#GeneratedTemplateId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudformation#UpdateStack": { "type": "operation", "input": { @@ -13421,6 +15191,87 @@ } } }, + "com.amazonaws.cloudformation#WarningDetail": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.cloudformation#WarningType", + "traits": { + "smithy.api#documentation": "

The type of this warning. For more information, see IaC generator and write-only\n properties in the CloudFormation User Guide.

\n \n \n

Currently the resource and property reference documentation does not indicate if a property uses a type of\n oneOf or anyOf. You need to look at the resource provider schema.

\n " + } + }, + "Properties": { + "target": "com.amazonaws.cloudformation#WarningProperties", + "traits": { + "smithy.api#documentation": "

The properties of the resource that are impacted by this warning.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The warnings generated for a specific resource for this generated template.

" + } + }, + "com.amazonaws.cloudformation#WarningDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#WarningDetail" + } + }, + "com.amazonaws.cloudformation#WarningProperties": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#WarningProperty" + } + }, + "com.amazonaws.cloudformation#WarningProperty": { + "type": "structure", + "members": { + "PropertyPath": { + "target": "com.amazonaws.cloudformation#PropertyPath", + "traits": { + "smithy.api#documentation": "

The path of the property. For example, if this is for the S3Bucket member of the Code\n property, the property path would be Code/S3Bucket.

" + } + }, + "Required": { + "target": "com.amazonaws.cloudformation#RequiredProperty", + "traits": { + "smithy.api#documentation": "

If true, the specified property is required.

" + } + }, + "Description": { + "target": "com.amazonaws.cloudformation#PropertyDescription", + "traits": { + "smithy.api#documentation": "

The description of the property from the resource provider schema.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A specific property that is impacted by a warning.

" + } + }, + "com.amazonaws.cloudformation#WarningType": { + "type": "enum", + "members": { + "MUTUALLY_EXCLUSIVE_PROPERTIES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MUTUALLY_EXCLUSIVE_PROPERTIES" + } + }, + "UNSUPPORTED_PROPERTIES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSUPPORTED_PROPERTIES" + } + }, + "MUTUALLY_EXCLUSIVE_TYPES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MUTUALLY_EXCLUSIVE_TYPES" + } + } + } + }, "com.amazonaws.cloudformation#Warnings": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/elastic-load-balancing-v2.json b/codegen/sdk/aws-models/elastic-load-balancing-v2.json index 32c4a8e9005..086c3188548 100644 --- a/codegen/sdk/aws-models/elastic-load-balancing-v2.json +++ b/codegen/sdk/aws-models/elastic-load-balancing-v2.json @@ -971,6 +971,49 @@ } ] } + }, + { + "title": "To create an HTTPS listener", + "documentation": "This example creates an HTTPS listener for the specified load balancer that forwards requests to the specified target group. Note that you must specify an SSL certificate for an HTTPS listener. You can create and manage certificates using AWS Certificate Manager (ACM). Alternatively, you can create a certificate using SSL/TLS tools, get the certificate signed by a certificate authority (CA), and upload the certificate to AWS Identity and Access Management (IAM).", + "input": { + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Protocol": "HTTPS", + "Port": 443, + "SslPolicy": "ELBSecurityPolicy-2015-05", + "Certificates": [ + { + "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-server-cert" + } + ], + "DefaultActions": [ + { + "Type": "forward", + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + } + ] + }, + "output": { + "Listeners": [ + { + "Protocol": "HTTPS", + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "SslPolicy": "ELBSecurityPolicy-2015-05", + "Certificates": [ + { + "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-server-cert" + } + ], + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 443, + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" + } + ] + } } ] } @@ -1147,6 +1190,49 @@ } ] } + }, + { + "title": "To create an internal load balancer", + "documentation": "This example creates an internal load balancer and enables the Availability Zones for the specified subnets.", + "input": { + "Name": "my-internal-load-balancer", + "Subnets": [ + "subnet-b7d581c0", + "subnet-8360a9e7" + ], + "SecurityGroups": [], + "Scheme": "internal" + }, + "output": { + "LoadBalancers": [ + { + "VpcId": "vpc-3ac0fb5f", + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-internal-load-balancer/5b49b8d4303115c2", + "State": { + "Code": "provisioning" + }, + "DNSName": "internal-my-internal-load-balancer-1529930873.us-west-2.elb.amazonaws.com", + "SecurityGroups": [ + "sg-5943793c" + ], + "LoadBalancerName": "my-internal-load-balancer", + "CreatedTime": "2016-03-25T21:29:48.850Z", + "Scheme": "internal", + "Type": "application", + "CanonicalHostedZoneId": "Z2P70J7EXAMPLE", + "AvailabilityZones": [ + { + "SubnetId": "subnet-8360a9e7", + "ZoneName": "us-west-2a" + }, + { + "SubnetId": "subnet-b7d581c0", + "ZoneName": "us-west-2b" + } + ] + } + ] + } } ] } @@ -1165,13 +1251,13 @@ "Subnets": { "target": "com.amazonaws.elasticloadbalancingv2#Subnets", "traits": { - "smithy.api#documentation": "

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You\n must specify either subnets or subnet mappings, but not both. To specify an Elastic IP\n address, specify subnet mappings instead of subnets.

\n

[Application Load Balancers] You must specify subnets from at least two Availability\n Zones.

\n

[Application Load Balancers on Outposts] You must specify one Outpost subnet.

\n

[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.

\n

[Network Load Balancers] You can specify subnets from one or more Availability\n Zones.

\n

[Gateway Load Balancers] You can specify subnets from one or more Availability\n Zones.

" + "smithy.api#documentation": "

The IDs of the subnets. You can specify only one subnet per Availability Zone. You\n must specify either subnets or subnet mappings, but not both. To specify an Elastic IP\n address, specify subnet mappings instead of subnets.

\n

[Application Load Balancers] You must specify subnets from at least two Availability\n Zones.

\n

[Application Load Balancers on Outposts] You must specify one Outpost subnet.

\n

[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.

\n

[Network Load Balancers] You can specify subnets from one or more Availability\n Zones.

\n

[Gateway Load Balancers] You can specify subnets from one or more Availability\n Zones.

" } }, "SubnetMappings": { "target": "com.amazonaws.elasticloadbalancingv2#SubnetMappings", "traits": { - "smithy.api#documentation": "

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You\n must specify either subnets or subnet mappings, but not both.

\n

[Application Load Balancers] You must specify subnets from at least two Availability\n Zones. You cannot specify Elastic IP addresses for your subnets.

\n

[Application Load Balancers on Outposts] You must specify one Outpost subnet.

\n

[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.

\n

[Network Load Balancers] You can specify subnets from one or more Availability Zones. You\n can specify one Elastic IP address per subnet if you need static IP addresses for your\n internet-facing load balancer. For internal load balancers, you can specify one private IP\n address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you\n can specify one IPv6 address per subnet.

\n

[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You\n cannot specify Elastic IP addresses for your subnets.

" + "smithy.api#documentation": "

The IDs of the subnets. You can specify only one subnet per Availability Zone. You\n must specify either subnets or subnet mappings, but not both.

\n

[Application Load Balancers] You must specify subnets from at least two Availability\n Zones. You cannot specify Elastic IP addresses for your subnets.

\n

[Application Load Balancers on Outposts] You must specify one Outpost subnet.

\n

[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.

\n

[Network Load Balancers] You can specify subnets from one or more Availability Zones. You\n can specify one Elastic IP address per subnet if you need static IP addresses for your\n internet-facing load balancer. For internal load balancers, you can specify one private IP\n address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you\n can specify one IPv6 address per subnet.

\n

[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You\n cannot specify Elastic IP addresses for your subnets.

" } }, "SecurityGroups": { @@ -3111,6 +3197,33 @@ } ] } + }, + { + "title": "To describe the health of a target", + "documentation": "This example describes the health of the specified target. This target is healthy.", + "input": { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Targets": [ + { + "Id": "i-0f76fade", + "Port": 80 + } + ] + }, + "output": { + "TargetHealthDescriptions": [ + { + "HealthCheckPort": "80", + "Target": { + "Id": "i-0f76fade", + "Port": 80 + }, + "TargetHealth": { + "State": "healthy" + } + } + ] + } } ], "smithy.api#suppress": [ @@ -5823,6 +5936,40 @@ } ] } + }, + { + "title": "To change the server certificate", + "documentation": "This example changes the server certificate for the specified HTTPS listener.", + "input": { + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65", + "Certificates": [ + { + "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-new-server-cert" + } + ] + }, + "output": { + "Listeners": [ + { + "Protocol": "HTTPS", + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "SslPolicy": "ELBSecurityPolicy-2015-05", + "Certificates": [ + { + "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-new-server-cert" + } + ], + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 443, + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65" + } + ] + } } ] } @@ -5954,6 +6101,88 @@ } ] } + }, + { + "title": "To change the idle timeout", + "documentation": "This example changes the idle timeout value for the specified load balancer.", + "input": { + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Attributes": [ + { + "Key": "idle_timeout.timeout_seconds", + "Value": "30" + } + ] + }, + "output": { + "Attributes": [ + { + "Value": "30", + "Key": "idle_timeout.timeout_seconds" + }, + { + "Value": "false", + "Key": "access_logs.s3.enabled" + }, + { + "Value": "", + "Key": "access_logs.s3.prefix" + }, + { + "Value": "true", + "Key": "deletion_protection.enabled" + }, + { + "Value": "", + "Key": "access_logs.s3.bucket" + } + ] + } + }, + { + "title": "To enable access logs", + "documentation": "This example enables access logs for the specified load balancer. Note that the S3 bucket must exist in the same region as the load balancer and must have a policy attached that grants access to the Elastic Load Balancing service.", + "input": { + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Attributes": [ + { + "Key": "access_logs.s3.enabled", + "Value": "true" + }, + { + "Key": "access_logs.s3.bucket", + "Value": "my-loadbalancer-logs" + }, + { + "Key": "access_logs.s3.prefix", + "Value": "myapp" + } + ] + }, + "output": { + "Attributes": [ + { + "Value": "true", + "Key": "access_logs.s3.enabled" + }, + { + "Value": "my-load-balancer-logs", + "Key": "access_logs.s3.bucket" + }, + { + "Value": "myapp", + "Key": "access_logs.s3.prefix" + }, + { + "Value": "60", + "Key": "idle_timeout.timeout_seconds" + }, + { + "Value": "false", + "Key": "deletion_protection.enabled" + } + ] + } } ] } @@ -6775,6 +7004,23 @@ } ] } + }, + { + "title": "To register targets with a target group using port overrides", + "documentation": "This example registers the specified instance with the specified target group using multiple ports. This enables you to register ECS containers on the same instance as targets in the target group.", + "input": { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/3bb63f11dfb0faf9", + "Targets": [ + { + "Id": "i-80c8dd94", + "Port": 80 + }, + { + "Id": "i-80c8dd94", + "Port": 766 + } + ] + } } ] } @@ -7668,7 +7914,7 @@ "Values": { "target": "com.amazonaws.elasticloadbalancingv2#ListOfString", "traits": { - "smithy.api#documentation": "

The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses.\n Wildcards are not supported.

\n

If you specify multiple addresses, the condition is satisfied if the source IP address of\n the request matches one of the CIDR blocks. This condition is not satisfied by the addresses\n in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use\n HttpHeaderConditionConfig.

" + "smithy.api#documentation": "

The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses.\n Wildcards are not supported.

\n

If you specify multiple addresses, the condition is satisfied if the source IP address of\n the request matches one of the CIDR blocks. This condition is not satisfied by the addresses\n in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use\n HttpHeaderConditionConfig.

\n

The total number of values must be less than, or equal to five.

" } } }, @@ -8072,7 +8318,7 @@ "Key": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupAttributeKey", "traits": { - "smithy.api#documentation": "

The name of the attribute.

\n

The following attributes are supported by all load balancers:

\n \n

The following attributes are supported by Application Load Balancers and \n Network Load Balancers:

\n \n

The following attributes are supported only if the load balancer is an Application Load\n Balancer and the target is an instance or an IP address:

\n \n

The following attribute is supported only if the load balancer is an Application Load\n Balancer and the target is a Lambda function:

\n \n

The following attributes are supported only by Network Load Balancers:

\n \n

The following attributes are supported only by Gateway Load Balancers:

\n " + "smithy.api#documentation": "

The name of the attribute.

\n

The following attributes are supported by all load balancers:

\n \n

The following attributes are supported by Application Load Balancers and \n Network Load Balancers:

\n \n

The following attributes are supported only if the load balancer is an Application Load\n Balancer and the target is an instance or an IP address:

\n \n

The following attribute is supported only if the load balancer is an Application Load\n Balancer and the target is a Lambda function:

\n \n

The following attributes are supported only by Network Load Balancers:

\n \n

The following attributes are supported only by Gateway Load Balancers:

\n " } }, "Value": { @@ -8371,6 +8617,12 @@ "smithy.api#enumValue": "unhealthy" } }, + "UNHEALTHY_DRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unhealthy.draining" + } + }, "UNUSED": { "target": "smithy.api#Unit", "traits": { diff --git a/codegen/sdk/aws-models/glue.json b/codegen/sdk/aws-models/glue.json index 95dbf687787..9b3c16db211 100644 --- a/codegen/sdk/aws-models/glue.json +++ b/codegen/sdk/aws-models/glue.json @@ -17102,7 +17102,7 @@ } }, "MaxResults": { - "target": "com.amazonaws.glue#PageSize", + "target": "com.amazonaws.glue#OrchestrationPageSize200", "traits": { "smithy.api#documentation": "

The maximum size of the response.

" } @@ -19646,7 +19646,7 @@ } }, "MaxResults": { - "target": "com.amazonaws.glue#PageSize", + "target": "com.amazonaws.glue#OrchestrationPageSize200", "traits": { "smithy.api#documentation": "

The maximum size of the response.

" } @@ -22089,7 +22089,7 @@ "Runtime": { "target": "com.amazonaws.glue#RuntimeNameString", "traits": { - "smithy.api#documentation": "

In Ray jobs, Runtime is used to specify the versions of Ray, Python and additional\n libraries available in your environment. This field is not used in other job types. For\n supported runtime environment values, see Working with Ray jobs\n in the Glue Developer Guide.

" + "smithy.api#documentation": "

In Ray jobs, Runtime is used to specify the versions of Ray, Python and additional\n libraries available in your environment. This field is not used in other job types. For\n supported runtime environment values, see Supported Ray runtime environments\n in the Glue Developer Guide.

" } } }, @@ -23188,7 +23188,7 @@ } }, "MaxResults": { - "target": "com.amazonaws.glue#PageSize", + "target": "com.amazonaws.glue#OrchestrationPageSize25", "traits": { "smithy.api#documentation": "

The maximum size of a list to return.

" } @@ -24616,7 +24616,7 @@ } }, "MaxResults": { - "target": "com.amazonaws.glue#PageSize", + "target": "com.amazonaws.glue#OrchestrationPageSize200", "traits": { "smithy.api#documentation": "

The maximum size of a list to return.

" } @@ -24690,7 +24690,7 @@ } }, "MaxResults": { - "target": "com.amazonaws.glue#PageSize", + "target": "com.amazonaws.glue#OrchestrationPageSize25", "traits": { "smithy.api#documentation": "

The maximum size of a list to return.

" } @@ -25996,6 +25996,24 @@ "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" } }, + "com.amazonaws.glue#OrchestrationPageSize200": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.glue#OrchestrationPageSize25": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 25 + } + } + }, "com.amazonaws.glue#OrchestrationRoleArn": { "type": "string", "traits": { diff --git a/codegen/sdk/aws-models/ssm.json b/codegen/sdk/aws-models/ssm.json index 8511482b06a..cc5f43713a5 100644 --- a/codegen/sdk/aws-models/ssm.json +++ b/codegen/sdk/aws-models/ssm.json @@ -2031,6 +2031,12 @@ "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association.

" } }, + "Duration": { + "target": "com.amazonaws.ssm#Duration", + "traits": { + "smithy.api#documentation": "

The number of hours that an association can run on specified targets. After the resulting\n cutoff time passes, associations that are currently running are cancelled, and no pending\n executions are started on remaining targets.

" + } + }, "TargetMaps": { "target": "com.amazonaws.ssm#TargetMaps", "traits": { @@ -2243,6 +2249,12 @@ "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association.

" } }, + "Duration": { + "target": "com.amazonaws.ssm#Duration", + "traits": { + "smithy.api#documentation": "

The number of hours that an association can run on specified targets. After the resulting\n cutoff time passes, associations that are currently running are cancelled, and no pending\n executions are started on remaining targets.

" + } + }, "TargetMaps": { "target": "com.amazonaws.ssm#TargetMaps", "traits": { @@ -3007,6 +3019,12 @@ "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association.

" } }, + "Duration": { + "target": "com.amazonaws.ssm#Duration", + "traits": { + "smithy.api#documentation": "

The number of hours that an association can run on specified targets. After the resulting\n cutoff time passes, associations that are currently running are cancelled, and no pending\n executions are started on remaining targets.

" + } + }, "TargetMaps": { "target": "com.amazonaws.ssm#TargetMaps", "traits": { @@ -5924,6 +5942,12 @@ "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association.

" } }, + "Duration": { + "target": "com.amazonaws.ssm#Duration", + "traits": { + "smithy.api#documentation": "

The number of hours the association can run before it is canceled. Duration applies to\n associations that are currently running, and any pending and in progress commands on all targets.\n If a target was taken offline for the association to run, it is made available again immediately,\n without a reboot.

\n

The Duration parameter applies only when both these conditions are true:

\n " + } + }, "TargetMaps": { "target": "com.amazonaws.ssm#TargetMaps", "traits": { @@ -6065,6 +6089,12 @@ "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association. For example, if you\n specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify an offset of 3\n to run the association each Sunday after the second Thursday of the month. For more information\n about cron schedules for associations, see Reference: Cron\n and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.

\n \n

To use offsets, you must specify the ApplyOnlyAtCronInterval parameter. This\n option tells the system not to run an association immediately after you create it.

\n " } }, + "Duration": { + "target": "com.amazonaws.ssm#Duration", + "traits": { + "smithy.api#documentation": "

The number of hours the association can run before it is canceled. Duration applies to\n associations that are currently running, and any pending and in progress commands on all targets.\n If a target was taken offline for the association to run, it is made available again immediately,\n without a reboot.

\n

The Duration parameter applies only when both these conditions are true:

\n " + } + }, "TargetMaps": { "target": "com.amazonaws.ssm#TargetMaps", "traits": { @@ -8253,7 +8283,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all patches eligible to be included in a patch baseline.

", + "smithy.api#documentation": "

Lists all patches eligible to be included in a patch baseline.

\n \n

Currently, DescribeAvailablePatches supports only the Amazon Linux 1, Amazon\n Linux 2, and Windows Server operating systems.

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8439,7 +8469,7 @@ "VersionName": { "target": "com.amazonaws.ssm#DocumentVersionName", "traits": { - "smithy.api#documentation": "

An optional field specifying the version of the artifact associated with the document. For\n example, \"Release 12, Update 6\". This value is unique across all versions of a document, and\n can't be changed.

" + "smithy.api#documentation": "

An optional field specifying the version of the artifact associated with the document. For\n example, 12.6. This value is unique across all versions of a document, and\n can't be changed.

" } } }, @@ -10784,7 +10814,7 @@ "VersionName": { "target": "com.amazonaws.ssm#DocumentVersionName", "traits": { - "smithy.api#documentation": "

An optional field specifying the version of the artifact associated with the document. For\n example, \"Release 12, Update 6\". This value is unique across all versions of a document, and\n can't be changed.

" + "smithy.api#documentation": "

An optional field specifying the version of the artifact associated with the document. For\n example, 12.6. This value is unique across all versions of a document, and\n can't be changed.

" } }, "PlatformTypes": { @@ -11095,7 +11125,7 @@ "VersionName": { "target": "com.amazonaws.ssm#DocumentVersionName", "traits": { - "smithy.api#documentation": "

An optional field specifying the version of the artifact associated with the document. For\n example, \"Release 12, Update 6\". This value is unique across all versions of a document, and\n can't be changed.

" + "smithy.api#documentation": "

An optional field specifying the version of the artifact associated with the document. For\n example, 12.6. This value is unique across all versions of a document, and\n can't be changed.

" } } }, @@ -11436,7 +11466,7 @@ "VersionName": { "target": "com.amazonaws.ssm#DocumentVersionName", "traits": { - "smithy.api#documentation": "

The version of the artifact associated with the document. For example, \"Release 12, Update\n 6\". This value is unique across all versions of a document, and can't be changed.

" + "smithy.api#documentation": "

The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

" } }, "CreatedDate": { @@ -11586,6 +11616,15 @@ "smithy.api#error": "client" } }, + "com.amazonaws.ssm#Duration": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 24 + } + } + }, "com.amazonaws.ssm#EffectiveInstanceAssociationMaxResults": { "type": "integer", "traits": { @@ -12201,7 +12240,7 @@ "Status": { "target": "com.amazonaws.ssm#ConnectionStatus", "traits": { - "smithy.api#documentation": "

The status of the connection to the managed node. For example, 'Connected' or 'Not\n Connected'.

" + "smithy.api#documentation": "

The status of the connection to the managed node.

" } } }, @@ -12379,7 +12418,7 @@ "VersionName": { "target": "com.amazonaws.ssm#DocumentVersionName", "traits": { - "smithy.api#documentation": "

An optional field specifying the version of the artifact associated with the document. For\n example, \"Release 12, Update 6\". This value is unique across all versions of a document and can't\n be changed.

" + "smithy.api#documentation": "

An optional field specifying the version of the artifact associated with the document. For\n example, 12.6. This value is unique across all versions of a document and can't\n be changed.

" } }, "DocumentVersion": { @@ -12423,7 +12462,7 @@ "VersionName": { "target": "com.amazonaws.ssm#DocumentVersionName", "traits": { - "smithy.api#documentation": "

The version of the artifact associated with the document. For example, \"Release 12, Update\n 6\". This value is unique across all versions of a document, and can't be changed.

" + "smithy.api#documentation": "

The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

" } }, "DocumentVersion": { @@ -21808,7 +21847,7 @@ "KeyId": { "target": "com.amazonaws.ssm#ParameterKeyId", "traits": { - "smithy.api#documentation": "

The ID of the query key used for this parameter.

" + "smithy.api#documentation": "

The alias of the Key Management Service (KMS) key used to encrypt the\n parameter. Applies to SecureString parameters only

" } }, "LastModifiedDate": { @@ -21996,7 +22035,7 @@ "KeyId": { "target": "com.amazonaws.ssm#ParameterKeyId", "traits": { - "smithy.api#documentation": "

The ID of the query key used for this parameter.

" + "smithy.api#documentation": "

The alias of the Key Management Service (KMS) key used to encrypt the\n parameter. Applies to SecureString parameters only.

" } }, "LastModifiedDate": { @@ -22709,7 +22748,7 @@ "CVEIds": { "target": "com.amazonaws.ssm#PatchCVEIds", "traits": { - "smithy.api#documentation": "

The IDs of one or more Common Vulnerabilities and Exposure (CVE) issues that are resolved by\n the patch.

" + "smithy.api#documentation": "

The IDs of one or more Common Vulnerabilities and Exposure (CVE) issues that are resolved by\n the patch.

\n \n

Currently, CVE ID values are reported only for patches with a status of\n Missing or Failed.

\n " } } }, @@ -28268,6 +28307,12 @@ "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association. For example, if you\n specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify an offset of 3\n to run the association each Sunday after the second Thursday of the month. For more information\n about cron schedules for associations, see Reference: Cron\n and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.

\n \n

To use offsets, you must specify the ApplyOnlyAtCronInterval parameter. This\n option tells the system not to run an association immediately after you create it.

\n " } }, + "Duration": { + "target": "com.amazonaws.ssm#Duration", + "traits": { + "smithy.api#documentation": "

The number of hours the association can run before it is canceled. Duration applies to\n associations that are currently running, and any pending and in progress commands on all targets.\n If a target was taken offline for the association to run, it is made available again immediately,\n without a reboot.

\n

The Duration parameter applies only when both these conditions are true:

\n " + } + }, "TargetMaps": { "target": "com.amazonaws.ssm#TargetMaps", "traits": { @@ -28570,7 +28615,7 @@ "VersionName": { "target": "com.amazonaws.ssm#DocumentVersionName", "traits": { - "smithy.api#documentation": "

An optional field specifying the version of the artifact you are updating with the document.\n For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and\n can't be changed.

" + "smithy.api#documentation": "

An optional field specifying the version of the artifact you are updating with the document.\n For example, 12.6. This value is unique across all versions of a document, and\n can't be changed.

" } }, "DocumentVersion": { From f38f728d4065894d3a5f1927d34e81370c01b7e4 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Wed, 31 Jan 2024 19:04:13 +0000 Subject: [PATCH 2/4] feat: update AWS service endpoints metadata --- .../src/main/resources/aws/sdk/kotlin/codegen/endpoints.json | 1 + 1 file changed, 1 insertion(+) diff --git a/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json b/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json index a8267944058..44492f21523 100644 --- a/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json +++ b/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json @@ -16869,6 +16869,7 @@ "deprecated" : true, "hostname" : "sms-voice-fips.us-west-2.amazonaws.com" }, + "il-central-1" : { }, "us-east-1" : { "variants" : [ { "hostname" : "sms-voice-fips.us-east-1.amazonaws.com", From 27d83581dfc1d76ca68d1a3d9209acc273d06786 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Wed, 31 Jan 2024 19:05:31 +0000 Subject: [PATCH 3/4] chore: release 1.0.47 --- CHANGELOG.md | 8 ++++++++ gradle.properties | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 692ef07f66f..3b30e9ee12f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## [1.0.47] - 01/31/2024 + +### Features +* (**cloudformation**) CloudFormation IaC generator allows you to scan existing resources in your account and select resources to generate a template for a new or existing CloudFormation stack. +* (**elasticloadbalancingv2**) This release enables unhealthy target draining intervals for Network Load Balancers. +* (**glue**) Update page size limits for GetJobRuns and GetTriggers APIs. +* (**ssm**) This release adds an optional Duration parameter to StateManager Associations. This allows customers to specify how long an apply-only-on-cron association execution should run. Once the specified Duration is out all the ongoing cancellable commands or automations are cancelled. + ## [1.0.46] - 01/30/2024 ### Features diff --git a/gradle.properties b/gradle.properties index 66258243c92..5eebca235ca 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=1.0.47-SNAPSHOT +sdkVersion=1.0.47 # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 6df6e01fb9eca78a29cc563aa9e0a27e7eaf8acd Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Wed, 31 Jan 2024 19:05:32 +0000 Subject: [PATCH 4/4] chore: bump snapshot version to 1.0.48-SNAPSHOT --- gradle.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle.properties b/gradle.properties index 5eebca235ca..7546ca5cb65 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=1.0.47 +sdkVersion=1.0.48-SNAPSHOT # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/