Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository.
The maximum duration between the CreateDeployment call and the StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated Job will fail.
Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a Git repository.
The maximum duration between the CreateDeployment call and the StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated Job will fail.
Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository.
The maximum duration between the CreateDeployment call and the StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated Job will fail.
Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a Git repository.
The maximum duration between the CreateDeployment call and the StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated Job will fail.
The type for the job. If the value is RELEASE, the job was manually released from its source by using the StartJob API. If the value is RETRY, the job was manually retried using the StartJob API. If the value is WEB_HOOK, the job was automatically triggered by webhooks.
The type for the job. If the value is RELEASE, the job was manually released from its source by using the StartJob API. This value is available only for apps that are connected to a repository.
If the value is RETRY, the job was manually retried using the StartJob API. If the value is WEB_HOOK, the job was automatically triggered by webhooks. If the value is MANUAL, the job is for a manually deployed app. Manually deployed apps are not connected to a Git repository.
The source URL for the files to deploy. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip file, or an Amazon S3 bucket and prefix.
" + }, + "sourceUrlType":{ + "shape":"SourceUrlType", + "documentation":"The type of source specified by the sourceURL. If the value is ZIP, the source is a .zip file. If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is ZIP.
Describes the summary for an execution job for an Amplify app.
" @@ -2811,7 +2819,14 @@ "SourceUrl":{ "type":"string", "max":3000, - "pattern":"(?s).*" + "pattern":"^(s3|https|http)://.*" + }, + "SourceUrlType":{ + "type":"string", + "enum":[ + "ZIP", + "BUCKET_PREFIX" + ] }, "StackArn":{ "type":"string", @@ -2850,17 +2865,21 @@ }, "branchName":{ "shape":"BranchName", - "documentation":"The name of the branch to use for the job.
", + "documentation":"The name of the branch to use for the deployment job.
", "location":"uri", "locationName":"branchName" }, "jobId":{ "shape":"JobId", - "documentation":"The job ID for this deployment, generated by the create deployment request.
" + "documentation":"The job ID for this deployment that is generated by the CreateDeployment request.
The source URL for this deployment, used when calling start deployment without create deployment. The source URL can be any HTTP GET URL that is publicly accessible and downloads a single .zip file.
" + "documentation":"The source URL for the deployment that is used when calling StartDeployment without CreateDeployment. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip file, or an Amazon S3 bucket and prefix.
The type of source specified by the sourceURL. If the value is ZIP, the source is a .zip file. If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is ZIP.
The request structure for the start a deployment request.
" diff --git a/botocore/data/cloudformation/2010-05-15/service-2.json b/botocore/data/cloudformation/2010-05-15/service-2.json index 4d2e5dc771..0cdd467667 100644 --- a/botocore/data/cloudformation/2010-05-15/service-2.json +++ b/botocore/data/cloudformation/2010-05-15/service-2.json @@ -9,7 +9,8 @@ "serviceId":"CloudFormation", "signatureVersion":"v4", "uid":"cloudformation-2010-05-15", - "xmlNamespace":"http://cloudformation.amazonaws.com/doc/2010-05-15/" + "xmlNamespace":"http://cloudformation.amazonaws.com/doc/2010-05-15/", + "auth":["aws.auth#sigv4"] }, "operations":{ "ActivateOrganizationsAccess":{ @@ -44,7 +45,7 @@ {"shape":"CFNRegistryException"}, {"shape":"TypeNotFoundException"} ], - "documentation":"Activates a public third-party extension, making it available for use in stack templates. For more information, see Using public extensions in the CloudFormation User Guide.
Once you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
", + "documentation":"Activates a public third-party extension, making it available for use in stack templates. Once you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Using public extensions in the CloudFormation User Guide.
", "idempotent":true }, "BatchDescribeTypeConfigurations":{ @@ -62,7 +63,7 @@ {"shape":"TypeConfigurationNotFoundException"}, {"shape":"CFNRegistryException"} ], - "documentation":"Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.
For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
" + "documentation":"Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.
For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide.
" }, "CancelUpdateStack":{ "name":"CancelUpdateStack", @@ -90,7 +91,7 @@ "errors":[ {"shape":"TokenAlreadyExistsException"} ], - "documentation":"For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.
A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll back all changes after a failed stack update. For example, you might have a stack that's rolling back to an old database instance that was deleted outside of CloudFormation. Because CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.
For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.
A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll back all changes after a failed stack update. For example, you might have a stack that's rolling back to an old database instance that was deleted outside of CloudFormation. Because CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.
Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through the DescribeStacks operation.
" + "documentation":"Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through the DescribeStacks operation.
For more information about creating a stack and monitoring stack progress, see Managing Amazon Web Services resources as a single unit with CloudFormation stacks in the CloudFormation User Guide.
" }, "CreateStackInstances":{ "name":"CreateStackInstances", @@ -260,7 +261,7 @@ "errors":[ {"shape":"TokenAlreadyExistsException"} ], - "documentation":"Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't show up in the DescribeStacks operation if the deletion has been completed successfully.
" + "documentation":"Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't show up in the DescribeStacks operation if the deletion has been completed successfully.
For more information about deleting a stack, see Delete a stack from the CloudFormation console in the CloudFormation User Guide.
" }, "DeleteStackInstances":{ "name":"DeleteStackInstances", @@ -328,7 +329,7 @@ "shape":"DescribeAccountLimitsOutput", "resultWrapper":"DescribeAccountLimitsResult" }, - "documentation":"Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see CloudFormation Quotas in the CloudFormation User Guide.
" + "documentation":"Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see Understand CloudFormation quotas in the CloudFormation User Guide.
" }, "DescribeChangeSet":{ "name":"DescribeChangeSet", @@ -344,7 +345,7 @@ "errors":[ {"shape":"ChangeSetNotFoundException"} ], - "documentation":"Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the CloudFormation User Guide.
" + "documentation":"Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see Update CloudFormation stacks using change sets in the CloudFormation User Guide.
" }, "DescribeChangeSetHooks":{ "name":"DescribeChangeSetHooks", @@ -409,7 +410,7 @@ "errors":[ {"shape":"CFNRegistryException"} ], - "documentation":"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
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 Command Line Interface (CLI) User Guide
Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.
Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information about stack and resource drift, see Detect unmanaged configuration changes to stacks and resources with drift detection.
Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.
Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, see CloudFormation stack creation events in the CloudFormation User Guide.
You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).
Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, see Understand CloudFormation stack creation events in the CloudFormation User Guide.
You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).
Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects configuration drift.
For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that don't currently support drift detection aren't checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.
" + "documentation":"Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects configuration drift.
For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that don't currently support drift detection aren't checked, and so not included. For a list of resources that support drift detection, see Resource type support for imports and drift detection.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.
" }, "DescribeStackResources":{ "name":"DescribeStackResources", @@ -508,7 +509,7 @@ "shape":"DescribeStackResourcesOutput", "resultWrapper":"DescribeStackResourcesResult" }, - "documentation":"Returns Amazon Web Services resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned.
Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead.
For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted.
You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, go to the CloudFormation User Guide.
A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.
Returns Amazon Web Services resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned.
Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead.
For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted.
You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, see the CloudFormation User Guide.
A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. For more information about a stack's event history, see CloudFormation stack creation events in the CloudFormation User Guide.
If the stack doesn't exist, a ValidationError is returned.
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. For more information about a stack's event history, see Understand CloudFormation stack creation events in the CloudFormation User Guide.
If the stack doesn't exist, a ValidationError is returned.
Detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Use DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources.
For a list of stack resources that currently support drift detection, see Resources that Support Drift Detection.
DetectStackDrift can take up to several minutes, depending on the number of resources contained within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.
When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging to that stack. Perform DetectStackDrift directly on the nested stack itself.
Detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.
Use DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources.
For a list of stack resources that currently support drift detection, see Resource type support for imports and drift detection.
DetectStackDrift can take up to several minutes, depending on the number of resources contained within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.
When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging to that stack. Perform DetectStackDrift directly on the nested stack itself.
Returns information about whether a resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.
" + "documentation":"Returns information about whether a resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detect unmanaged configuration changes to stacks and resources with drift detection.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see Resource type support for imports and drift detection.
" }, "DetectStackSetDrift":{ "name":"DetectStackSetDrift", @@ -774,7 +775,7 @@ "shape":"ListExportsOutput", "resultWrapper":"ListExportsResult" }, - "documentation":"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.
" + "documentation":"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 Get exported outputs from a deployed CloudFormation stack.
" }, "ListGeneratedTemplates":{ "name":"ListGeneratedTemplates", @@ -1037,7 +1038,7 @@ {"shape":"CFNRegistryException"}, {"shape":"TypeNotFoundException"} ], - "documentation":"Publishes the specified extension to the CloudFormation registry as a public extension in this Region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.
To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.
", + "documentation":"Publishes the specified extension to the CloudFormation registry as a public extension in this Region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.
To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.
", "idempotent":true }, "RecordHandlerProgress":{ @@ -1072,7 +1073,7 @@ "errors":[ {"shape":"CFNRegistryException"} ], - "documentation":"Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions.
For information about requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.
", + "documentation":"Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions.
For information about requirements for registering as a public extension publisher, see Prerequisite: Registering your account to publish CloudFormation extensions in the CloudFormation Command Line Interface (CLI) User Guide.
", "idempotent":true }, "RegisterType":{ @@ -1089,7 +1090,7 @@ "errors":[ {"shape":"CFNRegistryException"} ], - "documentation":"Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:
Validating the extension schema.
Determining which handlers, if any, have been specified for the extension.
Making the extension available for use in your account.
For more information about how to develop extensions and ready them for registration, see Creating Resource Providers in the CloudFormation CLI User Guide.
You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per Region. Use DeregisterType to deregister specific extension versions if necessary.
Once you have initiated a registration request using RegisterType, you can use DescribeTypeRegistration to monitor the progress of the registration request.
Once you have registered a private extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
", + "documentation":"Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:
Validating the extension schema.
Determining which handlers, if any, have been specified for the extension.
Making the extension available for use in your account.
For more information about how to develop extensions and ready them for registration, see Creating resource types using the CloudFormation CLI in the CloudFormation Command Line Interface (CLI) User Guide.
You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per Region. Use DeregisterType to deregister specific extension versions if necessary.
Once you have initiated a registration request using RegisterType, you can use DescribeTypeRegistration to monitor the progress of the registration request.
Once you have registered a private extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide.
", "idempotent":true }, "RollbackStack":{ @@ -1132,7 +1133,7 @@ {"shape":"CFNRegistryException"}, {"shape":"TypeNotFoundException"} ], - "documentation":"Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.
To view the current configuration data for an extension, refer to the ConfigurationSchema element of DescribeType. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more details on dynamic references, see Using dynamic references to specify template values in the CloudFormation User Guide.
Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.
To view the current configuration data for an extension, refer to the ConfigurationSchema element of DescribeType. For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide.
It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more details on dynamic references, see Specify values stored in other services using dynamic references in the CloudFormation User Guide.
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.
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 before publishing in the CloudFormation Command Line Interface (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 Command Line Interface (CLI) User Guide.
Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack through the DescribeStacks action.
To get a copy of the template for an existing stack, you can use the GetTemplate action.
For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.
" + "documentation":"Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack through the DescribeStacks action.
To get a copy of the template for an existing stack, you can use the GetTemplate action.
For more information about updating a stack and monitoring the progress of the update, see Managing Amazon Web Services resources as a single unit with CloudFormation stacks in the CloudFormation User Guide.
" }, "UpdateStackInstances":{ "name":"UpdateStackInstances", @@ -1302,7 +1303,7 @@ "shape":"UpdateTerminationProtectionOutput", "resultWrapper":"UpdateTerminationProtectionResult" }, - "documentation":"Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.
" + "documentation":"Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protect a CloudFormation stack from being deleted in the CloudFormation User Guide.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.
" }, "ValidateTemplate":{ "name":"ValidateTemplate", @@ -1368,7 +1369,7 @@ "documentation":"The value that's associated with the account limit name.
" } }, - "documentation":"The AccountLimit data type.
CloudFormation has the following limits per account:
Number of concurrent resources
Number of stacks
Number of stack outputs
For more information about these account limits, and other CloudFormation limits, see CloudFormation quotas in the CloudFormation User Guide.
" + "documentation":"The AccountLimit data type.
CloudFormation has the following limits per account:
Number of concurrent resources
Number of stacks
Number of stack outputs
For more information about these account limits, and other CloudFormation limits, see Understand CloudFormation quotas in the CloudFormation User Guide.
" }, "AccountLimitList":{ "type":"list", @@ -1558,7 +1559,7 @@ "members":{ "Message":{ "shape":"ErrorMessage", - "documentation":"An message with details about the error that occurred.
" + "documentation":"A message with details about the error that occurred.
" } }, "documentation":"An error occurred during a CloudFormation registry operation.
", @@ -1899,11 +1900,11 @@ }, "RoleARN":{ "shape":"RoleARN", - "documentation":"The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
" + "documentation":"The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
" }, "ResourcesToSkip":{ "shape":"ResourcesToSkip", - "documentation":"A list of the logical IDs of the resources that CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the UPDATE_FAILED state because a rollback failed. You can't specify resources that are in the UPDATE_FAILED state for other reasons, for example, because an update was canceled. To check why a resource update failed, use the DescribeStackResources action, and view the resource status reason.
Specify this property to skip rolling back resources that CloudFormation can't successfully roll back. We recommend that you troubleshoot resources before skipping them. CloudFormation sets the status of the specified resources to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable.
Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources.
To skip resources that are part of nested stacks, use the following format: NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding embedded stack must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or DELETE_FAILED.
Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy.
A list of the logical IDs of the resources that CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the UPDATE_FAILED state because a rollback failed. You can't specify resources that are in the UPDATE_FAILED state for other reasons, for example, because an update was canceled. To check why a resource update failed, use the DescribeStackResources action, and view the resource status reason.
Specify this property to skip rolling back resources that CloudFormation can't successfully roll back. We recommend that you troubleshoot resources before skipping them. CloudFormation sets the status of the specified resources to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable.
Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources.
To skip resources that are part of nested stacks, use the following format: NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding embedded stack must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or DELETE_FAILED.
Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Continue rolling back from failed nested stack updates.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in CloudFormation templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.
For more information about macros, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new IAM users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in CloudFormation templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.
For more information about macros, see Perform custom processing on CloudFormation templates with template macros.
Only one of the Capabilities and ResourceType parameters can be specified.
The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Controlling access with Identity and Access Management in the CloudFormation User Guide.
Only one of the Capabilities and ResourceType parameters can be specified.
The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Control access with Identity and Access Management in the CloudFormation User Guide.
Only one of the Capabilities and ResourceType parameters can be specified.
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.
" + "documentation":"The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.
" }, "RollbackConfiguration":{ "shape":"RollbackConfiguration", @@ -1963,7 +1964,7 @@ }, "NotificationARNs":{ "shape":"NotificationARNs", - "documentation":"The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.
" + "documentation":"The Amazon Resource Names (ARNs) of Amazon SNS topics that CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.
" }, "Tags":{ "shape":"Tags", @@ -1983,7 +1984,7 @@ }, "ChangeSetType":{ "shape":"ChangeSetType", - "documentation":"The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE. To create a change set for an import operation, specify IMPORT.
If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.
By default, CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.
The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE. To create a change set for an import operation, specify IMPORT.
If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.
By default, CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.
Indicates if the change set imports resources that already exist.
This parameter can only import resources that have custom names in templates. For more information, see name type in the CloudFormation User Guide. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead. For more information, see Bringing existing resources into CloudFormation management in the CloudFormation User Guide.
Indicates if the change set imports resources that already exist.
This parameter can only import resources that have custom names in templates. For more information, see name type in the CloudFormation User Guide. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead. For more information, see Import Amazon Web Services resources into a CloudFormation stack with a resource import in the CloudFormation User Guide.
The input for the CreateChangeSet action.
" @@ -2059,11 +2060,11 @@ }, "TemplateBody":{ "shape":"TemplateBody", - "documentation":"Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template anatomy in the CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
" + "documentation":"The Amazon SNS topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
" }, "Capabilities":{ "shape":"Capabilities", - "documentation":"In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new IAM users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in CloudFormation templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Perform custom processing on CloudFormation templates with template macros.
Only one of the Capabilities and ResourceType parameters can be specified.
The template resource types that you have permissions to work with for this create stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the following syntax to describe template resource types: AWS::* (for all Amazon Web Services resources), Custom::* (for all custom resources), Custom::logical_ID (for a specific custom resource), AWS::service_name::* (for all resources of a particular Amazon Web Services service), and AWS::service_name::resource_logical_ID (for a specific Amazon Web Services resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
Only one of the Capabilities and ResourceType parameters can be specified.
The template resource types that you have permissions to work with for this create stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the following syntax to describe template resource types: AWS::* (for all Amazon Web Services resources), Custom::* (for all custom resources), Custom::logical_ID (for a specific custom resource), AWS::service_name::* (for all resources of a particular Amazon Web Services service), and AWS::service_name::resource_logical_ID (for a specific Amazon Web Services resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Control access with Identity and Access Management.
Only one of the Capabilities and ResourceType parameters can be specified.
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to create the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
" + "documentation":"The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to create the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
" }, "OnFailure":{ "shape":"OnFailure", @@ -2103,7 +2104,7 @@ }, "StackPolicyBody":{ "shape":"StackPolicyBody", - "documentation":"Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
Structure containing the stack policy body. For more information, see Prevent updates to stack resources in the CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide. Termination protection is deactivated on stacks by default.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.
" + "documentation":"Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protect CloudFormation stacks from being deleted in the CloudFormation User Guide. Termination protection is deactivated on stacks by default.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.
" }, "RetainExceptOnCreate":{ "shape":"RetainExceptOnCreate", @@ -2203,11 +2204,11 @@ }, "TemplateBody":{ "shape":"TemplateBody", - "documentation":"The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
" + "documentation":"The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
" }, "TemplateURL":{ "shape":"TemplateURL", - "documentation":"The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
" + "documentation":"The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
" }, "StackId":{ "shape":"StackId", @@ -2219,7 +2220,7 @@ }, "Capabilities":{ "shape":"Capabilities", - "documentation":"In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions don't currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new IAM users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in CloudFormation templates.
CAPABILITY_AUTO_EXPAND
Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions don't currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to delete the stack. CloudFormation uses the role's credentials to make calls on your behalf.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
" + "documentation":"The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to delete the stack. CloudFormation uses the role's credentials to make calls on your behalf.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
" }, "ClientRequestToken":{ "shape":"ClientRequestToken", @@ -2398,7 +2399,7 @@ }, "RetainStacks":{ "shape":"RetainStacks", - "documentation":"Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.
For more information, see Stack set operation options.
" + "documentation":"Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.
For more information, see Stack set operation options.
" }, "OperationId":{ "shape":"ClientRequestToken", @@ -2649,7 +2650,7 @@ }, "NotificationARNs":{ "shape":"NotificationARNs", - "documentation":"The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
" + "documentation":"The ARNs of the Amazon SNS topics that will be associated with the stack if you execute the change set.
" }, "RollbackConfiguration":{ "shape":"RollbackConfiguration", @@ -2820,7 +2821,7 @@ }, "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.
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.
Drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects drift.
For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that do not currently support drift detection aren't checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection.
Drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects drift.
For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that do not currently support drift detection aren't checked, and so not included. For a list of resources that support drift detection, see Resource type support for imports and drift detection.
The contract test status of the registered extension version. To return the extension test status of a specific extension version, you must specify VersionId.
This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.
PASSED: The extension has passed all its contract tests.
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 Command Line Interface User Guide.
FAILED: The extension has failed one or more contract tests.
IN_PROGRESS: Contract tests are currently being performed on the extension.
NOT_TESTED: Contract tests haven't been performed on the extension.
The contract test status of the registered extension version. To return the extension test status of a specific extension version, you must specify VersionId.
This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.
PASSED: The extension has passed all its contract tests.
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 Command Line Interface (CLI) User Guide.
FAILED: The extension has failed one or more contract tests.
IN_PROGRESS: Contract tests are currently being performed on the extension.
NOT_TESTED: Contract tests haven't been performed on the extension.
The schema that defines the extension.
For more information about extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
" + "documentation":"The schema that defines the extension.
For more information about extension schemas, see Resource type schema in the CloudFormation Command Line Interface (CLI) User Guide.
" }, "ProvisioningType":{ "shape":"ProvisioningType", @@ -3247,7 +3248,7 @@ }, "ConfigurationSchema":{ "shape":"ConfigurationSchema", - "documentation":"A JSON string that represent the current configuration data for the extension in this account and Region.
To set the configuration data for an extension, use SetTypeConfiguration. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
" + "documentation":"A JSON string that represent the current configuration data for the extension in this account and Region.
To set the configuration data for an extension, use SetTypeConfiguration. For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide.
" }, "PublisherId":{ "shape":"PublisherId", @@ -3255,7 +3256,7 @@ }, "OriginalTypeName":{ "shape":"TypeName", - "documentation":"For public extensions that have been activated for this account and Region, the type name of the public extension.
If you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the type name of the public extension.
If you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Use aliases to refer to extensions in the CloudFormation User Guide.
Whether CloudFormation automatically updates the extension in this account and Region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. For more information, see Activating public extensions for use in your account in the CloudFormation User Guide.
" + "documentation":"Whether CloudFormation automatically updates the extension in this account and Region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. For more information, see Automatically use new versions of extensions in the CloudFormation User Guide.
" } } }, @@ -3383,7 +3384,7 @@ }, "OperationPreferences":{ "shape":"StackSetOperationPreferences", - "documentation":"The user-specified preferences for how CloudFormation performs a stack set operation.
For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
" + "documentation":"The user-specified preferences for how CloudFormation performs a stack set operation.
For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
" }, "OperationId":{ "shape":"ClientRequestToken", @@ -3434,11 +3435,11 @@ "members":{ "TemplateBody":{ "shape":"TemplateBody", - "documentation":"Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the CloudFormation User Guide.)
Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in the CloudFormation User Guide.)
" + "documentation":"Structure containing the stack policy body. (For more information, see Prevent updates to stack resources in the CloudFormation User Guide.)
" } }, "documentation":"The output for the GetStackPolicy action.
" @@ -3681,7 +3682,7 @@ "members":{ "TemplateBody":{ "shape":"TemplateBody", - "documentation":"Structure containing the template body. (For more information, go to Template Anatomy in the CloudFormation User Guide.)
CloudFormation returns the same template that was used when the stack was created.
" + "documentation":"Structure containing the template body.
CloudFormation returns the same template that was used when the stack was created.
" }, "StagesAvailable":{ "shape":"StageList", @@ -3695,11 +3696,11 @@ "members":{ "TemplateBody":{ "shape":"TemplateBody", - "documentation":"Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template anatomy in the CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see Template anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://.
Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.
The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
" + "documentation":"The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.
For more information, see Acknowledging IAM resources in CloudFormation templates.
" }, "CapabilitiesReason":{ "shape":"CapabilitiesReason", @@ -3883,7 +3884,7 @@ }, "OperationPreferences":{ "shape":"StackSetOperationPreferences", - "documentation":"The user-specified preferences for how CloudFormation performs a stack set operation.
For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
" + "documentation":"The user-specified preferences for how CloudFormation performs a stack set operation.
For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
" }, "OperationId":{ "shape":"ClientRequestToken", @@ -4731,10 +4732,10 @@ }, "LogicalIdHierarchy":{ "shape":"LogicalIdHierarchy", - "documentation":"A concatenated list of the logical IDs of the module or modules containing the resource. Modules are listed starting with the inner-most nested module, and separated by /.
In the following example, the resource was created from a module, moduleA, that's nested inside a parent module, moduleB.
moduleA/moduleB
For more information, see Referencing resources in a module in the CloudFormation User Guide.
" + "documentation":"A concatenated list of the logical IDs of the module or modules containing the resource. Modules are listed starting with the inner-most nested module, and separated by /.
In the following example, the resource was created from a module, moduleA, that's nested inside a parent module, moduleB.
moduleA/moduleB
For more information, see Reference module resources in CloudFormation templates in the CloudFormation User Guide.
" } }, - "documentation":"Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
For more information about modules, see Using modules to encapsulate and reuse resource configurations in the CloudFormation User Guide.
" + "documentation":"Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
For more information about modules, see Create reusable resource configurations that can be included across templates with CloudFormation modules in the CloudFormation User Guide.
" }, "MonitoringTimeInMinutes":{ "type":"integer", @@ -4936,7 +4937,7 @@ }, "ResolvedValue":{ "shape":"ParameterValue", - "documentation":"Read-only. The value that corresponds to a SSM parameter key. This field is returned only for SSM parameter types in the template.
" + "documentation":"Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for Systems Manager parameter types in the template. For more information, see Use CloudFormation-supplied parameter types in the CloudFormation User Guide.
" } }, "documentation":"The Parameter data type.
" @@ -5068,7 +5069,7 @@ "documentation":"The type of property difference.
ADD: A value has been added to a resource property that's an array or list data type.
REMOVE: The property has been removed from the current resource configuration.
NOT_EQUAL: The current property value differs from its expected value (as defined in the stack template and any values specified as template parameters).
Information about a resource property whose actual value differs from its expected value, as defined in the stack template and any values specified as template parameters. These will be present only for resources whose StackResourceDriftStatus is MODIFIED. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Information about a resource property whose actual value differs from its expected value, as defined in the stack template and any values specified as template parameters. These will be present only for resources whose StackResourceDriftStatus is MODIFIED. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.
If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.
For more information, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.
" + "documentation":"If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.
For more information, see Prerequisite: Registering your account to publish CloudFormation extensions in the CloudFormation Command Line Interface (CLI) User Guide.
" } } }, @@ -5238,11 +5239,11 @@ }, "TypeName":{ "shape":"TypeName", - "documentation":"The name of the extension being registered.
We suggest that extension names adhere to the following patterns:
For resource types, company_or_organization::service::type.
For modules, company_or_organization::service::type::MODULE.
For hooks, MyCompany::Testing::MyTestHook.
The following organization namespaces are reserved and can't be used in your extension names:
Alexa
AMZN
Amazon
AWS
Custom
Dev
The name of the extension being registered.
We suggest that extension names adhere to the following patterns:
For resource types, company_or_organization::service::type.
For modules, company_or_organization::service::type::MODULE.
For hooks, MyCompany::Testing::MyTestHook.
The following organization namespaces are reserved and can't be used in your extension names:
Alexa
AMZN
Amazon
AWS
Custom
Dev
A URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register.
For information about generating a schema handler package for the extension you want to register, see submit in the CloudFormation CLI User Guide.
The user registering the extension must be able to access the package in the S3 bucket. That's, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.
A URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register.
For information about generating a schema handler package for the extension you want to register, see submit in the CloudFormation Command Line Interface (CLI) User Guide.
The user registering the extension must be able to access the package in the S3 bucket. That's, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.
The type name of the public extension.
If you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.
The type name of the public extension.
If you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Use aliases to refer to extensions in the CloudFormation User Guide.
A list of the major versions of the extension type that the macro supports.
" } }, - "documentation":"For extensions that are modules, a public third-party extension that must be activated in your account in order for the module itself to be activated.
For more information, see Activating public modules for use in your account in the CloudFormation User Guide.
" + "documentation":"For extensions that are modules, a public third-party extension that must be activated in your account in order for the module itself to be activated.
For more information, see Requirements for activating third-party public modules in the CloudFormation User Guide.
" }, "RequiredActivatedTypes":{ "type":"list", @@ -5383,7 +5384,7 @@ }, "Replacement":{ "shape":"Replacement", - "documentation":"For the Modify action, indicates whether CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditionally.
If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditionally, and then Never.
For the Modify action, indicates whether CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditional.
If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditional, and then Never.
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 type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see Resource type support for imports and drift detection 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.
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 (CLI) User Guide.
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 type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see Resource type support for imports and drift detection In the CloudFormation User Guide
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.
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 (CLI) User Guide.
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.
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.
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.
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.
If the Attribute value is Properties, indicates whether a change to this property causes the resource to be recreated. The value can be Never, Always, or Conditionally. To determine the conditions for a Conditionally recreation, see the update behavior for that property in the CloudFormation User Guide.
If the Attribute value is Properties, indicates whether a change to this property causes the resource to be recreated. The value can be Never, Always, or Conditionally. To determine the conditions for a Conditionally recreation, see the update behavior for that property in the Amazon Web Services resource and property types reference in the CloudFormation User Guide.
The type of resource to import into your stack, such as AWS::S3::Bucket. For a list of supported resource types, see Resources that support import operations in the CloudFormation User Guide.
The type of resource to import into your stack, such as AWS::S3::Bucket. For a list of supported resource types, see Resource type support for imports and drift detection in the CloudFormation User Guide.
The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.
The default is 0 minutes.
If you specify a monitoring period but don't specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.
If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.
" } }, - "documentation":"Structure containing the rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
Rollback triggers enable you to have CloudFormation monitor the state of your application during stack creation and updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've specified. For more information, see Monitor and Roll Back Stack Operations.
" + "documentation":"Structure containing the rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
Rollback triggers enable you to have CloudFormation monitor the state of your application during stack creation and updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've specified. For more information, see Roll back your CloudFormation stack on alarm breach with rollback triggers.
" }, "RollbackStackInput":{ "type":"structure", @@ -5819,7 +5820,7 @@ }, "RoleARN":{ "shape":"RoleARN", - "documentation":"The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation assumes to rollback the stack.
" + "documentation":"The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to rollback the stack.
" }, "ClientRequestToken":{ "shape":"ClientRequestToken", @@ -5853,7 +5854,7 @@ }, "Type":{ "shape":"Type", - "documentation":"The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
" + "documentation":"The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
" } }, "documentation":"A rollback trigger CloudFormation monitors during creation and updating of stacks. If any of the alarms you specify goes to ALARM state during the stack operation or within the specified monitoring period afterwards, CloudFormation rolls back the entire stack operation.
" @@ -5879,11 +5880,11 @@ "members":{ "ResourceType":{ "shape":"ResourceType", - "documentation":"The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see Resource type support In the CloudFormation User Guide
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see Resource type support for imports and drift detection 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.
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 (CLI) User Guide.
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 type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see Resource type support for imports and drift detection 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.
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 (CLI) User Guide.
Identifies a scanned resource. This is used with the ListResourceScanRelatedResources API action.
Structure containing the stack policy body. For more information, go to Prevent updates to stack resources in the CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
Structure containing the stack policy body. For more information, see Prevent updates to stack resources in the CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
The configuration data for the extension, in this account and Region.
The configuration data must be formatted as JSON, and validate against the schema returned in the ConfigurationSchema response element of DescribeType. For more information, see Defining account-level configuration data for an extension in the CloudFormation CLI User Guide.
The configuration data for the extension, in this account and Region.
The configuration data must be formatted as JSON, and validate against the schema returned in the ConfigurationSchema response element of DescribeType. For more information, see Defining the account-level configuration of an extension in the CloudFormation Command Line Interface (CLI) User Guide.
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.
" + "documentation":"The Amazon Resource Name (ARN) of an IAM role that's associated with the stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.
" }, "Tags":{ "shape":"Tags", @@ -6112,19 +6113,19 @@ }, "EnableTerminationProtection":{ "shape":"EnableTerminationProtection", - "documentation":"Whether termination protection is enabled for the stack.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.
" + "documentation":"Whether termination protection is enabled for the stack.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack. For more information, see Protect a CloudFormation stack from being deleted in the CloudFormation User Guide.
" }, "ParentId":{ "shape":"StackId", - "documentation":"For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.
For more information, see Working with Nested Stacks in the CloudFormation User Guide.
" + "documentation":"For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.
For more information, see Embed stacks within other stacks using nested stacks in the CloudFormation User Guide.
" }, "RootId":{ "shape":"StackId", - "documentation":"For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.
For more information, see Working with Nested Stacks in the CloudFormation User Guide.
" + "documentation":"For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.
For more information, see Embed stacks within other stacks using nested stacks in the CloudFormation User Guide.
" }, "DriftInformation":{ "shape":"StackDriftInformation", - "documentation":"Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + "documentation":"Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.
" }, "RetainExceptOnCreate":{ "shape":"RetainExceptOnCreate", @@ -6136,7 +6137,7 @@ }, "DetailedStatus":{ "shape":"DetailedStatus", - "documentation":"The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The stack sets CONFIGURATION_COMPLETE when all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.
The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The stack sets CONFIGURATION_COMPLETE when all of the resources in the stack have reached that event. For more information, see Understand CloudFormation stack creation events in the CloudFormation User Guide.
The Stack data type.
" @@ -6225,7 +6226,7 @@ }, "ResourceType":{ "shape":"ResourceType", - "documentation":"Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)
" + "documentation":"Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
" }, "Timestamp":{ "shape":"Timestamp", @@ -6269,7 +6270,7 @@ }, "DetailedStatus":{ "shape":"DetailedStatus", - "documentation":"An optional field containing information about the detailed status of the stack event.
CONFIGURATION_COMPLETE - all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.
VALIDATION_FAILED - template validation failed because of invalid properties in the template. The ResourceStatusReason field shows what properties are defined incorrectly.
An optional field containing information about the detailed status of the stack event.
CONFIGURATION_COMPLETE - all of the resources in the stack have reached that event. For more information, see Understand CloudFormation stack creation events in the CloudFormation User Guide.
VALIDATION_FAILED - template validation failed because of invalid properties in the template. The ResourceStatusReason field shows what properties are defined incorrectly.
The StackEvent data type.
" @@ -6341,7 +6342,7 @@ "documentation":"The last unique ID of a StackSet operation performed on a stack instance.
" } }, - "documentation":"An CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, in addition to the ID of the actual stack and the stack status.
" + "documentation":"A CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, in addition to the ID of the actual stack and the stack status.
" }, "StackInstanceComprehensiveStatus":{ "type":"structure", @@ -6443,7 +6444,7 @@ }, "ResourceType":{ "shape":"ResourceType", - "documentation":"Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.
" + "documentation":"Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
" }, "PropertyDifferences":{ "shape":"PropertyDifferences", @@ -6587,7 +6588,7 @@ }, "ResourceType":{ "shape":"ResourceType", - "documentation":"Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.
" + "documentation":"Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
" }, "Timestamp":{ "shape":"Timestamp", @@ -6607,7 +6608,7 @@ }, "DriftInformation":{ "shape":"StackResourceDriftInformation", - "documentation":"Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + "documentation":"Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.
" }, "ModuleInfo":{ "shape":"ModuleInfo", @@ -6643,7 +6644,7 @@ }, "ResourceType":{ "shape":"ResourceType", - "documentation":"Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.
" + "documentation":"Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
" }, "LastUpdatedTimestamp":{ "shape":"Timestamp", @@ -6663,11 +6664,11 @@ }, "Metadata":{ "shape":"Metadata", - "documentation":"The content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute in the CloudFormation User Guide.
The content of the Metadata attribute declared for the resource. For more information, see Metadata attribute in the CloudFormation User Guide.
Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + "documentation":"Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.
" }, "ModuleInfo":{ "shape":"ModuleInfo", @@ -6731,7 +6732,7 @@ "documentation":"Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
" } }, - "documentation":"Contains the drift information for a resource that has been checked for drift. This includes actual and expected property values for resources in which CloudFormation has detected drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
" + "documentation":"Contains the drift information for a resource that has been checked for drift. This includes actual and expected property values for resources in which CloudFormation has detected drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.
Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see Resource type support for imports and drift detection.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
" }, "StackResourceDriftInformation":{ "type":"structure", @@ -6739,7 +6740,7 @@ "members":{ "StackResourceDriftStatus":{ "shape":"StackResourceDriftStatus", - "documentation":"Status of the resource's actual configuration compared to its expected configuration
DELETED: The resource differs from its expected configuration in that it has been deleted.
MODIFIED: The resource differs from its expected configuration.
NOT_CHECKED: CloudFormation has not checked if the resource differs from its expected configuration.
Any resources that do not currently support drift detection have a status of NOT_CHECKED. For more information, see Resources that Support Drift Detection.
IN_SYNC: The resource's actual configuration matches its expected configuration.
Status of the resource's actual configuration compared to its expected configuration
DELETED: The resource differs from its expected configuration in that it has been deleted.
MODIFIED: The resource differs from its expected configuration.
NOT_CHECKED: CloudFormation has not checked if the resource differs from its expected configuration.
Any resources that do not currently support drift detection have a status of NOT_CHECKED. For more information, see Resource type support for imports and drift detection.
IN_SYNC: The resource's actual configuration matches its expected configuration.
Status of the resource's actual configuration compared to its expected configuration.
DELETED: The resource differs from its expected configuration in that it has been deleted.
MODIFIED: The resource differs from its expected configuration.
NOT_CHECKED: CloudFormation hasn't checked if the resource differs from its expected configuration.
Any resources that don't currently support drift detection have a status of NOT_CHECKED. For more information, see Resources that Support Drift Detection. If you performed an ContinueUpdateRollback operation on a stack, any resources included in ResourcesToSkip will also have a status of NOT_CHECKED. For more information about skipping resources during rollback operations, see Continue Rolling Back an Update in the CloudFormation User Guide.
IN_SYNC: The resource's actual configuration matches its expected configuration.
Status of the resource's actual configuration compared to its expected configuration.
DELETED: The resource differs from its expected configuration in that it has been deleted.
MODIFIED: The resource differs from its expected configuration.
NOT_CHECKED: CloudFormation hasn't checked if the resource differs from its expected configuration.
Any resources that don't currently support drift detection have a status of NOT_CHECKED. For more information, see Resource type support for imports and drift detection. If you performed an ContinueUpdateRollback operation on a stack, any resources included in ResourcesToSkip will also have a status of NOT_CHECKED. For more information about skipping resources during rollback operations, see Continue rolling back an update in the CloudFormation User Guide.
IN_SYNC: The resource's actual configuration matches its expected configuration.
Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)
" + "documentation":"Type of resource. (For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.)
" }, "LastUpdatedTimestamp":{ "shape":"Timestamp", @@ -6821,7 +6822,7 @@ }, "DriftInformation":{ "shape":"StackResourceDriftInformationSummary", - "documentation":"Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + "documentation":"Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.
" }, "ModuleInfo":{ "shape":"ModuleInfo", @@ -6863,7 +6864,7 @@ }, "Capabilities":{ "shape":"Capabilities", - "documentation":"The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in CloudFormation Templates.
" + "documentation":"The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM resources in CloudFormation templates.
" }, "Tags":{ "shape":"Tags", @@ -7030,7 +7031,7 @@ }, "Status":{ "shape":"StackSetOperationStatus", - "documentation":"The status of the operation.
FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.
RUNNING: The operation is currently being performed.
STOPPED: The user has canceled the operation.
STOPPING: The operation is in the process of stopping, at user request.
SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
The status of the operation.
FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.
RUNNING: The operation is currently being performed.
STOPPED: The user has canceled the operation.
STOPPING: The operation is in the process of stopping, at user request.
SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
Detailed information about the drift status of the stack set. This includes information about drift operations currently being performed on the stack set.
This information will only be present for stack set operations whose Action type is DETECT_DRIFT.
For more information, see Detecting Unmanaged Changes in Stack Sets in the CloudFormation User Guide.
" + "documentation":"Detailed information about the drift status of the stack set. This includes information about drift operations currently being performed on the stack set.
This information will only be present for stack set operations whose Action type is DETECT_DRIFT.
For more information, see Detect stack set drift in the CloudFormation User Guide.
" }, "StatusReason":{ "shape":"StackSetOperationStatusReason", @@ -7116,7 +7117,7 @@ "documentation":"Specifies how the concurrency level behaves during the operation execution.
STRICT_FAILURE_TOLERANCE: This option dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the value of FailureToleranceCount +1. The initial actual concurrency is set to the lower of either the value of the MaxConcurrentCount, or the value of FailureToleranceCount +1. The actual concurrency is then reduced proportionally by the number of failures. This is the default behavior.
If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.
SOFT_FAILURE_TOLERANCE: This option decouples FailureToleranceCount from the actual concurrency. This allows stack set operations to run at the concurrency level set by the MaxConcurrentCount value, or MaxConcurrentPercentage, regardless of the number of failures.
The user-specified preferences for how CloudFormation performs a stack set operation.
For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
" + "documentation":"The user-specified preferences for how CloudFormation performs a stack set operation.
For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
" }, "StackSetOperationResultStatus":{ "type":"string", @@ -7201,7 +7202,7 @@ }, "Status":{ "shape":"StackSetOperationStatus", - "documentation":"The overall status of the operation.
FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.
RUNNING: The operation is currently being performed.
STOPPED: The user has canceled the operation.
STOPPING: The operation is in the process of stopping, at user request.
SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
The overall status of the operation.
FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.
RUNNING: The operation is currently being performed.
STOPPED: The user has canceled the operation.
STOPPING: The operation is in the process of stopping, at user request.
SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
The user-specified preferences for how CloudFormation performs a stack set operation.
For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
" + "documentation":"The user-specified preferences for how CloudFormation performs a stack set operation.
For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
" } }, "documentation":"The structures that contain summary information about the specified operation.
" @@ -7358,15 +7359,15 @@ }, "ParentId":{ "shape":"StackId", - "documentation":"For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.
For more information, see Working with Nested Stacks in the CloudFormation User Guide.
" + "documentation":"For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.
For more information, see Embed stacks within other stacks using nested stacks in the CloudFormation User Guide.
" }, "RootId":{ "shape":"StackId", - "documentation":"For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.
For more information, see Working with Nested Stacks in the CloudFormation User Guide.
" + "documentation":"For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.
For more information, see Embed stacks within other stacks using nested stacks in the CloudFormation User Guide.
" }, "DriftInformation":{ "shape":"StackDriftInformationSummary", - "documentation":"Summarizes information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + "documentation":"Summarizes information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.
" } }, "documentation":"The StackSummary Data Type
" @@ -7457,7 +7458,7 @@ "members":{ "Key":{ "shape":"TagKey", - "documentation":" Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (Amazon Web Services) have the reserved prefix: aws:.
Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services have the reserved prefix: aws:.
The S3 bucket to which CloudFormation delivers the contract test execution logs.
CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of PASSED or FAILED.
The user calling TestType must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:
GetObject
PutObject
For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Amazon Web Services Identity and Access Management User Guide.
" + "documentation":"The S3 bucket to which CloudFormation delivers the contract test execution logs.
CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of PASSED or FAILED.
The user calling TestType must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:
GetObject
PutObject
For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.
" } } }, @@ -7753,7 +7754,7 @@ "documentation":"Whether this configuration data is the default configuration for the extension.
" } }, - "documentation":"Detailed information concerning the specification of a CloudFormation extension in a given account and Region.
For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
" + "documentation":"Detailed information concerning the specification of a CloudFormation extension in a given account and Region.
For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide.
" }, "TypeConfigurationDetailsList":{ "type":"list", @@ -7887,19 +7888,19 @@ }, "OriginalTypeName":{ "shape":"TypeName", - "documentation":"For public extensions that have been activated for this account and Region, the type name of the public extension.
If you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the type name of the public extension.
If you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Use aliases to refer to extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the version of the public extension to be used for CloudFormation operations in this account and Region.
How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the version of the public extension to be used for CloudFormation operations in this account and Region.
How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Automatically use new versions of extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the latest version of the public extension that is available. For any extensions other than activated third-arty extensions, CloudFormation returns null.
How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the latest version of the public extension that is available. For any extensions other than activated third-party extensions, CloudFormation returns null.
How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Automatically use new versions of extensions in the CloudFormation User Guide.
The service used to verify the publisher identity.
For more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension Development.
" + "documentation":"The service used to verify the publisher identity.
For more information, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.
" }, "PublisherName":{ "shape":"PublisherName", @@ -7970,7 +7971,7 @@ }, "PublicVersionNumber":{ "shape":"PublicVersionNumber", - "documentation":"For public extensions that have been activated for this account and Region, the version of the public extension to be used for CloudFormation operations in this account and Region. For any extensions other than activated third-arty extensions, CloudFormation returns null.
How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the version of the public extension to be used for CloudFormation operations in this account and Region. For any extensions other than activated third-party extensions, CloudFormation returns null.
How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Automatically use new versions of extensions in the CloudFormation User Guide.
Contains summary information about a specific version of a CloudFormation extension.
" @@ -8028,11 +8029,11 @@ }, "TemplateBody":{ "shape":"TemplateBody", - "documentation":"Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the CloudFormation User Guide.)
Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://.
Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Only one of the Capabilities and ResourceType parameters can be specified.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account, for example, by creating new IAM users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in CloudFormation templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Perform custom processing on CloudFormation templates with template macros.
Only one of the Capabilities and ResourceType parameters can be specified.
The template resource types that you have permissions to work with for this update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
Only one of the Capabilities and ResourceType parameters can be specified.
The template resource types that you have permissions to work with for this update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Control access with Identity and Access Management.
Only one of the Capabilities and ResourceType parameters can be specified.
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.
" + "documentation":"The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.
" }, "RollbackConfiguration":{ "shape":"RollbackConfiguration", @@ -8172,11 +8173,11 @@ }, "TemplateBody":{ "shape":"TemplateBody", - "documentation":"The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document.
Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack set and its associated stack instances.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack set and its associated stack instances.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account, for example, by creating new IAM users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in CloudFormation templates.
CAPABILITY_AUTO_EXPAND
Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the CloudFormation User Guide.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
The input for ValidateTemplate action.
" @@ -8306,7 +8307,7 @@ }, "Capabilities":{ "shape":"Capabilities", - "documentation":"The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
" + "documentation":"The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.
For more information, see Acknowledging IAM resources in CloudFormation templates.
" }, "CapabilitiesReason":{ "shape":"CapabilitiesReason", @@ -8340,7 +8341,7 @@ "members":{ "Type":{ "shape":"WarningType", - "documentation":"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 type of this warning. For more information, see Resolve 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.
Contains any warnings returned by the GetTemplateSummary API action.
CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure.
With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.
For more information about CloudFormation, see the CloudFormation product page.
CloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com.
" + "documentation":"CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Amazon EC2 Auto Scaling to build highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure.
With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.
For more information about CloudFormation, see the CloudFormation product page.
CloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com.
" } diff --git a/botocore/data/codebuild/2016-10-06/service-2.json b/botocore/data/codebuild/2016-10-06/service-2.json index c599b860e5..6c4e668698 100644 --- a/botocore/data/codebuild/2016-10-06/service-2.json +++ b/botocore/data/codebuild/2016-10-06/service-2.json @@ -1607,6 +1607,10 @@ "documentation":"The compute fleet overflow behavior.
For overflow behavior QUEUE, your overflow builds need to wait on the existing fleet instance to become available.
For overflow behavior ON_DEMAND, your overflow builds run on CodeBuild on-demand.
If you choose to set your overflow behavior to on-demand while creating a VPC-connected fleet, make sure that you add the required VPC permissions to your project service role. For more information, see Example policy statement to allow CodeBuild access to Amazon Web Services services required to create a VPC network interface.
The proxy configuration of the compute fleet.
" + }, "imageId":{ "shape":"NonEmptyString", "documentation":"The Amazon Machine Image (AMI) of the compute fleet.
" @@ -2232,6 +2236,10 @@ "documentation":"The compute fleet overflow behavior.
For overflow behavior QUEUE, your overflow builds need to wait on the existing fleet instance to become available.
For overflow behavior ON_DEMAND, your overflow builds run on CodeBuild on-demand.
If you choose to set your overflow behavior to on-demand while creating a VPC-connected fleet, make sure that you add the required VPC permissions to your project service role. For more information, see Example policy statement to allow CodeBuild access to Amazon Web Services services required to create a VPC network interface.
The proxy configuration of the compute fleet.
" + }, "imageId":{ "shape":"NonEmptyString", "documentation":"The Amazon Machine Image (AMI) of the compute fleet.
" @@ -2286,6 +2294,61 @@ "ON_DEMAND" ] }, + "FleetProxyRule":{ + "type":"structure", + "required":[ + "type", + "effect", + "entities" + ], + "members":{ + "type":{ + "shape":"FleetProxyRuleType", + "documentation":"The type of proxy rule.
" + }, + "effect":{ + "shape":"FleetProxyRuleEffectType", + "documentation":"The behavior of the proxy rule.
" + }, + "entities":{ + "shape":"FleetProxyRuleEntities", + "documentation":"The destination of the proxy rule.
" + } + }, + "documentation":"Information about the proxy rule for your reserved capacity instances.
" + }, + "FleetProxyRuleBehavior":{ + "type":"string", + "enum":[ + "ALLOW_ALL", + "DENY_ALL" + ] + }, + "FleetProxyRuleEffectType":{ + "type":"string", + "enum":[ + "ALLOW", + "DENY" + ] + }, + "FleetProxyRuleEntities":{ + "type":"list", + "member":{"shape":"String"}, + "max":100, + "min":1 + }, + "FleetProxyRuleType":{ + "type":"string", + "enum":[ + "DOMAIN", + "IP" + ] + }, + "FleetProxyRules":{ + "type":"list", + "member":{"shape":"FleetProxyRule"}, + "max":100 + }, "FleetScalingMetricType":{ "type":"string", "enum":["FLEET_UTILIZATION_RATE"] @@ -3460,6 +3523,20 @@ "type":"list", "member":{"shape":"Project"} }, + "ProxyConfiguration":{ + "type":"structure", + "members":{ + "defaultBehavior":{ + "shape":"FleetProxyRuleBehavior", + "documentation":"The default behavior of outgoing traffic.
" + }, + "orderedProxyRules":{ + "shape":"FleetProxyRules", + "documentation":"An array of FleetProxyRule objects that represent the specified destination domains or IPs to allow or deny network access control to.
Information about the proxy configurations that apply network access control to your reserved capacity instances.
" + }, "PutResourcePolicyInput":{ "type":"structure", "required":[ @@ -4541,6 +4618,10 @@ "documentation":"The compute fleet overflow behavior.
For overflow behavior QUEUE, your overflow builds need to wait on the existing fleet instance to become available.
For overflow behavior ON_DEMAND, your overflow builds run on CodeBuild on-demand.
If you choose to set your overflow behavior to on-demand while creating a VPC-connected fleet, make sure that you add the required VPC permissions to your project service role. For more information, see Example policy statement to allow CodeBuild access to Amazon Web Services services required to create a VPC network interface.
The proxy configuration of the compute fleet.
" + }, "imageId":{ "shape":"NonEmptyString", "documentation":"The Amazon Machine Image (AMI) of the compute fleet.
" @@ -4860,7 +4941,8 @@ "COMMIT_MESSAGE", "WORKFLOW_NAME", "TAG_NAME", - "RELEASE_NAME" + "RELEASE_NAME", + "REPOSITORY_NAME" ] }, "WebhookScopeType":{ diff --git a/botocore/data/endpoints.json b/botocore/data/endpoints.json index d05ebee7cd..5eaa988108 100644 --- a/botocore/data/endpoints.json +++ b/botocore/data/endpoints.json @@ -19844,6 +19844,86 @@ } } }, + "ssm-quicksetup" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "ssm-quicksetup-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "ssm-quicksetup-fips.ca-central-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "ssm-quicksetup-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "ssm-quicksetup-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "ssm-quicksetup-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "ssm-quicksetup-fips.us-west-2.amazonaws.com" + }, + "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "ssm-quicksetup-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "ssm-quicksetup-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "ssm-quicksetup-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "ssm-quicksetup-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, "ssm-sap" : { "endpoints" : { "af-south-1" : { }, diff --git a/botocore/data/ivs/2020-07-14/service-2.json b/botocore/data/ivs/2020-07-14/service-2.json index 4a8cdf49c2..34c28803fb 100644 --- a/botocore/data/ivs/2020-07-14/service-2.json +++ b/botocore/data/ivs/2020-07-14/service-2.json @@ -2,8 +2,8 @@ "version":"2.0", "metadata":{ "apiVersion":"2020-07-14", - "auth":["aws.auth#sigv4"], "endpointPrefix":"ivs", + "jsonVersion":"1.1", "protocol":"rest-json", "protocols":["rest-json"], "serviceAbbreviation":"Amazon IVS", @@ -11,7 +11,8 @@ "serviceId":"ivs", "signatureVersion":"v4", "signingName":"ivs", - "uid":"ivs-2020-07-14" + "uid":"ivs-2020-07-14", + "auth":["aws.auth#sigv4"] }, "operations":{ "BatchGetChannel":{ @@ -613,21 +614,21 @@ "AudioConfiguration":{ "type":"structure", "members":{ + "channels":{ + "shape":"Integer", + "documentation":"Number of audio channels.
" + }, "codec":{ "shape":"String", "documentation":"Codec used for the audio encoding.
" }, - "targetBitrate":{ - "shape":"Integer", - "documentation":"The expected ingest bitrate (bits per second). This is configured in the encoder.
" - }, "sampleRate":{ "shape":"Integer", "documentation":"Number of audio samples recorded per second.
" }, - "channels":{ + "targetBitrate":{ "shape":"Integer", - "documentation":"Number of audio channels.
" + "documentation":"The expected ingest bitrate (bits per second). This is configured in the encoder.
" } }, "documentation":"Object specifying a stream’s audio configuration, as set up by the broadcaster (usually in an encoder). This is part of the IngestConfiguration object and used for monitoring stream health.
" @@ -690,13 +691,13 @@ "BatchGetStreamKeyResponse":{ "type":"structure", "members":{ - "streamKeys":{ - "shape":"StreamKeys", - "documentation":"" - }, "errors":{ "shape":"BatchErrors", "documentation":"" + }, + "streamKeys":{ + "shape":"StreamKeys", + "documentation":"" } } }, @@ -711,10 +712,6 @@ "shape":"ChannelArn", "documentation":"Channel ARN.
" }, - "viewerId":{ - "shape":"ViewerId", - "documentation":"The ID of the viewer session to revoke.
" - }, "code":{ "shape":"errorCode", "documentation":"Error code.
" @@ -722,6 +719,10 @@ "message":{ "shape":"errorMessage", "documentation":"Error message, determined by the application.
" + }, + "viewerId":{ + "shape":"ViewerId", + "documentation":"The ID of the viewer session to revoke.
" } }, "documentation":"Error for a request in the batch for BatchStartViewerSessionRevocation. Each error is related to a specific channel-ARN and viewer-ID pair.
" @@ -785,53 +786,53 @@ "shape":"ChannelArn", "documentation":"Channel ARN.
" }, - "name":{ - "shape":"ChannelName", - "documentation":"Channel name.
" + "authorized":{ + "shape":"IsAuthorized", + "documentation":"Whether the channel is private (enabled for playback authorization). Default: false.
Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
" + }, + "insecureIngest":{ + "shape":"InsecureIngest", + "documentation":"Whether the channel allows insecure RTMP ingest. Default: false.
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: \"\" (empty string, recording is disabled).
" + "name":{ + "shape":"ChannelName", + "documentation":"Channel name.
" }, - "ingestEndpoint":{ - "shape":"IngestEndpoint", - "documentation":"Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
" + "playbackRestrictionPolicyArn":{ + "shape":"ChannelPlaybackRestrictionPolicyArn", + "documentation":"Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: \"\" (empty string, no playback restriction policy is applied).
" }, "playbackUrl":{ "shape":"PlaybackURL", "documentation":"Channel playback URL.
" }, - "authorized":{ - "shape":"IsAuthorized", - "documentation":"Whether the channel is private (enabled for playback authorization). Default: false.
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific constraints beyond what is documented there.
Whether the channel allows insecure RTMP ingest. Default: false.
Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string (\"\").
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: \"\" (empty string, recording is disabled).
" + }, "srt":{ "shape":"Srt", "documentation":"Specifies the endpoint and optional passphrase for streaming with the SRT protocol.
" }, - "playbackRestrictionPolicyArn":{ - "shape":"ChannelPlaybackRestrictionPolicyArn", - "documentation":"Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: \"\" (empty string, no playback restriction policy is applied).
" + "tags":{ + "shape":"Tags", + "documentation":"Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific constraints beyond what is documented there.
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
Object specifying a channel.
" @@ -840,7 +841,7 @@ "type":"string", "max":128, "min":1, - "pattern":"arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+" + "pattern":"^arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$" }, "ChannelArnList":{ "type":"list", @@ -863,7 +864,7 @@ "type":"string", "max":128, "min":0, - "pattern":"[a-zA-Z0-9-_]*" + "pattern":"^[a-zA-Z0-9-_]*$" }, "ChannelNotBroadcasting":{ "type":"structure", @@ -884,13 +885,13 @@ "type":"string", "max":128, "min":0, - "pattern":"^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-restriction-policy/[a-zA-Z0-9-]+$" + "pattern":"^^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-restriction-policy/[a-zA-Z0-9-]+$$" }, "ChannelRecordingConfigurationArn":{ "type":"string", "max":128, "min":0, - "pattern":"^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$" + "pattern":"^^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$$" }, "ChannelSummary":{ "type":"structure", @@ -899,17 +900,29 @@ "shape":"ChannelArn", "documentation":"Channel ARN.
" }, - "name":{ - "shape":"ChannelName", - "documentation":"Channel name.
" + "authorized":{ + "shape":"IsAuthorized", + "documentation":"Whether the channel is private (enabled for playback authorization). Default: false.
Whether the channel allows insecure RTMP ingest. Default: false.
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.
Whether the channel is private (enabled for playback authorization). Default: false.
Channel name.
" + }, + "playbackRestrictionPolicyArn":{ + "shape":"ChannelPlaybackRestrictionPolicyArn", + "documentation":"Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: \"\" (empty string, no playback restriction policy is applied).
" + }, + "preset":{ + "shape":"TranscodePreset", + "documentation":"Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string (\"\").
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific constraints beyond what is documented there.
Whether the channel allows insecure RTMP ingest. Default: false.
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string (\"\").
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: \"\" (empty string, no playback restriction policy is applied).
" } }, "documentation":"Summary information about a channel.
" @@ -969,21 +970,29 @@ "CreateChannelRequest":{ "type":"structure", "members":{ - "name":{ - "shape":"ChannelName", - "documentation":"Channel name.
" + "authorized":{ + "shape":"Boolean", + "documentation":"Whether the channel is private (enabled for playback authorization). Default: false.
Whether the channel allows insecure RTMP and SRT ingest. Default: false.
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
Channel name.
" }, - "authorized":{ - "shape":"Boolean", - "documentation":"Whether the channel is private (enabled for playback authorization). Default: false.
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: \"\" (empty string, no playback restriction policy is applied).
" + }, + "preset":{ + "shape":"TranscodePreset", + "documentation":"Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string (\"\").
Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific constraints beyond what is documented there.
Whether the channel allows insecure RTMP and SRT ingest. Default: false.
Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string (\"\").
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: \"\" (empty string, no playback restriction policy is applied).
" + "type":{ + "shape":"ChannelType", + "documentation":"Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
Recording-configuration name. The value does not need to be unique.
" - }, "destinationConfiguration":{ "shape":"DestinationConfiguration", "documentation":"A complex type that contains a destination configuration for where recorded video will be stored.
" }, - "tags":{ - "shape":"Tags", - "documentation":"Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific constraints beyond what is documented there.
A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.
" + "name":{ + "shape":"RecordingConfigurationName", + "documentation":"Recording-configuration name. The value does not need to be unique.
" }, "recordingReconnectWindowSeconds":{ "shape":"RecordingReconnectWindowSeconds", @@ -1081,6 +1074,14 @@ "renditionConfiguration":{ "shape":"RenditionConfiguration", "documentation":"Object that describes which renditions should be recorded for a stream.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific constraints beyond what is documented there.
A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.
" } } }, @@ -1322,14 +1323,14 @@ "type":"structure", "required":["publicKeyMaterial"], "members":{ - "publicKeyMaterial":{ - "shape":"PlaybackPublicKeyMaterial", - "documentation":"The public portion of a customer-generated key pair.
" - }, "name":{ "shape":"PlaybackKeyPairName", "documentation":"Playback-key-pair name. The value does not need to be unique.
" }, + "publicKeyMaterial":{ + "shape":"PlaybackPublicKeyMaterial", + "documentation":"The public portion of a customer-generated key pair.
" + }, "tags":{ "shape":"Tags", "documentation":"Any tags provided with the request are added to the playback key pair tags. See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific constraints beyond what is documented there.
" @@ -1348,13 +1349,13 @@ "IngestConfiguration":{ "type":"structure", "members":{ - "video":{ - "shape":"VideoConfiguration", - "documentation":"Encoder settings for video.
" - }, "audio":{ "shape":"AudioConfiguration", "documentation":"Encoder settings for audio.
" + }, + "video":{ + "shape":"VideoConfiguration", + "documentation":"Encoder settings for video.
" } }, "documentation":"Object specifying the ingest configuration set up by the broadcaster, usually in an encoder.
" @@ -1383,21 +1384,21 @@ "shape":"ChannelName", "documentation":"Filters the channel list to match the specified name.
" }, - "filterByRecordingConfigurationArn":{ - "shape":"ChannelRecordingConfigurationArn", - "documentation":"Filters the channel list to match the specified recording-configuration ARN.
" - }, "filterByPlaybackRestrictionPolicyArn":{ "shape":"ChannelPlaybackRestrictionPolicyArn", "documentation":"Filters the channel list to match the specified policy.
" }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"The first channel to retrieve. This is used for pagination; see the nextToken response field.
Filters the channel list to match the specified recording-configuration ARN.
" }, "maxResults":{ "shape":"MaxChannelResults", "documentation":"Maximum number of channels to return. Default: 100.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The first channel to retrieve. This is used for pagination; see the nextToken response field.
The first key pair to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of key pairs to return. Default: your service quota or 100, whichever is smaller.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The first key pair to retrieve. This is used for pagination; see the nextToken response field.
The first policy to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of policies to return. Default: 1.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The first policy to retrieve. This is used for pagination; see the nextToken response field.
List of the matching policies.
" - }, "nextToken":{ "shape":"PaginationToken", "documentation":"If there are more channels than maxResults, use nextToken in the request to get the next set.
List of the matching policies.
" } } }, "ListRecordingConfigurationsRequest":{ "type":"structure", "members":{ - "nextToken":{ - "shape":"PaginationToken", - "documentation":"The first recording configuration to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of recording configurations to return. Default: your service quota or 100, whichever is smaller.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The first recording configuration to retrieve. This is used for pagination; see the nextToken response field.
List of the matching recording configurations.
" - }, "nextToken":{ "shape":"PaginationToken", "documentation":"If there are more recording configurations than maxResults, use nextToken in the request to get the next set.
List of the matching recording configurations.
" } } }, @@ -1504,13 +1505,13 @@ "shape":"ChannelArn", "documentation":"Channel ARN used to filter the list.
" }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"The first stream key to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of streamKeys to return. Default: 1.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The first stream key to retrieve. This is used for pagination; see the nextToken response field.
List of stream keys.
" - }, "nextToken":{ "shape":"PaginationToken", "documentation":"If there are more stream keys than maxResults, use nextToken in the request to get the next set.
List of stream keys.
" } } }, @@ -1536,13 +1537,13 @@ "shape":"ChannelArn", "documentation":"Channel ARN used to filter the list.
" }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"The first stream to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of streams to return. Default: 100.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The first stream to retrieve. This is used for pagination; see the nextToken response field.
List of stream sessions.
" - }, "nextToken":{ "shape":"PaginationToken", "documentation":"If there are more streams than maxResults, use nextToken in the request to get the next set.
List of stream sessions.
" } } }, @@ -1567,13 +1568,13 @@ "shape":"StreamFilters", "documentation":"Filters the stream list to match the specified criterion.
" }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"The first stream to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of streams to return. Default: 100.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The first stream to retrieve. This is used for pagination; see the nextToken response field.
List of streams.
" - }, "nextToken":{ "shape":"PaginationToken", "documentation":"If there are more streams than maxResults, use nextToken in the request to get the next set.
List of streams.
" } } }, @@ -1653,7 +1654,7 @@ "type":"string", "max":1024, "min":0, - "pattern":"[a-zA-Z0-9+/=_-]*" + "pattern":"^[a-zA-Z0-9+/=_-]*$" }, "PendingVerification":{ "type":"structure", @@ -1677,14 +1678,14 @@ "shape":"PlaybackKeyPairArn", "documentation":"Key-pair ARN.
" }, - "name":{ - "shape":"PlaybackKeyPairName", - "documentation":"Playback-key-pair name. The value does not need to be unique.
" - }, "fingerprint":{ "shape":"PlaybackKeyPairFingerprint", "documentation":"Key-pair identifier.
" }, + "name":{ + "shape":"PlaybackKeyPairName", + "documentation":"Playback-key-pair name. The value does not need to be unique.
" + }, "tags":{ "shape":"Tags", "documentation":"Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific constraints beyond what is documented there.
Playback-restriction-policy ARN
" - }, "allowedCountries":{ "shape":"PlaybackRestrictionPolicyAllowedCountryList", "documentation":"A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
" @@ -1748,6 +1745,10 @@ "shape":"PlaybackRestrictionPolicyAllowedOriginList", "documentation":"A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
" }, + "arn":{ + "shape":"PlaybackRestrictionPolicyArn", + "documentation":"Playback-restriction-policy ARN
" + }, "enableStrictOriginEnforcement":{ "shape":"PlaybackRestrictionPolicyEnableStrictOriginEnforcement", "documentation":"Whether channel playback is constrained by origin site. Default: false.
Playback-restriction-policy ARN
" - }, "allowedCountries":{ "shape":"PlaybackRestrictionPolicyAllowedCountryList", "documentation":"A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
" @@ -1821,6 +1818,10 @@ "shape":"PlaybackRestrictionPolicyAllowedOriginList", "documentation":"A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
" }, + "arn":{ + "shape":"PlaybackRestrictionPolicyArn", + "documentation":"Playback-restriction-policy ARN
" + }, "enableStrictOriginEnforcement":{ "shape":"PlaybackRestrictionPolicyEnableStrictOriginEnforcement", "documentation":"Whether channel playback is constrained by origin site. Default: false.
Recording-configuration ARN.
" }, + "destinationConfiguration":{ + "shape":"DestinationConfiguration", + "documentation":"A complex type that contains information about where recorded video will be stored.
" + }, "name":{ "shape":"RecordingConfigurationName", "documentation":"Recording-configuration name. The value does not need to be unique.
" }, - "destinationConfiguration":{ - "shape":"DestinationConfiguration", - "documentation":"A complex type that contains information about where recorded video will be stored.
" + "recordingReconnectWindowSeconds":{ + "shape":"RecordingReconnectWindowSeconds", + "documentation":"If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.
" + }, + "renditionConfiguration":{ + "shape":"RenditionConfiguration", + "documentation":"Object that describes which renditions should be recorded for a stream.
" }, "state":{ "shape":"RecordingConfigurationState", @@ -1885,14 +1894,6 @@ "thumbnailConfiguration":{ "shape":"ThumbnailConfiguration", "documentation":"A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.
" - }, - "recordingReconnectWindowSeconds":{ - "shape":"RecordingReconnectWindowSeconds", - "documentation":"If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.
" - }, - "renditionConfiguration":{ - "shape":"RenditionConfiguration", - "documentation":"Object that describes which renditions should be recorded for a stream.
" } }, "documentation":"An object representing a configuration to record a channel stream.
" @@ -1901,7 +1902,7 @@ "type":"string", "max":128, "min":0, - "pattern":"arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+" + "pattern":"^arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$" }, "RecordingConfigurationList":{ "type":"list", @@ -1911,7 +1912,7 @@ "type":"string", "max":128, "min":0, - "pattern":"[a-zA-Z0-9-_]*" + "pattern":"^[a-zA-Z0-9-_]*$" }, "RecordingConfigurationState":{ "type":"string", @@ -1933,14 +1934,14 @@ "shape":"RecordingConfigurationArn", "documentation":"Recording-configuration ARN.
" }, - "name":{ - "shape":"RecordingConfigurationName", - "documentation":"Recording-configuration name. The value does not need to be unique.
" - }, "destinationConfiguration":{ "shape":"DestinationConfiguration", "documentation":"A complex type that contains information about where recorded video will be stored.
" }, + "name":{ + "shape":"RecordingConfigurationName", + "documentation":"Recording-configuration name. The value does not need to be unique.
" + }, "state":{ "shape":"RecordingConfigurationState", "documentation":"Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.
Channel ARN for the stream.
" }, - "streamId":{ - "shape":"StreamId", - "documentation":"Unique identifier for a live or previously live stream in the specified channel.
" + "health":{ + "shape":"StreamHealth", + "documentation":"The stream’s health.
" }, "playbackUrl":{ "shape":"PlaybackURL", @@ -2135,9 +2136,9 @@ "shape":"StreamState", "documentation":"The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a \"NotBroadcasting\" error will indicate that the stream is not live.
The stream’s health.
" + "streamId":{ + "shape":"StreamId", + "documentation":"Unique identifier for a live or previously live stream in the specified channel.
" }, "viewerCount":{ "shape":"StreamViewerCount", @@ -2149,6 +2150,14 @@ "StreamEvent":{ "type":"structure", "members":{ + "code":{ + "shape":"String", + "documentation":"Provides additional details about the stream event. There are several values; note that the long descriptions are provided in the IVS console but not delivered through the IVS API or EventBridge:
StreamTakeoverMediaMismatch — The broadcast client attempted to take over with different media properties (e.g., codec, resolution, or video track type) from the original stream.
StreamTakeoverInvalidPriority — The broadcast client attempted a takeover with either a priority integer value equal to or lower than the original stream's value or a value outside the allowed range of 1 to 2,147,483,647.
StreamTakeoverLimitBreached — The broadcast client reached the maximum allowed takeover attempts for this stream.
Time when the event occurred. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, "name":{ "shape":"String", "documentation":"Name that identifies the stream event within a type.
Logical group for certain events.
" - }, - "eventTime":{ - "shape":"Time", - "documentation":"Time when the event occurred. This is an ISO 8601 timestamp; note that this is returned as a string.
" } }, "documentation":"Object specifying a stream’s events. For a list of events, see Using Amazon EventBridge with Amazon IVS.
" @@ -2192,7 +2197,7 @@ "type":"string", "max":26, "min":26, - "pattern":"st-[a-zA-Z0-9]+" + "pattern":"^st-[a-zA-Z0-9]+$" }, "StreamKey":{ "type":"structure", @@ -2201,10 +2206,6 @@ "shape":"StreamKeyArn", "documentation":"Stream-key ARN.
" }, - "value":{ - "shape":"StreamKeyValue", - "documentation":"Stream-key value.
" - }, "channelArn":{ "shape":"ChannelArn", "documentation":"Channel ARN for the stream.
" @@ -2212,6 +2213,10 @@ "tags":{ "shape":"Tags", "documentation":"Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific constraints beyond what is documented there.
Stream-key value.
" } }, "documentation":"Object specifying a stream key.
" @@ -2220,7 +2225,7 @@ "type":"string", "max":128, "min":1, - "pattern":"arn:aws:ivs:[a-z0-9-]+:[0-9]+:stream-key/[a-zA-Z0-9-]+" + "pattern":"^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stream-key/[a-zA-Z0-9-]+$" }, "StreamKeyArnList":{ "type":"list", @@ -2270,22 +2275,14 @@ "StreamSession":{ "type":"structure", "members":{ - "streamId":{ - "shape":"StreamId", - "documentation":"Unique identifier for a live or previously live stream in the specified channel.
" - }, - "startTime":{ - "shape":"Time", - "documentation":"Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
" + "channel":{ + "shape":"Channel", + "documentation":"The properties of the channel at the time of going live.
" }, "endTime":{ "shape":"Time", "documentation":"Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is NULL.
The properties of the channel at the time of going live.
" - }, "ingestConfiguration":{ "shape":"IngestConfiguration", "documentation":"The properties of the incoming RTMP stream for the stream.
" @@ -2294,6 +2291,14 @@ "shape":"RecordingConfiguration", "documentation":"The properties of recording the live stream.
" }, + "startTime":{ + "shape":"Time", + "documentation":"Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "streamId":{ + "shape":"StreamId", + "documentation":"Unique identifier for a live or previously live stream in the specified channel.
" + }, "truncatedEvents":{ "shape":"StreamEvents", "documentation":"List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.
" @@ -2308,14 +2313,6 @@ "StreamSessionSummary":{ "type":"structure", "members":{ - "streamId":{ - "shape":"StreamId", - "documentation":"Unique identifier for a live or previously live stream in the specified channel.
" - }, - "startTime":{ - "shape":"Time", - "documentation":"Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
" - }, "endTime":{ "shape":"Time", "documentation":"Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is NULL.
If true, this stream encountered a quota breach or failure.
Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
" + }, + "streamId":{ + "shape":"StreamId", + "documentation":"Unique identifier for a live or previously live stream in the specified channel.
" } }, "documentation":"Summary information about a stream session.
" @@ -2345,25 +2350,25 @@ "shape":"ChannelArn", "documentation":"Channel ARN for the stream.
" }, - "streamId":{ - "shape":"StreamId", - "documentation":"Unique identifier for a live or previously live stream in the specified channel.
" + "health":{ + "shape":"StreamHealth", + "documentation":"The stream’s health.
" + }, + "startTime":{ + "shape":"StreamStartTime", + "documentation":"Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
" }, "state":{ "shape":"StreamState", "documentation":"The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a \"NotBroadcasting\" error will indicate that the stream is not live.
The stream’s health.
" + "streamId":{ + "shape":"StreamId", + "documentation":"Unique identifier for a live or previously live stream in the specified channel.
" }, "viewerCount":{ "shape":"StreamViewerCount", "documentation":"A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
" } }, "documentation":"Summary information about a stream.
" @@ -2458,10 +2463,6 @@ "shape":"RecordingMode", "documentation":"Thumbnail recording mode. Default: INTERVAL.
The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.
Important: For the BASIC channel type, setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.
Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: Null (source resolution is returned).
" @@ -2469,6 +2470,10 @@ "storage":{ "shape":"ThumbnailConfigurationStorageList", "documentation":"Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.
The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.
Important: For the BASIC channel type, setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.
An object representing a configuration of thumbnails for recorded video.
" @@ -2538,37 +2543,37 @@ "shape":"ChannelArn", "documentation":"ARN of the channel to be updated.
" }, - "name":{ - "shape":"ChannelName", - "documentation":"Channel name.
" - }, - "latencyMode":{ - "shape":"ChannelLatencyMode", - "documentation":"Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers.
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
Whether the channel is private (enabled for playback authorization).
" }, - "recordingConfigurationArn":{ - "shape":"ChannelRecordingConfigurationArn", - "documentation":"Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. If this is set to an empty string, recording is disabled.
" - }, "insecureIngest":{ "shape":"Boolean", "documentation":"Whether the channel allows insecure RTMP and SRT ingest. Default: false.
Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string (\"\").
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers.
Channel name.
" }, "playbackRestrictionPolicyArn":{ "shape":"ChannelPlaybackRestrictionPolicyArn", "documentation":"Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. If this is set to an empty string, playback restriction policy is disabled.
" + }, + "preset":{ + "shape":"TranscodePreset", + "documentation":"Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string (\"\").
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. If this is set to an empty string, recording is disabled.
" + }, + "type":{ + "shape":"ChannelType", + "documentation":"Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
ARN of the playback-restriction-policy to be updated.
" - }, "allowedCountries":{ "shape":"PlaybackRestrictionPolicyAllowedCountryList", "documentation":"A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
" @@ -2597,6 +2598,10 @@ "shape":"PlaybackRestrictionPolicyAllowedOriginList", "documentation":"A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
" }, + "arn":{ + "shape":"PlaybackRestrictionPolicyArn", + "documentation":"ARN of the playback-restriction-policy to be updated.
" + }, "enableStrictOriginEnforcement":{ "shape":"PlaybackRestrictionPolicyEnableStrictOriginEnforcement", "documentation":"Whether channel playback is constrained by origin site. Default: false.
Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.
" - }, "avcLevel":{ "shape":"String", "documentation":"Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification.
" }, + "avcProfile":{ + "shape":"String", + "documentation":"Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.
" + }, "codec":{ "shape":"String", "documentation":"Codec used for the video encoding.
" diff --git a/botocore/data/qbusiness/2023-11-27/service-2.json b/botocore/data/qbusiness/2023-11-27/service-2.json index e2187275cc..ccf66a221d 100644 --- a/botocore/data/qbusiness/2023-11-27/service-2.json +++ b/botocore/data/qbusiness/2023-11-27/service-2.json @@ -1861,7 +1861,7 @@ }, "userGroups":{ "shape":"UserGroups", - "documentation":"The groups that a user associated with the chat input belongs to.
", + "documentation":"The group names that a user associated with the chat input belongs to.
", "location":"querystring", "locationName":"userGroups" }, @@ -1996,7 +1996,7 @@ }, "userGroups":{ "shape":"UserGroups", - "documentation":"The groups that a user associated with the chat input belongs to.
", + "documentation":"The group names that a user associated with the chat input belongs to.
", "location":"querystring", "locationName":"userGroups" }, @@ -2211,7 +2211,7 @@ }, "roleArn":{ "shape":"RoleArn", - "documentation":"The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
" + "documentation":"The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a service linked role (SLR) and use it as the application's role.
" }, "identityType":{ "shape":"IdentityType", @@ -2573,6 +2573,10 @@ "shape":"WebExperienceSamplePromptsControlMode", "documentation":"Determines whether sample prompts are enabled in the web experience for an end user.
" }, + "origins":{ + "shape":"WebExperienceOrigins", + "documentation":"Sets the website domain origins that are allowed to embed the Amazon Q Business web experience.
The <i>domain origin</i> refers to the base URL for accessing a website including the protocol (<code>http/https</code>), the domain name, and the port number (if specified). </p> <note> <p>You must only submit a <i>base URL</i> and not a full path. For example, <code>https://docs.aws.amazon.com</code>.</p> </note> The Amazon Resource Name (ARN) of the service role attached to your web experience.
You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.
Determines whether sample prompts are enabled in the web experience for an end user.
" }, + "origins":{ + "shape":"WebExperienceOrigins", + "documentation":"Gets the website domain origins that are allowed to embed the Amazon Q Business web experience.
The <i>domain origin</i> refers to the base URL for accessing a website including the protocol (<code>http/https</code>), the domain name, and the port number (if specified). </p> The Amazon Resource Name (ARN) of the service role attached to your web experience.
" @@ -5342,6 +5350,12 @@ }, "documentation":"Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
" }, + "Origin":{ + "type":"string", + "max":256, + "min":1, + "pattern":"(http://|https://)[a-zA-Z0-9-_.]+(?::[0-9]{1,5})?" + }, "Payload":{ "type":"string", "sensitive":true @@ -5638,7 +5652,7 @@ "documentation":"Status information about whether end users can create and use Amazon Q Apps in the web experience.
" } }, - "documentation":"Configuration information about Amazon Q Apps. (preview feature)
" + "documentation":"Configuration information about Amazon Q Apps.
" }, "QAppsControlMode":{ "type":"string", @@ -6739,6 +6753,10 @@ "identityProviderConfiguration":{ "shape":"IdentityProviderConfiguration", "documentation":"Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
" + }, + "origins":{ + "shape":"WebExperienceOrigins", + "documentation":"Updates the website domain origins that are allowed to embed the Amazon Q Business web experience.
The <i>domain origin</i> refers to the <i>base URL</i> for accessing a website including the protocol (<code>http/https</code>), the domain name, and the port number (if specified).</p> <note> <ul> <li> <p>Any values except <code>null</code> submitted as part of this update will replace all previous values.</p> </li> <li> <p>You must only submit a <i>base URL</i> and not a full path. For example, <code>https://docs.aws.amazon.com</code>.</p> </li> </ul> </note> The user groups associated with a topic control rule.
" + "documentation":"The user group names associated with a topic control rule.
" } }, - "documentation":"Provides information about users and groups associated with a topic control rule.
" + "documentation":"Provides information about users and group names associated with a topic control rule.
" }, "ValidationException":{ "type":"structure", @@ -6912,6 +6930,12 @@ "min":36, "pattern":"[a-zA-Z0-9][a-zA-Z0-9-]*" }, + "WebExperienceOrigins":{ + "type":"list", + "member":{"shape":"Origin"}, + "max":10, + "min":0 + }, "WebExperienceSamplePromptsControlMode":{ "type":"string", "enum":[ diff --git a/botocore/data/redshift/2012-12-01/paginators-1.json b/botocore/data/redshift/2012-12-01/paginators-1.json index f59049396e..97559e47c8 100644 --- a/botocore/data/redshift/2012-12-01/paginators-1.json +++ b/botocore/data/redshift/2012-12-01/paginators-1.json @@ -215,6 +215,12 @@ "limit_key": "MaxRecords", "output_token": "Marker", "result_key": "Recommendations" + }, + "DescribeIntegrations": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Integrations" } } } diff --git a/botocore/data/redshift/2012-12-01/service-2.json b/botocore/data/redshift/2012-12-01/service-2.json index a6dcb7c39c..f28b14c844 100644 --- a/botocore/data/redshift/2012-12-01/service-2.json +++ b/botocore/data/redshift/2012-12-01/service-2.json @@ -470,6 +470,30 @@ ], "documentation":"Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM.
In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
" }, + "CreateIntegration":{ + "name":"CreateIntegration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateIntegrationMessage"}, + "output":{ + "shape":"Integration", + "resultWrapper":"CreateIntegrationResult" + }, + "errors":[ + {"shape":"IntegrationAlreadyExistsFault"}, + {"shape":"IntegrationConflictOperationFault"}, + {"shape":"IntegrationQuotaExceededFault"}, + {"shape":"IntegrationSourceNotFoundFault"}, + {"shape":"IntegrationTargetNotFoundFault"}, + {"shape":"UnsupportedOperationFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"TagLimitExceededFault"}, + {"shape":"InvalidTagFault"} + ], + "documentation":"Creates a zero-ETL integration with Amazon Redshift.
" + }, "CreateRedshiftIdcApplication":{ "name":"CreateRedshiftIdcApplication", "http":{ @@ -776,6 +800,25 @@ ], "documentation":"Deletes the specified Amazon Redshift HSM configuration.
" }, + "DeleteIntegration":{ + "name":"DeleteIntegration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteIntegrationMessage"}, + "output":{ + "shape":"Integration", + "resultWrapper":"DeleteIntegrationResult" + }, + "errors":[ + {"shape":"IntegrationNotFoundFault"}, + {"shape":"IntegrationConflictStateFault"}, + {"shape":"IntegrationConflictOperationFault"}, + {"shape":"UnsupportedOperationFault"} + ], + "documentation":"Deletes a zero-ETL integration with Amazon Redshift.
" + }, "DeletePartner":{ "name":"DeletePartner", "http":{ @@ -1276,6 +1319,23 @@ ], "documentation":"Returns a list of inbound integrations.
" }, + "DescribeIntegrations":{ + "name":"DescribeIntegrations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeIntegrationsMessage"}, + "output":{ + "shape":"IntegrationsMessage", + "resultWrapper":"DescribeIntegrationsResult" + }, + "errors":[ + {"shape":"IntegrationNotFoundFault"}, + {"shape":"UnsupportedOperationFault"} + ], + "documentation":"Describes one or more zero-ETL integrations with Amazon Redshift.
" + }, "DescribeLoggingStatus":{ "name":"DescribeLoggingStatus", "http":{ @@ -2039,6 +2099,26 @@ ], "documentation":"Modifies an existing Amazon Redshift event notification subscription.
" }, + "ModifyIntegration":{ + "name":"ModifyIntegration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyIntegrationMessage"}, + "output":{ + "shape":"Integration", + "resultWrapper":"ModifyIntegrationResult" + }, + "errors":[ + {"shape":"IntegrationNotFoundFault"}, + {"shape":"IntegrationConflictStateFault"}, + {"shape":"IntegrationConflictOperationFault"}, + {"shape":"IntegrationAlreadyExistsFault"}, + {"shape":"UnsupportedOperationFault"} + ], + "documentation":"Modifies a zero-ETL integration with Amazon Redshift.
" + }, "ModifyRedshiftIdcApplication":{ "name":"ModifyRedshiftIdcApplication", "http":{ @@ -2270,7 +2350,7 @@ {"shape":"DependentServiceUnavailableFault"}, {"shape":"ReservedNodeAlreadyExistsFault"} ], - "documentation":"Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method.
Elastic resize operations have the following restrictions:
You can only resize clusters of the following types:
dc2.large
dc2.8xlarge
ra3.xlplus
ra3.4xlarge
ra3.16xlarge
The type of nodes that you add must match the node type for the cluster.
Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method.
Elastic resize operations have the following restrictions:
You can only resize clusters of the following types:
dc2.large
dc2.8xlarge
ra3.large
ra3.xlplus
ra3.4xlarge
ra3.16xlarge
The type of nodes that you add must match the node type for the cluster.
The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
Valid Values: dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge
The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
Valid Values: dc2.large | dc2.8xlarge | ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge
The Amazon Resource Name (ARN) of the database to use as the source for replication.
" + }, + "TargetArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.
" + }, + "IntegrationName":{ + "shape":"IntegrationName", + "documentation":"The name of the integration.
" + }, + "KMSKeyId":{ + "shape":"String", + "documentation":"An Key Management Service (KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, the default Amazon Web Services owned key is used.
" + }, + "TagList":{ + "shape":"TagList", + "documentation":"A list of tags.
" + }, + "AdditionalEncryptionContext":{ + "shape":"EncryptionContextMap", + "documentation":"An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.
You can only include this parameter if you specify the KMSKeyId parameter.
A description of the integration.
" + } + } + }, "CreateRedshiftIdcApplicationMessage":{ "type":"structure", "required":[ @@ -5174,6 +5292,16 @@ }, "documentation":"" }, + "DeleteIntegrationMessage":{ + "type":"structure", + "required":["IntegrationArn"], + "members":{ + "IntegrationArn":{ + "shape":"IntegrationArn", + "documentation":"The unique identifier of the integration to delete.
" + } + } + }, "DeleteRedshiftIdcApplicationMessage":{ "type":"structure", "required":["RedshiftIdcApplicationArn"], @@ -5898,6 +6026,68 @@ } } }, + "DescribeIntegrationsFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"DescribeIntegrationsFilterName", + "documentation":"Specifies the type of integration filter.
" + }, + "Values":{ + "shape":"DescribeIntegrationsFilterValueList", + "documentation":"Specifies the values to filter on.
" + } + }, + "documentation":"A set of elements to filter the returned integrations.
" + }, + "DescribeIntegrationsFilterList":{ + "type":"list", + "member":{ + "shape":"DescribeIntegrationsFilter", + "locationName":"DescribeIntegrationsFilter" + } + }, + "DescribeIntegrationsFilterName":{ + "type":"string", + "enum":[ + "integration-arn", + "source-arn", + "source-types", + "status" + ] + }, + "DescribeIntegrationsFilterValueList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"Value" + } + }, + "DescribeIntegrationsMessage":{ + "type":"structure", + "members":{ + "IntegrationArn":{ + "shape":"IntegrationArn", + "documentation":"The unique identifier of the integration.
" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
" + }, + "Marker":{ + "shape":"String", + "documentation":"An optional pagination token provided by a previous DescribeIntegrations request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A filter that specifies one or more resources to return.
" + } + } + }, "DescribeLoggingStatusMessage":{ "type":"structure", "required":["ClusterIdentifier"], @@ -6251,7 +6441,7 @@ }, "ResourceType":{ "shape":"String", - "documentation":"The type of resource with which you want to view tags. Valid resource types are:
Cluster
CIDR/IP
EC2 security group
Snapshot
Cluster security group
Subnet group
HSM connection
HSM certificate
Parameter group
Snapshot copy grant
For more information about Amazon Redshift resource types and constructing ARNs, go to Specifying Policy Elements: Actions, Effects, Resources, and Principals in the Amazon Redshift Cluster Management Guide.
" + "documentation":"The type of resource with which you want to view tags. Valid resource types are:
Cluster
CIDR/IP
EC2 security group
Snapshot
Cluster security group
Subnet group
HSM connection
HSM certificate
Parameter group
Snapshot copy grant
Integration (zero-ETL integration)
To describe the tags associated with an integration, don't specify ResourceType, instead specify the ResourceName of the integration.
For more information about Amazon Redshift resource types and constructing ARNs, go to Specifying Policy Elements: Actions, Effects, Resources, and Principals in the Amazon Redshift Cluster Management Guide.
" }, "MaxRecords":{ "shape":"IntegerOptional", @@ -6305,6 +6495,12 @@ } } }, + "Description":{ + "type":"string", + "max":1000, + "min":1, + "pattern":"^.*$" + }, "DisableLoggingMessage":{ "type":"structure", "required":["ClusterIdentifier"], @@ -6470,6 +6666,11 @@ "Cluster":{"shape":"Cluster"} } }, + "EncryptionContextMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, "Endpoint":{ "type":"structure", "members":{ @@ -7403,6 +7604,103 @@ }, "Integer":{"type":"integer"}, "IntegerOptional":{"type":"integer"}, + "Integration":{ + "type":"structure", + "members":{ + "IntegrationArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the integration.
" + }, + "IntegrationName":{ + "shape":"IntegrationName", + "documentation":"The name of the integration.
" + }, + "SourceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the database used as the source for replication.
" + }, + "TargetArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.
" + }, + "Status":{ + "shape":"ZeroETLIntegrationStatus", + "documentation":"The current status of the integration.
" + }, + "Errors":{ + "shape":"IntegrationErrorList", + "documentation":"Any errors associated with the integration.
" + }, + "CreateTime":{ + "shape":"TStamp", + "documentation":"The time (UTC) when the integration was created.
" + }, + "Description":{ + "shape":"Description", + "documentation":"The description of the integration.
" + }, + "KMSKeyId":{ + "shape":"String", + "documentation":"The Key Management Service (KMS) key identifier for the key used to encrypt the integration.
" + }, + "AdditionalEncryptionContext":{ + "shape":"EncryptionContextMap", + "documentation":"The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The list of tags associated with the integration.
" + } + } + }, + "IntegrationAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"The integration you are trying to create already exists.
", + "error":{ + "code":"IntegrationAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "IntegrationArn":{ + "type":"string", + "max":255, + "min":1, + "pattern":"arn:aws[a-z\\-]*:redshift:[a-z0-9\\-]*:[0-9]*:integration:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "IntegrationConflictOperationFault":{ + "type":"structure", + "members":{ + }, + "documentation":"A conflicting conditional operation is currently in progress against this resource. This typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.
", + "error":{ + "code":"IntegrationConflictOperationFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "IntegrationConflictStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"The integration is in an invalid state and can't perform the requested operation.
", + "error":{ + "code":"IntegrationConflictStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "IntegrationDescription":{ + "type":"string", + "max":1000, + "min":0, + "pattern":"^.*$" + }, "IntegrationError":{ "type":"structure", "required":["ErrorCode"], @@ -7425,6 +7723,19 @@ "locationName":"IntegrationError" } }, + "IntegrationList":{ + "type":"list", + "member":{ + "shape":"Integration", + "locationName":"Integration" + } + }, + "IntegrationName":{ + "type":"string", + "max":63, + "min":1, + "pattern":"^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" + }, "IntegrationNotFoundFault":{ "type":"structure", "members":{ @@ -7437,6 +7748,55 @@ }, "exception":true }, + "IntegrationQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"You can't create any more zero-ETL integrations because the quota has been reached.
", + "error":{ + "code":"IntegrationQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "IntegrationSourceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"The specified integration source can't be found.
", + "error":{ + "code":"IntegrationSourceNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "IntegrationTargetNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"The specified integration target can't be found.
", + "error":{ + "code":"IntegrationTargetNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "IntegrationsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
List of integrations that are described.
" + } + } + }, "InvalidAuthenticationProfileRequestFault":{ "type":"structure", "members":{ @@ -8124,7 +8484,7 @@ }, "NodeType":{ "shape":"String", - "documentation":"The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.
For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
Valid Values: dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge
The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.
For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
Valid Values: dc2.large | dc2.8xlarge | ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge
The unique identifier of the integration to modify.
" + }, + "Description":{ + "shape":"IntegrationDescription", + "documentation":"A new description for the integration.
" + }, + "IntegrationName":{ + "shape":"IntegrationName", + "documentation":"A new name for the integration.
" + } + } + }, "ModifyRedshiftIdcApplicationMessage":{ "type":"structure", "required":["RedshiftIdcApplicationArn"], diff --git a/botocore/data/resiliencehub/2020-04-30/service-2.json b/botocore/data/resiliencehub/2020-04-30/service-2.json index 4bb1d5776a..8c109c1c5f 100644 --- a/botocore/data/resiliencehub/2020-04-30/service-2.json +++ b/botocore/data/resiliencehub/2020-04-30/service-2.json @@ -535,7 +535,7 @@ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], - "documentation":"List of compliance drifts that were detected while running an assessment.
" + "documentation":"Indicates the list of compliance drifts that were detected while running an assessment.
" }, "ListAppAssessmentResourceDrifts":{ "name":"ListAppAssessmentResourceDrifts", @@ -1332,6 +1332,10 @@ "shape":"AppAssessmentScheduleType", "documentation":"Assessment execution schedule with 'Daily' or 'Disabled' values.
" }, + "awsApplicationArn":{ + "shape":"Arn", + "documentation":"Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.
" + }, "complianceStatus":{ "shape":"AppComplianceStatusType", "documentation":"Current status of compliance for the resiliency policy.
" @@ -1473,7 +1477,7 @@ }, "summary":{ "shape":"AssessmentSummary", - "documentation":"Indicates a concise summary that provides an overview of the Resilience Hub assessment.
" + "documentation":"Indicates the AI-generated summary for the Resilience Hub assessment, providing a concise overview that highlights the top risks and recommendations.
This property is available only in the US East (N. Virginia) Region.
Assessment execution schedule with 'Daily' or 'Disabled' values.
" }, + "awsApplicationArn":{ + "shape":"Arn", + "documentation":"Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.
" + }, "complianceStatus":{ "shape":"AppComplianceStatusType", "documentation":"The current status of compliance for the resiliency policy.
" @@ -1929,7 +1937,6 @@ "required":[ "entryId", "excluded", - "item", "referenceId" ], "members":{ @@ -2182,6 +2189,10 @@ "shape":"AppAssessmentScheduleType", "documentation":"Assessment execution schedule with 'Daily' or 'Disabled' values.
" }, + "awsApplicationArn":{ + "shape":"Arn", + "documentation":"Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.
" + }, "clientToken":{ "shape":"ClientToken", "documentation":"Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
", @@ -3024,9 +3035,13 @@ "shape":"EntityVersion", "documentation":"The version of the application.
" }, + "errorDetails":{ + "shape":"ErrorDetailList", + "documentation":"List of errors that were encountered while importing resources.
" + }, "errorMessage":{ "shape":"String500", - "documentation":"The returned error message for the request.
" + "documentation":"The error message returned for the resource request.
" }, "status":{ "shape":"ResourceImportStatusType", @@ -3263,6 +3278,20 @@ "type":"string", "pattern":"^\\S{1,50}$" }, + "ErrorDetail":{ + "type":"structure", + "members":{ + "errorMessage":{ + "shape":"ErrorMessage", + "documentation":"Provides additional information about the error.
" + } + }, + "documentation":"Indicates the error that was encountered while importing a resource.
" + }, + "ErrorDetailList":{ + "type":"list", + "member":{"shape":"ErrorDetail"} + }, "ErrorMessage":{ "type":"string", "max":500, @@ -4053,6 +4082,12 @@ "location":"querystring", "locationName":"appArn" }, + "awsApplicationArn":{ + "shape":"Arn", + "documentation":"Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.
", + "location":"querystring", + "locationName":"awsApplicationArn" + }, "fromLastAssessmentTime":{ "shape":"TimeStamp", "documentation":"Indicates the lower limit of the range that is used to filter applications based on their last assessment times.
", @@ -5940,7 +5975,6 @@ "required":[ "entryId", "excluded", - "item", "referenceId" ], "members":{ diff --git a/botocore/data/sesv2/2019-09-27/service-2.json b/botocore/data/sesv2/2019-09-27/service-2.json index 2b199fd1e9..da55b75617 100644 --- a/botocore/data/sesv2/2019-09-27/service-2.json +++ b/botocore/data/sesv2/2019-09-27/service-2.json @@ -2762,6 +2762,10 @@ "SendingPoolName":{ "shape":"PoolName", "documentation":"The name of the dedicated IP pool to associate with the configuration set.
" + }, + "MaxDeliverySeconds":{ + "shape":"MaxDeliverySeconds", + "documentation":"The maximum amount of time, in seconds, that Amazon SES API v2 will attempt delivery of email. If specified, the value must greater than or equal to 300 seconds (5 minutes) and less than or equal to 50400 seconds (840 minutes).
" } }, "documentation":"Used to associate a configuration set with a dedicated IP pool.
" @@ -5105,6 +5109,11 @@ ] }, "Max24HourSend":{"type":"double"}, + "MaxDeliverySeconds":{ + "type":"long", + "max":50400, + "min":300 + }, "MaxItems":{"type":"integer"}, "MaxSendRate":{"type":"double"}, "Message":{ @@ -5619,6 +5628,10 @@ "SendingPoolName":{ "shape":"SendingPoolName", "documentation":"The name of the dedicated IP pool to associate with the configuration set.
" + }, + "MaxDeliverySeconds":{ + "shape":"MaxDeliverySeconds", + "documentation":"The maximum amount of time, in seconds, that Amazon SES API v2 will attempt delivery of email. If specified, the value must greater than or equal to 300 seconds (5 minutes) and less than or equal to 50400 seconds (840 minutes).
" } }, "documentation":"A request to associate a configuration set with a dedicated IP pool.
" diff --git a/docs/source/conf.py b/docs/source/conf.py index 549cb4e6a2..c25a39e587 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -59,7 +59,7 @@ # The short X.Y version. version = '1.35.' # The full version, including alpha/beta/rc tags. -release = '1.35.40' +release = '1.35.41' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.