Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you create a change set for an existing stack, CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack.
To create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify CREATE. To create a change set for an existing stack, specify UPDATE for the ChangeSetType parameter. To create a change set for an import operation, specify IMPORT for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action.
When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. CloudFormation doesn't make changes until you execute the change set.
To create a change set for the entire stack hierarchy, set IncludeNestedStacks to True.
Creates a template from existing resources that are not already managed with CloudFormation. You can check the status of the template generation using the DescribeGeneratedTemplate API action.
Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
If the call successfully completes, CloudFormation successfully deleted the change set.
If IncludeNestedStacks specifies True during the creation of the nested change set, then DeleteChangeSet will delete all change sets that belong to the stacks hierarchy and will also delete all change sets for nested stacks with the status of REVIEW_IN_PROGRESS.
Deleted a generated template.
" + }, "DeleteStack":{ "name":"DeleteStack", "http":{ @@ -330,6 +361,22 @@ ], "documentation":"Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
" }, + "DescribeGeneratedTemplate":{ + "name":"DescribeGeneratedTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeGeneratedTemplateInput"}, + "output":{ + "shape":"DescribeGeneratedTemplateOutput", + "resultWrapper":"DescribeGeneratedTemplateResult" + }, + "errors":[ + {"shape":"GeneratedTemplateNotFoundException"} + ], + "documentation":"Describes a generated template. The output includes details about the progress of the creation of a generated template started by a CreateGeneratedTemplate API action or the update of a generated template started with an UpdateGeneratedTemplate API action.
Returns information about a CloudFormation extension publisher.
If you don't supply a PublisherId, and you have registered as an extension publisher, DescribePublisher returns information about your own publisher account.
For more information about registering as a publisher, see:
Publishing extensions to make them available for public use in the CloudFormation CLI User Guide
Describes details of a resource scan.
" + }, "DescribeStackDriftDetectionStatus":{ "name":"DescribeStackDriftDetectionStatus", "http":{ @@ -603,6 +666,22 @@ ], "documentation":"Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.
When you execute a change set, CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.
If a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.
To create a change set for the entire stack hierarchy, IncludeNestedStacks must have been set to True.
Retrieves a generated template. If the template is in an InProgress or Pending status then the template returned will be the template when the template was last in a Complete status. If the template has not yet been in a Complete status then an empty template will be returned.
Lists all exported output values in the account and Region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue function.
For more information, see CloudFormation export stack output values.
" }, + "ListGeneratedTemplates":{ + "name":"ListGeneratedTemplates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGeneratedTemplatesInput"}, + "output":{ + "shape":"ListGeneratedTemplatesOutput", + "resultWrapper":"ListGeneratedTemplatesResult" + }, + "documentation":"Lists your generated templates in this Region.
" + }, "ListImports":{ "name":"ListImports", "http":{ @@ -709,6 +801,53 @@ }, "documentation":"Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.
For more information about importing an exported output value, see the Fn::ImportValue function.
" }, + "ListResourceScanRelatedResources":{ + "name":"ListResourceScanRelatedResources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResourceScanRelatedResourcesInput"}, + "output":{ + "shape":"ListResourceScanRelatedResourcesOutput", + "resultWrapper":"ListResourceScanRelatedResourcesResult" + }, + "errors":[ + {"shape":"ResourceScanNotFoundException"}, + {"shape":"ResourceScanInProgressException"} + ], + "documentation":"Lists the related resources for a list of resources from a resource scan. The response indicates whether each returned resource is already managed by CloudFormation.
" + }, + "ListResourceScanResources":{ + "name":"ListResourceScanResources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResourceScanResourcesInput"}, + "output":{ + "shape":"ListResourceScanResourcesOutput", + "resultWrapper":"ListResourceScanResourcesResult" + }, + "errors":[ + {"shape":"ResourceScanNotFoundException"}, + {"shape":"ResourceScanInProgressException"} + ], + "documentation":"Lists the resources from a resource scan. The results can be filtered by resource identifier, resource type prefix, tag key, and tag value. Only resources that match all specified filters are returned. The response indicates whether each returned resource is already managed by CloudFormation.
" + }, + "ListResourceScans":{ + "name":"ListResourceScans", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResourceScansInput"}, + "output":{ + "shape":"ListResourceScansOutput", + "resultWrapper":"ListResourceScansResult" + }, + "documentation":"List the resource scans from newest to oldest. By default it will return up to 10 resource scans.
" + }, "ListStackInstanceResourceDrifts":{ "name":"ListStackInstanceResourceDrifts", "http":{ @@ -1005,6 +1144,23 @@ "input":{"shape":"SignalResourceInput"}, "documentation":"Sends a signal to the specified resource with a success or failure status. You can use the SignalResource operation in conjunction with a creation policy or update policy. CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource operation is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.
Starts a scan of the resources in this account in this Region. You can the status of a scan using the ListResourceScans API action.
Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
For resource types, this includes passing all contracts tests defined for the type.
For modules, this includes determining if the module's model meets all necessary requirements.
For more information, see Testing your public extension prior to publishing in the CloudFormation CLI User Guide.
If you don't specify a version, CloudFormation uses the default version of the extension in your account and Region for testing.
To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see RegisterType.
Once you've initiated testing on an extension using TestType, you can pass the returned TypeVersionArn into DescribeType to monitor the current test status and test status description for the extension.
An extension must have a test status of PASSED before it can be published. For more information, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.
Updates a generated template. This can be used to change the name, add and remove resources, refresh resources, and change the DeletionPolicy and UpdateReplacePolicy settings. You can check the status of the update to the generated template using the DescribeGeneratedTemplate API action.
No more than 5 generated templates can be in an InProgress or Pending status at one time. This error is also returned if a generated template that is in an InProgress or Pending status is attempted to be updated or deleted.
The output for the CreateChangeSet action.
" }, + "CreateGeneratedTemplateInput":{ + "type":"structure", + "required":["GeneratedTemplateName"], + "members":{ + "Resources":{ + "shape":"ResourceDefinitions", + "documentation":"An optional list of resources to be included in the generated template.
If no resources are specified,the template will be created without any resources. Resources can be added to the template using the UpdateGeneratedTemplate API action.
The name assigned to the generated template.
" + }, + "StackName":{ + "shape":"StackName", + "documentation":"An optional name or ARN of a stack to use as the base stack for the generated template.
" + }, + "TemplateConfiguration":{ + "shape":"TemplateConfiguration", + "documentation":"The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.
The ID of the generated template.
" + } + } + }, "CreateStackInput":{ "type":"structure", "required":["StackName"], @@ -1833,7 +2050,7 @@ }, "TimeoutInMinutes":{ "shape":"TimeoutMinutes", - "documentation":"The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.
The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.
The output for the DeleteChangeSet action.
" }, + "DeleteGeneratedTemplateInput":{ + "type":"structure", + "required":["GeneratedTemplateName"], + "members":{ + "GeneratedTemplateName":{ + "shape":"GeneratedTemplateName", + "documentation":"The name or Amazon Resource Name (ARN) of a generated template.
" + } + } + }, "DeleteStackInput":{ "type":"structure", "required":["StackName"], @@ -2423,6 +2650,65 @@ }, "documentation":"The output for the DescribeChangeSet action.
" }, + "DescribeGeneratedTemplateInput":{ + "type":"structure", + "required":["GeneratedTemplateName"], + "members":{ + "GeneratedTemplateName":{ + "shape":"GeneratedTemplateName", + "documentation":"The name or Amazon Resource Name (ARN) of a generated template.
" + } + } + }, + "DescribeGeneratedTemplateOutput":{ + "type":"structure", + "members":{ + "GeneratedTemplateId":{ + "shape":"GeneratedTemplateId", + "documentation":"The Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example, arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc .
The name of the generated template.
" + }, + "Resources":{ + "shape":"ResourceDetails", + "documentation":"A list of objects describing the details of the resources in the template generation.
" + }, + "Status":{ + "shape":"GeneratedTemplateStatus", + "documentation":"The status of the template generation. Supported values are:
CreatePending - the creation of the template is pending.
CreateInProgress - the creation of the template is in progress.
DeletePending - the deletion of the template is pending.
DeleteInProgress - the deletion of the template is in progress.
UpdatePending - the update of the template is pending.
UpdateInProgress - the update of the template is in progress.
Failed - the template operation failed.
Complete - the template operation is complete.
The reason for the current template generation status. This will provide more details if a failure happened.
" + }, + "CreationTime":{ + "shape":"CreationTime", + "documentation":"The time the generated template was created.
" + }, + "LastUpdatedTime":{ + "shape":"LastUpdatedTime", + "documentation":"The time the generated template was last updated.
" + }, + "Progress":{ + "shape":"TemplateProgress", + "documentation":"An object describing the progress of the template generation.
" + }, + "StackId":{ + "shape":"StackId", + "documentation":"The stack ARN of the base stack if a base stack was provided when generating the template.
" + }, + "TemplateConfiguration":{ + "shape":"TemplateConfiguration", + "documentation":"The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.
The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.
" + } + } + }, "DescribeOrganizationsAccessInput":{ "type":"structure", "members":{ @@ -2471,6 +2757,57 @@ } } }, + "DescribeResourceScanInput":{ + "type":"structure", + "required":["ResourceScanId"], + "members":{ + "ResourceScanId":{ + "shape":"ResourceScanId", + "documentation":"The Amazon Resource Name (ARN) of the resource scan.
" + } + } + }, + "DescribeResourceScanOutput":{ + "type":"structure", + "members":{ + "ResourceScanId":{ + "shape":"ResourceScanId", + "documentation":"The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 .
Status of the resource scan.
The resource scan is still in progress.
The resource scan is complete.
The resource scan has expired.
The resource scan has failed.
The reason for the resource scan status, providing more information if a failure happened.
" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"The time that the resource scan was started.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The time that the resource scan was finished.
" + }, + "PercentageCompleted":{ + "shape":"PercentageCompleted", + "documentation":"The percentage of the resource scan that has been completed.
" + }, + "ResourceTypes":{ + "shape":"ResourceTypes", + "documentation":"The list of resource types for the specified scan. Resource types are only available for scans with a Status set to COMPLETE or FAILED .
The number of resources that were listed. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .
The number of resources that were read. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .
This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException.
The generated template was not found.
", + "error":{ + "code":"GeneratedTemplateNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "GeneratedTemplateResourceStatus":{ + "type":"string", + "enum":[ + "PENDING", + "IN_PROGRESS", + "FAILED", + "COMPLETE" + ] + }, + "GeneratedTemplateStatus":{ + "type":"string", + "enum":[ + "CREATE_PENDING", + "UPDATE_PENDING", + "DELETE_PENDING", + "CREATE_IN_PROGRESS", + "UPDATE_IN_PROGRESS", + "DELETE_IN_PROGRESS", + "FAILED", + "COMPLETE" + ] + }, + "GeneratedTemplateUpdateReplacePolicy":{ + "type":"string", + "enum":[ + "DELETE", + "RETAIN" + ] + }, + "GetGeneratedTemplateInput":{ + "type":"structure", + "required":["GeneratedTemplateName"], + "members":{ + "Format":{ + "shape":"TemplateFormat", + "documentation":"The language to use to retrieve for the generated template. Supported values are:
JSON
YAML
The name or Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example, arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc .
The status of the template generation. Supported values are:
CreatePending - the creation of the template is pending.
CreateInProgress - the creation of the template is in progress.
DeletePending - the deletion of the template is pending.
DeleteInProgress - the deletion of the template is in progress.
UpdatePending - the update of the template is pending.
UpdateInProgress - the update of the template is in progress.
Failed - the template operation failed.
Complete - the template operation is complete.
The template body of the generated template, in the language specified by the Language parameter.
The output for the ListExports action.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is no additional page, this value is null.
" + } + } + }, + "ListGeneratedTemplatesInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"A string that identifies the next page of resource scan results.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":" If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. By default the ListGeneratedTemplates API action will return at most 50 results in each response. The maximum value is 100.
A list of summaries of the generated templates.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListGeneratedTemplates again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.
The name of the exported output value. CloudFormation returns the stack names that are importing this value.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"A string (provided by the ListImports response output) that identifies the next page of stacks that are importing the specified exported output value.
" + } + } + }, + "ListImportsOutput":{ + "type":"structure", + "members":{ + "Imports":{ + "shape":"Imports", + "documentation":"A list of stack names that are importing the specified exported output value.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"A string that identifies the next page of exports. If there is no additional page, this value is null.
" + } + } + }, + "ListResourceScanRelatedResourcesInput":{ + "type":"structure", + "required":[ + "ResourceScanId", + "Resources" + ], + "members":{ + "ResourceScanId":{ + "shape":"ResourceScanId", + "documentation":"The Amazon Resource Name (ARN) of the resource scan.
" + }, + "Resources":{ + "shape":"ScannedResourceIdentifiers", + "documentation":"The list of resources for which you want to get the related resources. Up to 100 resources can be provided.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"A string that identifies the next page of resource scan results.
" + }, + "MaxResults":{ + "shape":"BoxedMaxResults", + "documentation":" If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. By default the ListResourceScanRelatedResources API action will return up to 100 results in each response. The maximum value is 100.
List of up to MaxResults resources in the specified resource scan related to the specified resources.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResourceScanRelatedResources again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.
The Amazon Resource Name (ARN) of the resource scan.
" + }, + "ResourceIdentifier":{ + "shape":"ResourceIdentifier", + "documentation":"If specified, the returned resources will have the specified resource identifier (or one of them in the case where the resource has multiple identifiers).
" + }, + "ResourceTypePrefix":{ + "shape":"ResourceTypePrefix", + "documentation":"If specified, the returned resources will be of any of the resource types with the specified prefix.
" + }, + "TagKey":{ + "shape":"TagKey", + "documentation":"If specified, the returned resources will have a matching tag key.
" + }, + "TagValue":{ + "shape":"TagValue", + "documentation":"If specified, the returned resources will have a matching tag value.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"A string that identifies the next page of resource scan results.
" + }, + "MaxResults":{ + "shape":"ResourceScannerMaxResults", + "documentation":" If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. By default the ListResourceScanResources API action will return at most 100 results in each response. The maximum value is 100.
The output for the ListExports action.
" + "Resources":{ + "shape":"ScannedResources", + "documentation":"List of up to MaxResults resources in the specified resource scan that match all of the specified filters.
If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is no additional page, this value is null.
" + "documentation":"If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResourceScanResources again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.
The name of the exported output value. CloudFormation returns the stack names that are importing this value.
" - }, "NextToken":{ "shape":"NextToken", - "documentation":"A string (provided by the ListImports response output) that identifies the next page of stacks that are importing the specified exported output value.
" + "documentation":"A string that identifies the next page of resource scan results.
" + }, + "MaxResults":{ + "shape":"ResourceScannerMaxResults", + "documentation":" If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. The default value is 10. The maximum value is 100.
A list of stack names that are importing the specified exported output value.
" + "ResourceScanSummaries":{ + "shape":"ResourceScanSummaries", + "documentation":"The list of scans returned.
" }, "NextToken":{ "shape":"NextToken", - "documentation":"A string that identifies the next page of exports. If there is no additional page, this value is null.
" + "documentation":"If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResourceScans again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types in the CloudFormation User Guide
The logical resource id for this resource in the generated template.
" + }, + "ResourceIdentifier":{ + "shape":"ResourceIdentifierProperties", + "documentation":"A list of up to 256 key-value pairs that identifies the scanned resource. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be \"TableName\": \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development.
A resource included in a generated template. This data type is used with the CreateGeneratedTemplate and UpdateGeneratedTemplate API actions.
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide
The logical id for this resource in the final generated template.
" + }, + "ResourceIdentifier":{ + "shape":"ResourceIdentifierProperties", + "documentation":"A list of up to 256 key-value pairs that identifies the resource in the generated template. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be \"TableName\": \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development.
Status of the processing of a resource in a generated template.
The resource processing is still in progress.
The resource processing is complete.
The resource processing is pending.
The resource processing has failed.
The reason for the resource detail, providing more information if a failure happened.
" + }, + "Warnings":{ + "shape":"WarningDetails", + "documentation":"The warnings generated for this resource.
" + } + }, + "documentation":"Details about a resource in a generated template
" + }, + "ResourceDetails":{ + "type":"list", + "member":{"shape":"ResourceDetail"}, + "max":500, + "min":1 + }, + "ResourceIdentifier":{"type":"string"}, "ResourceIdentifierProperties":{ "type":"map", "key":{"shape":"ResourceIdentifierPropertyKey"}, @@ -4792,6 +5442,91 @@ "min":1 }, "ResourceProperties":{"type":"string"}, + "ResourceScanId":{"type":"string"}, + "ResourceScanInProgressException":{ + "type":"structure", + "members":{ + }, + "documentation":"A resource scan is currently in progress. Only one can be run at a time for an account in a Region.
", + "error":{ + "code":"ResourceScanInProgress", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ResourceScanLimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"The limit on resource scans has been exceeded. Reasons include:
Exceeded the daily quota for resource scans.
A resource scan recently failed. You must wait 10 minutes before starting a new resource scan.
The last resource scan failed after exceeding 100,000 resources. When this happens, you must wait 24 hours before starting a new resource scan.
The resource scan was not found.
", + "error":{ + "code":"ResourceScanNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ResourceScanStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "FAILED", + "COMPLETE", + "EXPIRED" + ] + }, + "ResourceScanStatusReason":{"type":"string"}, + "ResourceScanSummaries":{ + "type":"list", + "member":{"shape":"ResourceScanSummary"} + }, + "ResourceScanSummary":{ + "type":"structure", + "members":{ + "ResourceScanId":{ + "shape":"ResourceScanId", + "documentation":"The Amazon Resource Name (ARN) of the resource scan.
" + }, + "Status":{ + "shape":"ResourceScanStatus", + "documentation":"Status of the resource scan.
The resource scan is still in progress.
The resource scan is complete.
The resource scan has expired.
The resource scan has failed.
The reason for the resource scan status, providing more information if a failure happened.
" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"The time that the resource scan was started.
" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"The time that the resource scan was finished.
" + }, + "PercentageCompleted":{ + "shape":"PercentageCompleted", + "documentation":"The percentage of the resource scan that has been completed.
" + } + }, + "documentation":"A summary of the resource scan. This is returned by the ListResourceScan API action.
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide
A list of up to 256 key-value pairs that identifies for the scanned resource. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be \"TableName\": \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development.
If true, the resource is managed by a CloudFormation stack.
A scanned resource returned by ListResourceScanResources or ListResourceScanRelatedResources.
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide
A list of up to 256 key-value pairs that identifies the scanned resource. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be \"TableName\": \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development.
Identifies a scanned resource. This is used with the ListResourceScanRelatedResources API action.
The order of the Regions where you want to perform the stack operation.
" + "documentation":"The order of the Regions where you want to perform the stack operation.
RegionOrder isn't followed if AutoDeployment is enabled.
A unique identifier for this StartResourceScan request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to start a new resource scan.
The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 .
The DeletionPolicy assigned to resources in the generated template. Supported values are:
DELETE - delete all resources when the stack is deleted.
RETAIN - retain all resources when the stack is deleted.
For more information, see DeletionPolicy attribute in the CloudFormation User Guide.
The UpdateReplacePolicy assigned to resources in the generated template. Supported values are:
DELETE - delete all resources when the resource is replaced during an update operation.
RETAIN - retain all resources when the resource is replaced during an update operation.
For more information, see UpdateReplacePolicy attribute in the CloudFormation User Guide.
The configuration details of a generated template.
" + }, "TemplateDescription":{"type":"string"}, + "TemplateFormat":{ + "type":"string", + "enum":[ + "JSON", + "YAML" + ] + }, "TemplateParameter":{ "type":"structure", "members":{ @@ -6538,6 +7375,28 @@ "type":"list", "member":{"shape":"TemplateParameter"} }, + "TemplateProgress":{ + "type":"structure", + "members":{ + "ResourcesSucceeded":{ + "shape":"ResourcesSucceeded", + "documentation":"The number of resources that succeeded the template generation.
" + }, + "ResourcesFailed":{ + "shape":"ResourcesFailed", + "documentation":"The number of resources that failed the template generation.
" + }, + "ResourcesProcessing":{ + "shape":"ResourcesProcessing", + "documentation":"The number of resources that are in-process for the template generation.
" + }, + "ResourcesPending":{ + "shape":"ResourcesPending", + "documentation":"The number of resources that are still pending the template generation.
" + } + }, + "documentation":"A summary of the progress of the template generation.
" + }, "TemplateStage":{ "type":"string", "enum":[ @@ -6545,6 +7404,49 @@ "Processed" ] }, + "TemplateStatusReason":{ + "type":"string", + "max":256, + "min":1 + }, + "TemplateSummaries":{ + "type":"list", + "member":{"shape":"TemplateSummary"} + }, + "TemplateSummary":{ + "type":"structure", + "members":{ + "GeneratedTemplateId":{ + "shape":"GeneratedTemplateId", + "documentation":"The Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example, arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc .
The name of the generated template.
" + }, + "Status":{ + "shape":"GeneratedTemplateStatus", + "documentation":"The status of the template generation. Supported values are:
CreatePending - the creation of the template is pending.
CreateInProgress - the creation of the template is in progress.
DeletePending - the deletion of the template is pending.
DeleteInProgress - the deletion of the template is in progress.
UpdatePending - the update of the template is pending.
UpdateInProgress - the update of the template is in progress.
Failed - the template operation failed.
Complete - the template operation is complete.
The reason for the current template generation status. This will provide more details if a failure happened.
" + }, + "CreationTime":{ + "shape":"CreationTime", + "documentation":"The time the generated template was created.
" + }, + "LastUpdatedTime":{ + "shape":"LastUpdatedTime", + "documentation":"The time the generated template was last updated.
" + }, + "NumberOfResources":{ + "shape":"NumberOfResources", + "documentation":"The number of resources in the generated template. This is a total of resources in pending, in-progress, completed, and failed states.
" + } + }, + "documentation":"The summary of a generated template.
" + }, "TemplateSummaryConfig":{ "type":"structure", "members":{ @@ -6628,6 +7530,10 @@ "type":"integer", "min":0 }, + "TotalWarnings":{ + "type":"integer", + "min":0 + }, "TransformName":{"type":"string"}, "TransformsList":{ "type":"list", @@ -6915,6 +7821,45 @@ "type":"list", "member":{"shape":"TypeConfigurationIdentifier"} }, + "UpdateGeneratedTemplateInput":{ + "type":"structure", + "required":["GeneratedTemplateName"], + "members":{ + "GeneratedTemplateName":{ + "shape":"GeneratedTemplateName", + "documentation":"The name or Amazon Resource Name (ARN) of a generated template.
" + }, + "NewGeneratedTemplateName":{ + "shape":"GeneratedTemplateName", + "documentation":"An optional new name to assign to the generated template.
" + }, + "AddResources":{ + "shape":"ResourceDefinitions", + "documentation":"An optional list of resources to be added to the generated template.
" + }, + "RemoveResources":{ + "shape":"JazzLogicalResourceIds", + "documentation":"A list of logical ids for resources to remove from the generated template.
" + }, + "RefreshAllResources":{ + "shape":"RefreshAllResources", + "documentation":"If true, update the resource properties in the generated template with their current live state. This feature is useful when the resource properties in your generated a template does not reflect the live state of the resource properties. This happens when a user update the resource properties after generating a template.
The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.
The Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example, arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc .
The type of this warning. For more information, see IaC generator and write-only properties in the CloudFormation User Guide.
MUTUALLY_EXCLUSIVE_PROPERTIES - The resource requires mutually-exclusive write-only properties. The IaC generator selects one set of mutually exclusive properties and converts the included properties into parameters. The parameter names have a suffix OneOf and the parameter descriptions indicate that the corresponding property can be replaced with other exclusive properties.
UNSUPPORTED_PROPERTIES - Unsupported properties are present in the resource. One example of unsupported properties would be a required write-only property that is an array, because a parameter cannot be an array. Another example is an optional write-only property.
MUTUALLY_EXCLUSIVE_TYPES - One or more required write-only properties are found in the resource, and the type of that property can be any of several types.
Currently the resource and property reference documentation does not indicate if a property uses a type of oneOf or anyOf. You need to look at the resource provider schema.
The properties of the resource that are impacted by this warning.
" + } + }, + "documentation":"The warnings generated for a specific resource for this generated template.
" + }, + "WarningDetails":{ + "type":"list", + "member":{"shape":"WarningDetail"} + }, + "WarningProperties":{ + "type":"list", + "member":{"shape":"WarningProperty"} + }, + "WarningProperty":{ + "type":"structure", + "members":{ + "PropertyPath":{ + "shape":"PropertyPath", + "documentation":"The path of the property. For example, if this is for the S3Bucket member of the Code property, the property path would be Code/S3Bucket.
If true, the specified property is required.
The description of the property from the resource provider schema.
" + } + }, + "documentation":"A specific property that is impacted by a warning.
" + }, + "WarningType":{ + "type":"string", + "enum":[ + "MUTUALLY_EXCLUSIVE_PROPERTIES", + "UNSUPPORTED_PROPERTIES", + "MUTUALLY_EXCLUSIVE_TYPES" + ] + }, "Warnings":{ "type":"structure", "members":{ diff --git a/botocore/data/elbv2/2015-12-01/service-2.json b/botocore/data/elbv2/2015-12-01/service-2.json index 2a9ebfe290..8fe1ed37d5 100644 --- a/botocore/data/elbv2/2015-12-01/service-2.json +++ b/botocore/data/elbv2/2015-12-01/service-2.json @@ -1352,11 +1352,11 @@ }, "Subnets":{ "shape":"Subnets", - "documentation":"The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets.
[Application Load Balancers] You must specify subnets from at least two Availability Zones.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
" + "documentation":"The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets.
[Application Load Balancers] You must specify subnets from at least two Availability Zones.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
" }, "SubnetMappings":{ "shape":"SubnetMappings", - "documentation":"The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.
[Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets.
" + "documentation":"The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.
[Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets.
" }, "SecurityGroups":{ "shape":"SecurityGroups", @@ -3549,7 +3549,7 @@ "members":{ "Values":{ "shape":"ListOfString", - "documentation":"The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.
If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use HttpHeaderConditionConfig.
" + "documentation":"The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.
If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use HttpHeaderConditionConfig.
The total number of values must be less than, or equal to five.
" } }, "documentation":"Information about a source IP condition.
You can use this condition to route based on the IP address of the source that connects to the load balancer. If a client is behind a proxy, this is the IP address of the proxy not the IP address of the client.
" @@ -3813,7 +3813,7 @@ "members":{ "Key":{ "shape":"TargetGroupAttributeKey", - "documentation":"The name of the attribute.
The following attributes are supported by all load balancers:
deregistration_delay.timeout_seconds - The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported.
stickiness.enabled - Indicates whether target stickiness is enabled. The value is true or false. The default is false.
stickiness.type - Indicates the type of stickiness. The possible values are:
lb_cookie and app_cookie for Application Load Balancers.
source_ip for Network Load Balancers.
source_ip_dest_ip and source_ip_dest_ip_proto for Gateway Load Balancers.
The following attributes are supported by Application Load Balancers and Network Load Balancers:
load_balancing.cross_zone.enabled - Indicates whether cross zone load balancing is enabled. The value is true, false or use_load_balancer_configuration. The default is use_load_balancer_configuration.
target_group_health.dns_failover.minimum_healthy_targets.count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are off or an integer from 1 to the maximum number of targets. The default is off.
target_group_health.dns_failover.minimum_healthy_targets.percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are off or an integer from 1 to 100. The default is off.
target_group_health.unhealthy_state_routing.minimum_healthy_targets.count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are 1 to the maximum number of targets. The default is 1.
target_group_health.unhealthy_state_routing.minimum_healthy_targets.percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are off or an integer from 1 to 100. The default is off.
The following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address:
load_balancing.algorithm.type - The load balancing algorithm determines how the load balancer selects targets when routing requests. The value is round_robin, least_outstanding_requests, or weighted_random. The default is round_robin.
load_balancing.algorithm.anomaly_mitigation - Only available when load_balancing.algorithm.type is weighted_random. Indicates whether anomaly mitigation is enabled. The value is on or off. The default is off.
slow_start.duration_seconds - The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). The default is 0 seconds (disabled).
stickiness.app_cookie.cookie_name - Indicates the name of the application-based cookie. Names that start with the following prefixes are not allowed: AWSALB, AWSALBAPP, and AWSALBTG; they're reserved for use by the load balancer.
stickiness.app_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the application-based cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).
stickiness.lb_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).
The following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function:
lambda.multi_value_headers.enabled - Indicates whether the request and response headers that are exchanged between the load balancer and the Lambda function include arrays of values or strings. The value is true or false. The default is false. If the value is false and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client.
The following attributes are supported only by Network Load Balancers:
deregistration_delay.connection_termination.enabled - Indicates whether the load balancer terminates connections at the end of the deregistration timeout. The value is true or false. For new UDP/TCP_UDP target groups the default is true. Otherwise, the default is false.
preserve_client_ip.enabled - Indicates whether client IP preservation is enabled. The value is true or false. The default is disabled if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, the default is enabled. Client IP preservation cannot be disabled for UDP and TCP_UDP target groups.
proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false.
target_health_state.unhealthy.connection_termination.enabled - Indicates whether the load balancer terminates connections to unhealthy targets. The value is true or false. The default is true.
The following attributes are supported only by Gateway Load Balancers:
target_failover.on_deregistration - Indicates how the Gateway Load Balancer handles existing flows when a target is deregistered. The possible values are rebalance and no_rebalance. The default is no_rebalance. The two attributes (target_failover.on_deregistration and target_failover.on_unhealthy) can't be set independently. The value you set for both attributes must be the same.
target_failover.on_unhealthy - Indicates how the Gateway Load Balancer handles existing flows when a target is unhealthy. The possible values are rebalance and no_rebalance. The default is no_rebalance. The two attributes (target_failover.on_deregistration and target_failover.on_unhealthy) cannot be set independently. The value you set for both attributes must be the same.
The name of the attribute.
The following attributes are supported by all load balancers:
deregistration_delay.timeout_seconds - The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported.
stickiness.enabled - Indicates whether target stickiness is enabled. The value is true or false. The default is false.
stickiness.type - Indicates the type of stickiness. The possible values are:
lb_cookie and app_cookie for Application Load Balancers.
source_ip for Network Load Balancers.
source_ip_dest_ip and source_ip_dest_ip_proto for Gateway Load Balancers.
The following attributes are supported by Application Load Balancers and Network Load Balancers:
load_balancing.cross_zone.enabled - Indicates whether cross zone load balancing is enabled. The value is true, false or use_load_balancer_configuration. The default is use_load_balancer_configuration.
target_group_health.dns_failover.minimum_healthy_targets.count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are off or an integer from 1 to the maximum number of targets. The default is off.
target_group_health.dns_failover.minimum_healthy_targets.percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are off or an integer from 1 to 100. The default is off.
target_group_health.unhealthy_state_routing.minimum_healthy_targets.count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are 1 to the maximum number of targets. The default is 1.
target_group_health.unhealthy_state_routing.minimum_healthy_targets.percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are off or an integer from 1 to 100. The default is off.
The following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address:
load_balancing.algorithm.type - The load balancing algorithm determines how the load balancer selects targets when routing requests. The value is round_robin, least_outstanding_requests, or weighted_random. The default is round_robin.
load_balancing.algorithm.anomaly_mitigation - Only available when load_balancing.algorithm.type is weighted_random. Indicates whether anomaly mitigation is enabled. The value is on or off. The default is off.
slow_start.duration_seconds - The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). The default is 0 seconds (disabled).
stickiness.app_cookie.cookie_name - Indicates the name of the application-based cookie. Names that start with the following prefixes are not allowed: AWSALB, AWSALBAPP, and AWSALBTG; they're reserved for use by the load balancer.
stickiness.app_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the application-based cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).
stickiness.lb_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).
The following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function:
lambda.multi_value_headers.enabled - Indicates whether the request and response headers that are exchanged between the load balancer and the Lambda function include arrays of values or strings. The value is true or false. The default is false. If the value is false and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client.
The following attributes are supported only by Network Load Balancers:
deregistration_delay.connection_termination.enabled - Indicates whether the load balancer terminates connections at the end of the deregistration timeout. The value is true or false. For new UDP/TCP_UDP target groups the default is true. Otherwise, the default is false.
preserve_client_ip.enabled - Indicates whether client IP preservation is enabled. The value is true or false. The default is disabled if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, the default is enabled. Client IP preservation cannot be disabled for UDP and TCP_UDP target groups.
proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false.
target_health_state.unhealthy.connection_termination.enabled - Indicates whether the load balancer terminates connections to unhealthy targets. The value is true or false. The default is true.
target_health_state.unhealthy.draining_interval_seconds - The amount of time for Elastic Load Balancing to wait before changing the state of an unhealthy target from unhealthy.draining to unhealthy. The range is 0-360000 seconds. The default value is 0 seconds.
Note: This attribute can only be configured when target_health_state.unhealthy.connection_termination.enabled is false.
The following attributes are supported only by Gateway Load Balancers:
target_failover.on_deregistration - Indicates how the Gateway Load Balancer handles existing flows when a target is deregistered. The possible values are rebalance and no_rebalance. The default is no_rebalance. The two attributes (target_failover.on_deregistration and target_failover.on_unhealthy) can't be set independently. The value you set for both attributes must be the same.
target_failover.on_unhealthy - Indicates how the Gateway Load Balancer handles existing flows when a target is unhealthy. The possible values are rebalance and no_rebalance. The default is no_rebalance. The two attributes (target_failover.on_deregistration and target_failover.on_unhealthy) cannot be set independently. The value you set for both attributes must be the same.
A continuation token, if this is a continuation call.
" }, "MaxResults":{ - "shape":"PageSize", + "shape":"OrchestrationPageSize200", "documentation":"The maximum size of the response.
" } } @@ -12840,7 +12840,7 @@ "documentation":"The name of the job to retrieve triggers for. The trigger that can start this job is returned, and if there is no such trigger, all triggers are returned.
" }, "MaxResults":{ - "shape":"PageSize", + "shape":"OrchestrationPageSize200", "documentation":"The maximum size of the response.
" } } @@ -14114,7 +14114,7 @@ }, "Runtime":{ "shape":"RuntimeNameString", - "documentation":"In Ray jobs, Runtime is used to specify the versions of Ray, Python and additional libraries available in your environment. This field is not used in other job types. For supported runtime environment values, see Working with Ray jobs in the Glue Developer Guide.
" + "documentation":"In Ray jobs, Runtime is used to specify the versions of Ray, Python and additional libraries available in your environment. This field is not used in other job types. For supported runtime environment values, see Supported Ray runtime environments in the Glue Developer Guide.
" } }, "documentation":"Specifies code that runs when a job is run.
" @@ -14776,7 +14776,7 @@ "documentation":"A continuation token, if this is a continuation request.
" }, "MaxResults":{ - "shape":"PageSize", + "shape":"OrchestrationPageSize25", "documentation":"The maximum size of a list to return.
" }, "Tags":{ @@ -15372,7 +15372,7 @@ "documentation":"The name of the job for which to retrieve triggers. The trigger that can start this job is returned. If there is no such trigger, all triggers are returned.
" }, "MaxResults":{ - "shape":"PageSize", + "shape":"OrchestrationPageSize200", "documentation":"The maximum size of a list to return.
" }, "Tags":{ @@ -15402,7 +15402,7 @@ "documentation":"A continuation token, if this is a continuation request.
" }, "MaxResults":{ - "shape":"PageSize", + "shape":"OrchestrationPageSize25", "documentation":"The maximum size of a list to return.
" } } @@ -16247,6 +16247,18 @@ "min":1, "pattern":"[\\.\\-_A-Za-z0-9]+" }, + "OrchestrationPageSize200":{ + "type":"integer", + "box":true, + "max":200, + "min":1 + }, + "OrchestrationPageSize25":{ + "type":"integer", + "box":true, + "max":25, + "min":1 + }, "OrchestrationRoleArn":{ "type":"string", "max":2048, diff --git a/botocore/data/ssm/2014-11-06/service-2.json b/botocore/data/ssm/2014-11-06/service-2.json index 44e6dbde86..8faebf1afe 100644 --- a/botocore/data/ssm/2014-11-06/service-2.json +++ b/botocore/data/ssm/2014-11-06/service-2.json @@ -582,7 +582,7 @@ "errors":[ {"shape":"InternalServerError"} ], - "documentation":"Lists all patches eligible to be included in a patch baseline.
" + "documentation":"Lists all patches eligible to be included in a patch baseline.
Currently, DescribeAvailablePatches supports only the Amazon Linux 1, Amazon Linux 2, and Windows Server operating systems.
Number of days to wait after the scheduled day to run an association.
", "box":true }, + "Duration":{ + "shape":"Duration", + "documentation":"The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.
", + "box":true + }, "TargetMaps":{ "shape":"TargetMaps", "documentation":"A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
", @@ -2633,6 +2638,11 @@ "documentation":"Number of days to wait after the scheduled day to run an association.
", "box":true }, + "Duration":{ + "shape":"Duration", + "documentation":"The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.
", + "box":true + }, "TargetMaps":{ "shape":"TargetMaps", "documentation":"A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
", @@ -3066,6 +3076,11 @@ "documentation":"Number of days to wait after the scheduled day to run an association.
", "box":true }, + "Duration":{ + "shape":"Duration", + "documentation":"The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.
", + "box":true + }, "TargetMaps":{ "shape":"TargetMaps", "documentation":"A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
", @@ -4560,6 +4575,11 @@ "documentation":"Number of days to wait after the scheduled day to run an association.
", "box":true }, + "Duration":{ + "shape":"Duration", + "documentation":"The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.
The Duration parameter applies only when both these conditions are true:
The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.
The command specifies the ApplyOnlyAtCronInterval parameter, which means that the association doesn't run immediately after it is created, but only according to the specified schedule.
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
", @@ -4655,6 +4675,11 @@ "documentation":"Number of days to wait after the scheduled day to run an association. For example, if you specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify an offset of 3 to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.
To use offsets, you must specify the ApplyOnlyAtCronInterval parameter. This option tells the system not to run an association immediately after you create it.
The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.
The Duration parameter applies only when both these conditions are true:
The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.
The command specifies the ApplyOnlyAtCronInterval parameter, which means that the association doesn't run immediately after it is created, but only according to the specified schedule.
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
", @@ -5726,7 +5751,7 @@ }, "VersionName":{ "shape":"DocumentVersionName", - "documentation":"An optional field specifying the version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and can't be changed.
" + "documentation":"An optional field specifying 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.
" } } }, @@ -6845,7 +6870,7 @@ }, "VersionName":{ "shape":"DocumentVersionName", - "documentation":"An optional field specifying the version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and can't be changed.
" + "documentation":"An optional field specifying 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.
" }, "PlatformTypes":{ "shape":"PlatformTypeList", @@ -7026,7 +7051,7 @@ }, "VersionName":{ "shape":"DocumentVersionName", - "documentation":"An optional field specifying the version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and can't be changed.
" + "documentation":"An optional field specifying 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.
" } }, "documentation":"An SSM document required by the current document.
" @@ -7178,7 +7203,7 @@ }, "VersionName":{ "shape":"DocumentVersionName", - "documentation":"The version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and can't be changed.
" + "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":{ "shape":"DateTime", @@ -7260,6 +7285,12 @@ "documentation":"You can't specify a managed node ID in more than one association.
", "exception":true }, + "Duration":{ + "type":"integer", + "box":true, + "max":24, + "min":1 + }, "EffectiveInstanceAssociationMaxResults":{ "type":"integer", "max":5, @@ -7524,7 +7555,7 @@ }, "Status":{ "shape":"ConnectionStatus", - "documentation":"The status of the connection to the managed node. For example, 'Connected' or 'Not Connected'.
" + "documentation":"The status of the connection to the managed node.
" } } }, @@ -7602,7 +7633,7 @@ }, "VersionName":{ "shape":"DocumentVersionName", - "documentation":"An optional field specifying the version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document and can't be changed.
" + "documentation":"An optional field specifying 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":{ "shape":"DocumentVersion", @@ -7631,7 +7662,7 @@ }, "VersionName":{ "shape":"DocumentVersionName", - "documentation":"The version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and can't be changed.
" + "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":{ "shape":"DocumentVersion", @@ -12551,7 +12582,7 @@ }, "KeyId":{ "shape":"ParameterKeyId", - "documentation":"The ID of the query key used for this parameter.
" + "documentation":"The alias of the Key Management Service (KMS) key used to encrypt the parameter. Applies to SecureString parameters only
The ID of the query key used for this parameter.
" + "documentation":"The alias of the Key Management Service (KMS) key used to encrypt the parameter. Applies to SecureString parameters only.
The IDs of one or more Common Vulnerabilities and Exposure (CVE) issues that are resolved by the patch.
" + "documentation":"The IDs of one or more Common Vulnerabilities and Exposure (CVE) issues that are resolved by the patch.
Currently, CVE ID values are reported only for patches with a status of Missing or Failed.
Information about the state of a patch on a particular managed node as it relates to the patch baseline used to patch the node.
" @@ -15894,6 +15925,11 @@ "documentation":"Number of days to wait after the scheduled day to run an association. For example, if you specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify an offset of 3 to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.
To use offsets, you must specify the ApplyOnlyAtCronInterval parameter. This option tells the system not to run an association immediately after you create it.
The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.
The Duration parameter applies only when both these conditions are true:
The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.
The command specifies the ApplyOnlyAtCronInterval parameter, which means that the association doesn't run immediately after it is updated, but only according to the specified schedule.
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
", @@ -16019,7 +16055,7 @@ }, "VersionName":{ "shape":"DocumentVersionName", - "documentation":"An optional field specifying the version of the artifact you are updating with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and can't be changed.
" + "documentation":"An optional field specifying the version of the artifact you are updating with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.
" }, "DocumentVersion":{ "shape":"DocumentVersion", diff --git a/docs/source/conf.py b/docs/source/conf.py index 59e1cf99ab..9b84514675 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -59,7 +59,7 @@ # The short X.Y version. version = '1.34.' # The full version, including alpha/beta/rc tags. -release = '1.34.31' +release = '1.34.32' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.