From fca692d6382edd2a154b04f207c026aebae731c3 Mon Sep 17 00:00:00 2001 From: AWS SDK For Ruby Date: Tue, 15 Oct 2024 18:10:26 +0000 Subject: [PATCH] Updated API models and rebuilt service gems. --- apis/amplify/2017-07-25/api-2.json | 16 +- apis/amplify/2017-07-25/docs-2.json | 20 +- apis/cloudformation/2010-05-15/docs-2.json | 280 +++--- apis/codebuild/2016-10-06/api-2.json | 58 +- apis/codebuild/2016-10-06/docs-2.json | 45 + apis/ivs/2020-07-14/api-2.json | 226 ++--- apis/ivs/2020-07-14/docs-2.json | 13 +- apis/qbusiness/2023-11-27/api-2.json | 17 +- apis/qbusiness/2023-11-27/docs-2.json | 26 +- apis/redshift/2012-12-01/api-2.json | 277 ++++++ apis/redshift/2012-12-01/docs-2.json | 161 +++- apis/redshift/2012-12-01/paginators-1.json | 6 + apis/resiliencehub/2020-04-30/api-2.json | 21 +- apis/resiliencehub/2020-04-30/docs-2.json | 23 +- apis/sesv2/2019-09-27/api-2.json | 11 +- apis/sesv2/2019-09-27/docs-2.json | 7 + .../2017-10-26/api-2.json | 42 +- .../2017-10-26/docs-2.json | 50 +- gems/aws-partitions/CHANGELOG.md | 5 + gems/aws-partitions/VERSION | 2 +- gems/aws-partitions/partitions.json | 80 ++ gems/aws-sdk-amplify/CHANGELOG.md | 5 + gems/aws-sdk-amplify/VERSION | 2 +- gems/aws-sdk-amplify/lib/aws-sdk-amplify.rb | 2 +- .../lib/aws-sdk-amplify/client.rb | 38 +- .../lib/aws-sdk-amplify/client_api.rb | 4 + .../lib/aws-sdk-amplify/types.rb | 51 +- gems/aws-sdk-amplify/sig/client.rbs | 3 +- gems/aws-sdk-amplify/sig/types.rbs | 3 + gems/aws-sdk-cloudformation/CHANGELOG.md | 5 + gems/aws-sdk-cloudformation/VERSION | 2 +- .../lib/aws-sdk-cloudformation.rb | 2 +- .../lib/aws-sdk-cloudformation/client.rb | 547 +++++------- .../lib/aws-sdk-cloudformation/event.rb | 10 +- .../lib/aws-sdk-cloudformation/resource.rb | 81 +- .../lib/aws-sdk-cloudformation/stack.rb | 180 ++-- .../aws-sdk-cloudformation/stack_resource.rb | 11 +- .../stack_resource_summary.rb | 9 +- .../lib/aws-sdk-cloudformation/types.rb | 719 +++++++-------- gems/aws-sdk-codebuild/CHANGELOG.md | 5 + gems/aws-sdk-codebuild/VERSION | 2 +- .../lib/aws-sdk-codebuild.rb | 2 +- .../lib/aws-sdk-codebuild/client.rb | 60 +- .../lib/aws-sdk-codebuild/client_api.rb | 23 + .../lib/aws-sdk-codebuild/types.rb | 61 ++ gems/aws-sdk-codebuild/sig/client.rbs | 24 +- gems/aws-sdk-codebuild/sig/types.rbs | 18 +- gems/aws-sdk-ivs/CHANGELOG.md | 5 + gems/aws-sdk-ivs/VERSION | 2 +- gems/aws-sdk-ivs/lib/aws-sdk-ivs.rb | 2 +- gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb | 469 +++++----- .../aws-sdk-ivs/lib/aws-sdk-ivs/client_api.rb | 138 +-- gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb | 845 +++++++++--------- gems/aws-sdk-ivs/sig/client.rbs | 84 +- gems/aws-sdk-ivs/sig/types.rbs | 137 +-- gems/aws-sdk-nimblestudio/CHANGELOG.md | 5 + gems/aws-sdk-nimblestudio/VERSION | 2 +- .../aws-sdk-nimblestudio.gemspec | 3 +- .../lib/aws-sdk-nimblestudio.rb | 2 +- .../lib/aws-sdk-nimblestudio/client.rb | 2 +- gems/aws-sdk-qbusiness/CHANGELOG.md | 5 + gems/aws-sdk-qbusiness/VERSION | 2 +- .../lib/aws-sdk-qbusiness.rb | 2 +- .../lib/aws-sdk-qbusiness/async_client.rb | 4 +- .../lib/aws-sdk-qbusiness/client.rb | 37 +- .../lib/aws-sdk-qbusiness/client_api.rb | 7 + .../lib/aws-sdk-qbusiness/types.rb | 57 +- gems/aws-sdk-qbusiness/sig/client.rbs | 5 +- gems/aws-sdk-qbusiness/sig/types.rbs | 3 + gems/aws-sdk-redshift/CHANGELOG.md | 5 + gems/aws-sdk-redshift/VERSION | 2 +- gems/aws-sdk-redshift/lib/aws-sdk-redshift.rb | 2 +- .../lib/aws-sdk-redshift/client.rb | 308 ++++++- .../lib/aws-sdk-redshift/client_api.rb | 145 +++ .../lib/aws-sdk-redshift/endpoints.rb | 44 + .../lib/aws-sdk-redshift/errors.rb | 66 ++ .../lib/aws-sdk-redshift/plugins/endpoints.rb | 8 + .../lib/aws-sdk-redshift/types.rb | 297 +++++- gems/aws-sdk-redshift/sig/client.rbs | 92 ++ gems/aws-sdk-redshift/sig/errors.rbs | 12 + gems/aws-sdk-redshift/sig/types.rbs | 76 ++ gems/aws-sdk-resiliencehub/CHANGELOG.md | 5 + gems/aws-sdk-resiliencehub/VERSION | 2 +- .../lib/aws-sdk-resiliencehub.rb | 2 +- .../lib/aws-sdk-resiliencehub/client.rb | 37 +- .../lib/aws-sdk-resiliencehub/client_api.rb | 16 +- .../lib/aws-sdk-resiliencehub/types.rb | 78 +- gems/aws-sdk-resiliencehub/sig/client.rbs | 5 +- gems/aws-sdk-resiliencehub/sig/types.rbs | 10 + gems/aws-sdk-sesv2/CHANGELOG.md | 5 + gems/aws-sdk-sesv2/VERSION | 2 +- gems/aws-sdk-sesv2/lib/aws-sdk-sesv2.rb | 2 +- .../aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb | 11 +- .../lib/aws-sdk-sesv2/client_api.rb | 3 + gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb | 20 +- gems/aws-sdk-sesv2/sig/client.rbs | 6 +- gems/aws-sdk-sesv2/sig/types.rbs | 2 + .../CHANGELOG.md | 5 + .../VERSION | 2 +- .../lib/aws-sdk-transcribestreamingservice.rb | 2 +- .../async_client.rb | 118 +-- .../client.rb | 2 +- .../event_streams.rb | 30 +- .../types.rb | 139 +-- .../sig/client.rbs | 12 +- .../sig/types.rbs | 16 +- 106 files changed, 4429 insertions(+), 2233 deletions(-) diff --git a/apis/amplify/2017-07-25/api-2.json b/apis/amplify/2017-07-25/api-2.json index bd30ad549bf..641bbe6ae79 100644 --- a/apis/amplify/2017-07-25/api-2.json +++ b/apis/amplify/2017-07-25/api-2.json @@ -1693,7 +1693,9 @@ "startTime":{"shape":"StartTime"}, "status":{"shape":"JobStatus"}, "endTime":{"shape":"EndTime"}, - "jobType":{"shape":"JobType"} + "jobType":{"shape":"JobType"}, + "sourceUrl":{"shape":"SourceUrl"}, + "sourceUrlType":{"shape":"SourceUrlType"} } }, "JobType":{ @@ -2074,7 +2076,14 @@ "SourceUrl":{ "type":"string", "max":3000, - "pattern":"(?s).*" + "pattern":"^(s3|https|http)://.*" + }, + "SourceUrlType":{ + "type":"string", + "enum":[ + "ZIP", + "BUCKET_PREFIX" + ] }, "StackArn":{ "type":"string", @@ -2116,7 +2125,8 @@ "locationName":"branchName" }, "jobId":{"shape":"JobId"}, - "sourceUrl":{"shape":"SourceUrl"} + "sourceUrl":{"shape":"SourceUrl"}, + "sourceUrlType":{"shape":"SourceUrlType"} } }, "StartDeploymentResult":{ diff --git a/apis/amplify/2017-07-25/docs-2.json b/apis/amplify/2017-07-25/docs-2.json index 1b129407708..4cbfa7126a5 100644 --- a/apis/amplify/2017-07-25/docs-2.json +++ b/apis/amplify/2017-07-25/docs-2.json @@ -5,7 +5,7 @@ "CreateApp": "

Creates a new Amplify app.

", "CreateBackendEnvironment": "

Creates a new backend environment for an Amplify app.

This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

", "CreateBranch": "

Creates a new branch for an Amplify app.

", - "CreateDeployment": "

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.

", + "CreateDeployment": "

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.

", "CreateDomainAssociation": "

Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app

", "CreateWebhook": "

Creates a new webhook on an Amplify app.

", "DeleteApp": "

Deletes an existing Amplify app specified by an app ID.

", @@ -30,7 +30,7 @@ "ListJobs": "

Lists the jobs for a branch of an Amplify app.

", "ListTagsForResource": "

Returns a list of tags for a specified Amazon Resource Name (ARN).

", "ListWebhooks": "

Returns a list of webhooks for an Amplify app.

", - "StartDeployment": "

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.

", + "StartDeployment": "

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.

", "StartJob": "

Starts a new job for a branch of an Amplify app.

", "StopJob": "

Stops a job that is in progress for a branch of an Amplify app.

", "TagResource": "

Tags the resource with a tag key and value.

", @@ -285,7 +285,7 @@ "ListArtifactsRequest$branchName": "

The name of a branch that is part of an Amplify app.

", "ListJobsRequest$branchName": "

The name of the branch to use for the request.

", "ProductionBranch$branchName": "

The branch name for the production branch.

", - "StartDeploymentRequest$branchName": "

The name of the branch to use for the job.

", + "StartDeploymentRequest$branchName": "

The name of the branch to use for the deployment job.

", "StartJobRequest$branchName": "

The name of the branch to use for the job.

", "StopJobRequest$branchName": "

The name of the branch to use for the stop job request.

", "SubDomainSetting$branchName": "

The branch name setting for the subdomain.

", @@ -919,7 +919,7 @@ "GetJobRequest$jobId": "

The unique ID for the job.

", "JobSummary$jobId": "

The unique ID for the job.

", "ListArtifactsRequest$jobId": "

The unique ID for a job.

", - "StartDeploymentRequest$jobId": "

The job ID for this deployment, generated by the create deployment request.

", + "StartDeploymentRequest$jobId": "

The job ID for this deployment that is generated by the CreateDeployment request.

", "StartJobRequest$jobId": "

The unique ID for an existing job. This is required if the value of jobType is RETRY.

", "StopJobRequest$jobId": "

The unique id for the job.

" } @@ -957,7 +957,7 @@ "JobType": { "base": null, "refs": { - "JobSummary$jobType": "

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.

", + "JobSummary$jobType": "

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.

", "StartJobRequest$jobType": "

Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository.

The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required.

" } }, @@ -1194,7 +1194,15 @@ "SourceUrl": { "base": null, "refs": { - "StartDeploymentRequest$sourceUrl": "

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.

" + "JobSummary$sourceUrl": "

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.

", + "StartDeploymentRequest$sourceUrl": "

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.

" + } + }, + "SourceUrlType": { + "base": null, + "refs": { + "JobSummary$sourceUrlType": "

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.

", + "StartDeploymentRequest$sourceUrlType": "

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.

" } }, "StackArn": { diff --git a/apis/cloudformation/2010-05-15/docs-2.json b/apis/cloudformation/2010-05-15/docs-2.json index 5976ac65272..98682aee80e 100644 --- a/apis/cloudformation/2010-05-15/docs-2.json +++ b/apis/cloudformation/2010-05-15/docs-2.json @@ -1,45 +1,45 @@ { "version": "2.0", - "service": "CloudFormation

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.

", + "service": "CloudFormation

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.

", "operations": { "ActivateOrganizationsAccess": "

Activate trusted access with Organizations. With trusted access between StackSets and Organizations activated, the management account has permissions to create and manage StackSets for your organization.

", - "ActivateType": "

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.

", - "BatchDescribeTypeConfigurations": "

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.

", + "ActivateType": "

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.

", + "BatchDescribeTypeConfigurations": "

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": "

Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.

You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.

", - "ContinueUpdateRollback": "

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.

", + "ContinueUpdateRollback": "

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.

", "CreateChangeSet": "

Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you create a change set for an existing stack, CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack.

To create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify CREATE. To create a change set for an existing stack, specify UPDATE for the ChangeSetType parameter. To create a change set for an import operation, specify IMPORT for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action.

When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. CloudFormation doesn't make changes until you execute the change set.

To create a change set for the entire stack hierarchy, set IncludeNestedStacks to True.

", "CreateGeneratedTemplate": "

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

", - "CreateStack": "

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.

", + "CreateStack": "

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": "

Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region. You must specify at least one value for either Accounts or DeploymentTargets, and you must specify at least one value for Regions.

", "CreateStackSet": "

Creates a stack set.

", "DeactivateOrganizationsAccess": "

Deactivates trusted access with Organizations. If trusted access is deactivated, the management account does not have permissions to create and manage service-managed StackSets for your organization.

", "DeactivateType": "

Deactivates a public extension that was previously activated in this account and Region.

Once deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is released.

", "DeleteChangeSet": "

Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.

If the call successfully completes, CloudFormation successfully deleted the change set.

If IncludeNestedStacks specifies True during the creation of the nested change set, then DeleteChangeSet will delete all change sets that belong to the stacks hierarchy and will also delete all change sets for nested stacks with the status of REVIEW_IN_PROGRESS.

", "DeleteGeneratedTemplate": "

Deleted a generated template.

", - "DeleteStack": "

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.

", + "DeleteStack": "

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": "

Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.

", "DeleteStackSet": "

Deletes a stack set. Before you can delete a stack set, all its member stack instances must be deleted. For more information about how to complete this, see DeleteStackInstances.

", "DeregisterType": "

Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.

To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry.

You can't deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the extension type itself is deregistered as well and marked as deprecated.

To view the deprecation status of an extension or extension version, use DescribeType.

", - "DescribeAccountLimits": "

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.

", - "DescribeChangeSet": "

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.

", + "DescribeAccountLimits": "

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": "

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": "

Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.

", "DescribeGeneratedTemplate": "

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

", "DescribeOrganizationsAccess": "

Retrieves information about the account's OrganizationAccess status. This API can be called either by the management account or the delegated administrator by using the CallAs parameter. This API can also be called without the CallAs parameter by the management account.

", - "DescribePublisher": "

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:

", + "DescribePublisher": "

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:

", "DescribeResourceScan": "

Describes details of a resource scan.

", - "DescribeStackDriftDetectionStatus": "

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.

", - "DescribeStackEvents": "

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).

", + "DescribeStackDriftDetectionStatus": "

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.

", + "DescribeStackEvents": "

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).

", "DescribeStackInstance": "

Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.

For a list of stack instances that are associated with a specific StackSet, use ListStackInstances.

", "DescribeStackResource": "

Returns a description of the specified resource in the specified stack.

For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.

", - "DescribeStackResourceDrifts": "

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.

", - "DescribeStackResources": "

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.

", + "DescribeStackResourceDrifts": "

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": "

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.

", "DescribeStackSet": "

Returns the description of the specified StackSet.

", "DescribeStackSetOperation": "

Returns the description of the specified StackSet operation.

", - "DescribeStacks": "

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.

", + "DescribeStacks": "

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.

", "DescribeType": "

Returns detailed information about an extension that has been registered.

If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.

", "DescribeTypeRegistration": "

Returns information about an extension's registration, including its current status and type and version identifiers.

When you initiate a registration request using RegisterType, you can then use DescribeTypeRegistration to monitor the progress of that registration request.

Once the registration request has completed, use DescribeType to return detailed information about an extension.

", - "DetectStackDrift": "

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.

", - "DetectStackResourceDrift": "

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.

", + "DetectStackDrift": "

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.

", + "DetectStackResourceDrift": "

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": "

Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation performs drift detection on a stack set.

DetectStackSetDrift returns the OperationId of the stack set drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, in addition to the number of resources included in each stack.

Once the operation has completed, use the following actions to return drift information:

For more information about performing a drift detection operation on a stack set, see Detecting unmanaged changes in stack sets.

You can only run a single drift detection operation on a given stack set at one time.

To stop a drift detection stack set operation, use StopStackSetOperation.

", "EstimateTemplateCost": "

Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

", "ExecuteChangeSet": "

Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.

When you execute a change set, CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.

If a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.

To create a change set for the entire stack hierarchy, IncludeNestedStacks must have been set to True.

", @@ -49,7 +49,7 @@ "GetTemplateSummary": "

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

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

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

", "ImportStacksToStackSet": "

Import existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a new stack set in the same account as the source stack or in a different administrator account and Region, by specifying the stack ID of the stack you intend to import.

", "ListChangeSets": "

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

", - "ListExports": "

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.

", + "ListExports": "

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": "

Lists your generated templates in this Region.

", "ListImports": "

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

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

", "ListResourceScanRelatedResources": "

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

", @@ -66,23 +66,23 @@ "ListTypeRegistrations": "

Returns a list of registration tokens for the specified extension(s).

", "ListTypeVersions": "

Returns summary information about the versions of an extension.

", "ListTypes": "

Returns summary information about extension that have been registered with CloudFormation.

", - "PublishType": "

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.

", + "PublishType": "

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.

", "RecordHandlerProgress": "

Reports progress of a resource handler to CloudFormation.

Reserved for use by the CloudFormation CLI. Don't use this API in your code.

", - "RegisterPublisher": "

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.

", - "RegisterType": "

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:

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.

", + "RegisterPublisher": "

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.

", + "RegisterType": "

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:

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.

", "RollbackStack": "

When specifying RollbackStack, you preserve the state of previously provisioned resources when an operation fails. You can check the status of the stack through the DescribeStacks operation.

Rolls back the specified stack to the last known stable state from CREATE_FAILED or UPDATE_FAILED stack statuses.

This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state includes any status in a *_COMPLETE. This includes the following stack statuses.

", "SetStackPolicy": "

Sets a stack policy for a specified stack.

", - "SetTypeConfiguration": "

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.

", + "SetTypeConfiguration": "

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.

", "SetTypeDefaultVersion": "

Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.

", "SignalResource": "

Sends a signal to the specified resource with a success or failure status. You can use the SignalResource operation in conjunction with a creation policy or update policy. CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource operation is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.

", "StartResourceScan": "

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

", "StopStackSetOperation": "

Stops an in-progress operation on a stack set and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.

", - "TestType": "

Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.

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.

", + "TestType": "

Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.

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.

", "UpdateGeneratedTemplate": "

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

", - "UpdateStack": "

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.

", + "UpdateStack": "

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": "

Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.

You can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances.

During stack set updates, any parameters overridden for a stack instance aren't updated, but retain their overridden value.

You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

", "UpdateStackSet": "

Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.

Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.

", - "UpdateTerminationProtection": "

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.

", + "UpdateTerminationProtection": "

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": "

Validates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If both these checks fail, CloudFormation returns a template validation error.

" }, "shapes": { @@ -129,7 +129,7 @@ } }, "AccountLimit": { - "base": "

The AccountLimit data type.

CloudFormation has the following limits per account:

For more information about these account limits, and other CloudFormation limits, see CloudFormation quotas in the CloudFormation User Guide.

", + "base": "

The AccountLimit data type.

CloudFormation has the following limits per account:

For more information about these account limits, and other CloudFormation limits, see Understand CloudFormation quotas in the CloudFormation User Guide.

", "refs": { "AccountLimitList$member": null } @@ -236,7 +236,7 @@ "base": null, "refs": { "ActivateTypeInput$AutoUpdate": "

Whether to automatically update 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.

The default is true.

", - "DescribeTypeOutput$AutoUpdate": "

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.

" + "DescribeTypeOutput$AutoUpdate": "

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.

" } }, "BatchDescribeTypeConfigurationsError": { @@ -324,16 +324,16 @@ "Capabilities": { "base": null, "refs": { - "CreateChangeSetInput$Capabilities": "

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.

Only one of the Capabilities and ResourceType parameters can be specified.

", - "CreateStackInput$Capabilities": "

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.

Only one of the Capabilities and ResourceType parameters can be specified.

", - "CreateStackSetInput$Capabilities": "

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.

", + "CreateChangeSetInput$Capabilities": "

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.

Only one of the Capabilities and ResourceType parameters can be specified.

", + "CreateStackInput$Capabilities": "

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.

Only one of the Capabilities and ResourceType parameters can be specified.

", + "CreateStackSetInput$Capabilities": "

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.

", "DescribeChangeSetOutput$Capabilities": "

If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

", - "GetTemplateSummaryOutput$Capabilities": "

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.

", + "GetTemplateSummaryOutput$Capabilities": "

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.

", "Stack$Capabilities": "

The capabilities allowed in the stack.

", - "StackSet$Capabilities": "

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.

", - "UpdateStackInput$Capabilities": "

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.

Only one of the Capabilities and ResourceType parameters can be specified.

", - "UpdateStackSetInput$Capabilities": "

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.

", - "ValidateTemplateOutput$Capabilities": "

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.

" + "StackSet$Capabilities": "

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.

", + "UpdateStackInput$Capabilities": "

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.

Only one of the Capabilities and ResourceType parameters can be specified.

", + "UpdateStackSetInput$Capabilities": "

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.

", + "ValidateTemplateOutput$Capabilities": "

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": { @@ -472,7 +472,7 @@ "ChangeSetType": { "base": null, "refs": { - "CreateChangeSetInput$ChangeSetType": "

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.

" + "CreateChangeSetInput$ChangeSetType": "

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.

" } }, "ChangeSource": { @@ -550,13 +550,13 @@ "ConfigurationSchema": { "base": null, "refs": { - "DescribeTypeOutput$ConfigurationSchema": "

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.

" + "DescribeTypeOutput$ConfigurationSchema": "

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.

" } }, "ConnectionArn": { "base": null, "refs": { - "RegisterPublisherInput$ConnectionArn": "

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.

" + "RegisterPublisherInput$ConnectionArn": "

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.

" } }, "ContinueUpdateRollbackInput": { @@ -944,8 +944,8 @@ "DetailedStatus": { "base": null, "refs": { - "Stack$DetailedStatus": "

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.

", - "StackEvent$DetailedStatus": "

An optional field containing information about the detailed status of the stack event.

" + "Stack$DetailedStatus": "

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.

", + "StackEvent$DetailedStatus": "

An optional field containing information about the detailed status of the stack event.

" } }, "DetectStackDriftInput": { @@ -1002,8 +1002,8 @@ "EnableTerminationProtection": { "base": null, "refs": { - "CreateStackInput$EnableTerminationProtection": "

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.

", - "Stack$EnableTerminationProtection": "

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.

", + "CreateStackInput$EnableTerminationProtection": "

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.

", + "Stack$EnableTerminationProtection": "

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.

", "UpdateTerminationProtectionInput$EnableTerminationProtection": "

Whether to enable termination protection on the specified stack.

" } }, @@ -1017,7 +1017,7 @@ "base": null, "refs": { "BatchDescribeTypeConfigurationsError$ErrorMessage": "

The error message.

", - "CFNRegistryException$Message": "

An message with details about the error that occurred.

" + "CFNRegistryException$Message": "

A message with details about the error that occurred.

" } }, "EstimateTemplateCostInput": { @@ -1149,7 +1149,7 @@ "GeneratedTemplateResourceStatus": { "base": null, "refs": { - "ResourceDetail$ResourceStatus": "

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

InProgress

The resource processing is still in progress.

Complete

The resource processing is complete.

Pending

The resource processing is pending.

Failed

The resource processing has failed.

" + "ResourceDetail$ResourceStatus": "

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

InProgress

The resource processing is still in progress.

Complete

The resource processing is complete.

Pending

The resource processing is pending.

Failed

The resource processing has failed.

" } }, "GeneratedTemplateStatus": { @@ -1284,14 +1284,14 @@ "base": null, "refs": { "DescribePublisherOutput$IdentityProvider": "

The type of account used as the identity provider when registering this publisher with CloudFormation.

", - "TypeSummary$PublisherIdentity": "

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.

" + "TypeSummary$PublisherIdentity": "

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.

" } }, "ImportExistingResources": { "base": null, "refs": { "ChangeSetSummary$ImportExistingResources": "

Indicates if the change set imports resources that already exist.

", - "CreateChangeSetInput$ImportExistingResources": "

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.

", + "CreateChangeSetInput$ImportExistingResources": "

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.

", "DescribeChangeSetOutput$ImportExistingResources": "

Indicates if the change set imports resources that already exist.

This parameter can only import resources that have custom names in templates. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead.

" } }, @@ -1386,8 +1386,8 @@ "JazzResourceIdentifierProperties": { "base": null, "refs": { - "ScannedResource$ResourceIdentifier": "

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.

", - "ScannedResourceIdentifier$ResourceIdentifier": "

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.

" + "ScannedResource$ResourceIdentifier": "

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.

", + "ScannedResourceIdentifier$ResourceIdentifier": "

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.

" } }, "JazzResourceIdentifierPropertyKey": { @@ -1631,7 +1631,7 @@ "LogicalIdHierarchy": { "base": null, "refs": { - "ModuleInfo$LogicalIdHierarchy": "

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.

" + "ModuleInfo$LogicalIdHierarchy": "

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.

" } }, "LogicalResourceId": { @@ -1723,11 +1723,11 @@ "base": null, "refs": { "GetTemplateSummaryOutput$Metadata": "

The value that's defined for the Metadata property of the template.

", - "StackResourceDetail$Metadata": "

The content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute in the CloudFormation User Guide.

" + "StackResourceDetail$Metadata": "

The content of the Metadata attribute declared for the resource. For more information, see Metadata attribute in the CloudFormation User Guide.

" } }, "ModuleInfo": { - "base": "

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.

", + "base": "

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.

", "refs": { "ResourceChange$ModuleInfo": "

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

", "StackResource$ModuleInfo": "

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

", @@ -1816,9 +1816,9 @@ "NotificationARNs": { "base": null, "refs": { - "CreateChangeSetInput$NotificationARNs": "

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.

", - "CreateStackInput$NotificationARNs": "

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).

", - "DescribeChangeSetOutput$NotificationARNs": "

The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.

", + "CreateChangeSetInput$NotificationARNs": "

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.

", + "CreateStackInput$NotificationARNs": "

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).

", + "DescribeChangeSetOutput$NotificationARNs": "

The ARNs of the Amazon SNS topics that will be associated with the stack if you execute the change set.

", "Stack$NotificationARNs": "

Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.

", "UpdateStackInput$NotificationARNs": "

Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. Specify an empty list to remove all notification topics.

" } @@ -1990,7 +1990,7 @@ "base": null, "refs": { "Parameter$ParameterValue": "

The input value associated with the parameter.

", - "Parameter$ResolvedValue": "

Read-only. The value that corresponds to a SSM parameter key. This field is returned only for SSM parameter types in the template.

", + "Parameter$ResolvedValue": "

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.

", "ParameterDeclaration$DefaultValue": "

The default value of the parameter.

", "TemplateParameter$DefaultValue": "

The default value associated with the parameter.

" } @@ -2084,7 +2084,7 @@ } }, "PropertyDifference": { - "base": "

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.

", + "base": "

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.

", "refs": { "PropertyDifferences$member": null } @@ -2130,9 +2130,9 @@ "DescribeTypeOutput$PublicVersionNumber": "

The version number of a public third-party extension.

This applies only if you specify a public extension you have activated in your account, or specify a public extension without specifying a version. For all other extensions, CloudFormation returns null.

", "DescribeTypeOutput$LatestPublicVersion": "

The latest version of a public extension that is available for use.

This only applies if you specify a public extension, and you don't specify a version. For all other requests, CloudFormation returns null.

", "PublishTypeInput$PublicVersionNumber": "

The version number to assign to this version of the extension.

Use the following format, and adhere to semantic versioning when assigning a version number to your extension:

MAJOR.MINOR.PATCH

For more information, see Semantic Versioning 2.0.0.

If you don't specify a version number, CloudFormation increments the version number by one minor version release.

You cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first version number to be 1.0.0.

", - "TypeSummary$PublicVersionNumber": "

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.

", - "TypeSummary$LatestPublicVersion": "

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.

", - "TypeVersionSummary$PublicVersionNumber": "

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.

" + "TypeSummary$PublicVersionNumber": "

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.

", + "TypeSummary$LatestPublicVersion": "

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.

", + "TypeVersionSummary$PublicVersionNumber": "

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.

" } }, "PublishTypeInput": { @@ -2297,7 +2297,7 @@ "Replacement": { "base": null, "refs": { - "ResourceChange$Replacement": "

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.

" + "ResourceChange$Replacement": "

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.

" } }, "RequestToken": { @@ -2307,7 +2307,7 @@ } }, "RequiredActivatedType": { - "base": "

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.

", + "base": "

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.

", "refs": { "RequiredActivatedTypes$member": null } @@ -2327,7 +2327,7 @@ "RequiresRecreation": { "base": null, "refs": { - "ResourceTargetDefinition$RequiresRecreation": "

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.

" + "ResourceTargetDefinition$RequiresRecreation": "

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.

" } }, "ResourceAttribute": { @@ -2389,8 +2389,8 @@ "ResourceIdentifierProperties": { "base": null, "refs": { - "ResourceDefinition$ResourceIdentifier": "

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.

", - "ResourceDetail$ResourceIdentifier": "

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.

", + "ResourceDefinition$ResourceIdentifier": "

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.

", + "ResourceDetail$ResourceIdentifier": "

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.

", "ResourceToImport$ResourceIdentifier": "

A key-value pair that identifies the target resource. The key is an identifier property (for example, BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for example, MyS3Bucket).

" } }, @@ -2472,8 +2472,8 @@ "ResourceScanStatus": { "base": null, "refs": { - "DescribeResourceScanOutput$Status": "

Status of the resource scan.

INPROGRESS

The resource scan is still in progress.

COMPLETE

The resource scan is complete.

EXPIRED

The resource scan has expired.

FAILED

The resource scan has failed.

", - "ResourceScanSummary$Status": "

Status of the resource scan.

INPROGRESS

The resource scan is still in progress.

COMPLETE

The resource scan is complete.

EXPIRED

The resource scan has expired.

FAILED

The resource scan has failed.

" + "DescribeResourceScanOutput$Status": "

Status of the resource scan.

INPROGRESS

The resource scan is still in progress.

COMPLETE

The resource scan is complete.

EXPIRED

The resource scan has expired.

FAILED

The resource scan has failed.

", + "ResourceScanSummary$Status": "

Status of the resource scan.

INPROGRESS

The resource scan is still in progress.

COMPLETE

The resource scan is complete.

EXPIRED

The resource scan has expired.

FAILED

The resource scan has failed.

" } }, "ResourceScanStatusReason": { @@ -2555,19 +2555,19 @@ "base": null, "refs": { "ResourceChange$ResourceType": "

The type of CloudFormation resource, such as AWS::S3::Bucket.

", - "ResourceDefinition$ResourceType": "

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

", - "ResourceDetail$ResourceType": "

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

", + "ResourceDefinition$ResourceType": "

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

", + "ResourceDetail$ResourceType": "

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

", "ResourceIdentifierSummary$ResourceType": "

The template resource type of the target resources, such as AWS::S3::Bucket.

", - "ResourceToImport$ResourceType": "

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.

", + "ResourceToImport$ResourceType": "

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.

", "ResourceTypes$member": null, - "ScannedResource$ResourceType": "

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

", - "ScannedResourceIdentifier$ResourceType": "

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.

", - "StackEvent$ResourceType": "

Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)

", - "StackInstanceResourceDriftsSummary$ResourceType": "

Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.

", - "StackResource$ResourceType": "

Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.

", - "StackResourceDetail$ResourceType": "

Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.

", + "ScannedResource$ResourceType": "

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

", + "ScannedResourceIdentifier$ResourceType": "

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.

", + "StackEvent$ResourceType": "

Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

", + "StackInstanceResourceDriftsSummary$ResourceType": "

Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

", + "StackResource$ResourceType": "

Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

", + "StackResourceDetail$ResourceType": "

Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

", "StackResourceDrift$ResourceType": "

The type of the resource.

", - "StackResourceSummary$ResourceType": "

Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)

" + "StackResourceSummary$ResourceType": "

Type of resource. (For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.)

" } }, "ResourceTypePrefix": { @@ -2579,11 +2579,11 @@ "ResourceTypes": { "base": null, "refs": { - "CreateChangeSetInput$ResourceTypes": "

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.

", - "CreateStackInput$ResourceTypes": "

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.

", + "CreateChangeSetInput$ResourceTypes": "

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.

", + "CreateStackInput$ResourceTypes": "

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.

", "DescribeResourceScanOutput$ResourceTypes": "

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

", "GetTemplateSummaryOutput$ResourceTypes": "

A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

", - "UpdateStackInput$ResourceTypes": "

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.

", + "UpdateStackInput$ResourceTypes": "

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.

", "Warnings$UnrecognizedResourceTypes": "

A list of all of the unrecognized resource types. This is only returned if the TemplateSummaryConfig parameter has the TreatUnrecognizedResourceTypesAsWarning configuration set to True.

" } }, @@ -2632,7 +2632,7 @@ "ResourcesToSkip": { "base": null, "refs": { - "ContinueUpdateRollbackInput$ResourcesToSkip": "

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.

" + "ContinueUpdateRollbackInput$ResourcesToSkip": "

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.

" } }, "RetainExceptOnCreate": { @@ -2654,7 +2654,7 @@ "RetainStacks": { "base": null, "refs": { - "DeleteStackInstancesInput$RetainStacks": "

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.

" + "DeleteStackInstancesInput$RetainStacks": "

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.

" } }, "RetainStacksNullable": { @@ -2672,16 +2672,16 @@ "RoleARN": { "base": null, "refs": { - "ContinueUpdateRollbackInput$RoleARN": "

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.

", - "CreateChangeSetInput$RoleARN": "

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.

", - "CreateStackInput$RoleARN": "

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.

", + "ContinueUpdateRollbackInput$RoleARN": "

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.

", + "CreateChangeSetInput$RoleARN": "

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.

", + "CreateStackInput$RoleARN": "

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.

", "CreateStackSetInput$AdministrationRoleARN": "

The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

", - "DeleteStackInput$RoleARN": "

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.

", - "RollbackStackInput$RoleARN": "

The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation assumes to rollback the stack.

", - "Stack$RoleARN": "

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.

", + "DeleteStackInput$RoleARN": "

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.

", + "RollbackStackInput$RoleARN": "

The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to rollback the stack.

", + "Stack$RoleARN": "

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.

", "StackSet$AdministrationRoleARN": "

The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.

Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

", "StackSetOperation$AdministrationRoleARN": "

The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.

Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the CloudFormation User Guide.

", - "UpdateStackInput$RoleARN": "

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.

", + "UpdateStackInput$RoleARN": "

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.

", "UpdateStackSetInput$AdministrationRoleARN": "

The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.

" } }, @@ -2695,7 +2695,7 @@ } }, "RollbackConfiguration": { - "base": "

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.

", + "base": "

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.

", "refs": { "CreateChangeSetInput$RollbackConfiguration": "

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

", "CreateStackInput$RollbackConfiguration": "

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

", @@ -2729,13 +2729,13 @@ "S3Bucket": { "base": null, "refs": { - "TestTypeInput$LogDeliveryBucket": "

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:

For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Amazon Web Services Identity and Access Management User Guide.

" + "TestTypeInput$LogDeliveryBucket": "

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:

For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.

" } }, "S3Url": { "base": null, "refs": { - "RegisterTypeInput$SchemaHandlerPackage": "

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.

" + "RegisterTypeInput$SchemaHandlerPackage": "

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.

" } }, "ScannedResource": { @@ -2828,13 +2828,13 @@ "StackDriftInformation": { "base": "

Contains information about whether the 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.

", "refs": { - "Stack$DriftInformation": "

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.

" + "Stack$DriftInformation": "

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.

" } }, "StackDriftInformationSummary": { "base": "

Contains information about whether the 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.

", "refs": { - "StackSummary$DriftInformation": "

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.

" + "StackSummary$DriftInformation": "

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.

" } }, "StackDriftStatus": { @@ -2874,8 +2874,8 @@ "Export$ExportingStackId": "

The stack that contains the exported output name and value.

", "RollbackStackOutput$StackId": "

Unique identifier of the stack.

", "Stack$StackId": "

Unique identifier of the stack.

", - "Stack$ParentId": "

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.

", - "Stack$RootId": "

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.

", + "Stack$ParentId": "

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.

", + "Stack$RootId": "

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.

", "StackEvent$StackId": "

The unique ID name of the instance of the stack.

", "StackIdList$member": null, "StackInstance$StackId": "

The ID of the stack instance.

", @@ -2885,8 +2885,8 @@ "StackResourceDetail$StackId": "

Unique identifier of the stack.

", "StackResourceDrift$StackId": "

The ID of the stack.

", "StackSummary$StackId": "

Unique stack identifier.

", - "StackSummary$ParentId": "

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.

", - "StackSummary$RootId": "

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.

", + "StackSummary$ParentId": "

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.

", + "StackSummary$RootId": "

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.

", "UpdateStackOutput$StackId": "

Unique identifier of the stack.

", "UpdateTerminationProtectionOutput$StackId": "

The unique ID of the stack.

" } @@ -2904,7 +2904,7 @@ } }, "StackInstance": { - "base": "

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.

", + "base": "

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.

", "refs": { "DescribeStackInstanceOutput$StackInstance": "

The stack instance that matches the specified request parameters.

" } @@ -3036,9 +3036,9 @@ "StackPolicyBody": { "base": null, "refs": { - "CreateStackInput$StackPolicyBody": "

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.

", - "GetStackPolicyOutput$StackPolicyBody": "

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

", - "SetStackPolicyInput$StackPolicyBody": "

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.

", + "CreateStackInput$StackPolicyBody": "

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.

", + "GetStackPolicyOutput$StackPolicyBody": "

Structure containing the stack policy body. (For more information, see Prevent updates to stack resources in the CloudFormation User Guide.)

", + "SetStackPolicyInput$StackPolicyBody": "

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.

", "UpdateStackInput$StackPolicyBody": "

Structure containing a new stack policy body. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.

" } }, @@ -3075,7 +3075,7 @@ } }, "StackResourceDrift": { - "base": "

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.

", + "base": "

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.

", "refs": { "DetectStackResourceDriftOutput$StackResourceDrift": "

Information about whether the resource's actual configuration has drifted from its expected template configuration, including actual and expected property values and any differences detected.

", "StackResourceDrifts$member": null @@ -3084,14 +3084,14 @@ "StackResourceDriftInformation": { "base": "

Contains information about whether the resource's actual configuration differs, or has drifted, from its expected configuration.

", "refs": { - "StackResource$DriftInformation": "

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.

", - "StackResourceDetail$DriftInformation": "

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.

" + "StackResource$DriftInformation": "

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.

", + "StackResourceDetail$DriftInformation": "

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.

" } }, "StackResourceDriftInformationSummary": { "base": "

Summarizes information about whether the resource's actual configuration differs, or has drifted, from its expected configuration.

", "refs": { - "StackResourceSummary$DriftInformation": "

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.

" + "StackResourceSummary$DriftInformation": "

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.

" } }, "StackResourceDriftStatus": { @@ -3099,8 +3099,8 @@ "refs": { "StackInstanceResourceDriftsSummary$StackResourceDriftStatus": "

The drift status of the resource in a stack instance.

", "StackResourceDrift$StackResourceDriftStatus": "

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

", - "StackResourceDriftInformation$StackResourceDriftStatus": "

Status of the resource's actual configuration compared to its expected configuration

", - "StackResourceDriftInformationSummary$StackResourceDriftStatus": "

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

", + "StackResourceDriftInformation$StackResourceDriftStatus": "

Status of the resource's actual configuration compared to its expected configuration

", + "StackResourceDriftInformationSummary$StackResourceDriftStatus": "

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

", "StackResourceDriftStatusFilters$member": null } }, @@ -3114,7 +3114,7 @@ "StackResourceDrifts": { "base": null, "refs": { - "DescribeStackResourceDriftsOutput$StackResourceDrifts": "

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.

" + "DescribeStackResourceDriftsOutput$StackResourceDrifts": "

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.

" } }, "StackResourceSummaries": { @@ -3163,7 +3163,7 @@ "base": "

Detailed information about the drift status of the stack set.

For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations in-progress isn't included.

For stack set operations, includes information about drift operations currently being performed on the stack set.

For more information, see Detecting unmanaged changes in stack sets in the CloudFormation User Guide.

", "refs": { "StackSet$StackSetDriftDetectionDetails": "

Detailed information about the drift status of the stack set.

For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations currently in progress isn't included.

", - "StackSetOperation$StackSetDriftDetectionDetails": "

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.

" + "StackSetOperation$StackSetDriftDetectionDetails": "

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.

" } }, "StackSetDriftDetectionStatus": { @@ -3243,14 +3243,14 @@ } }, "StackSetOperationPreferences": { - "base": "

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.

", + "base": "

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.

", "refs": { "CreateStackInstancesInput$OperationPreferences": "

Preferences for how CloudFormation performs this stack set operation.

", "DeleteStackInstancesInput$OperationPreferences": "

Preferences for how CloudFormation performs this stack set operation.

", - "DetectStackSetDriftInput$OperationPreferences": "

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.

", - "ImportStacksToStackSetInput$OperationPreferences": "

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.

", + "DetectStackSetDriftInput$OperationPreferences": "

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.

", + "ImportStacksToStackSetInput$OperationPreferences": "

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.

", "StackSetOperation$OperationPreferences": "

The preferences for how CloudFormation performs this stack set operation.

", - "StackSetOperationSummary$OperationPreferences": "

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.

", + "StackSetOperationSummary$OperationPreferences": "

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.

", "UpdateStackInstancesInput$OperationPreferences": "

Preferences for how CloudFormation performs this stack set operation.

", "UpdateStackSetInput$OperationPreferences": "

Preferences for how CloudFormation performs this stack set operation.

" } @@ -3276,8 +3276,8 @@ "StackSetOperationStatus": { "base": null, "refs": { - "StackSetOperation$Status": "

The status of the operation.

", - "StackSetOperationSummary$Status": "

The overall status of the operation.

" + "StackSetOperation$Status": "

The status of the operation.

", + "StackSetOperationSummary$Status": "

The overall status of the operation.

" } }, "StackSetOperationStatusDetails": { @@ -3424,7 +3424,7 @@ "base": null, "refs": { "ListResourceScanResourcesInput$TagKey": "

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

", - "Tag$Key": "

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:.

" + "Tag$Key": "

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:.

" } }, "TagValue": { @@ -3451,16 +3451,16 @@ "base": null, "refs": { "CreateChangeSetInput$TemplateBody": "

A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

", - "CreateStackInput$TemplateBody": "

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.

", - "CreateStackSetInput$TemplateBody": "

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.

", - "EstimateTemplateCostInput$TemplateBody": "

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.

", + "CreateStackInput$TemplateBody": "

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.

", + "CreateStackSetInput$TemplateBody": "

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.

", + "EstimateTemplateCostInput$TemplateBody": "

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.

", "GetGeneratedTemplateOutput$TemplateBody": "

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

", - "GetTemplateOutput$TemplateBody": "

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.

", - "GetTemplateSummaryInput$TemplateBody": "

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.

", + "GetTemplateOutput$TemplateBody": "

Structure containing the template body.

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

", + "GetTemplateSummaryInput$TemplateBody": "

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.

", "StackSet$TemplateBody": "

The structure that contains the body of the template that was used to create or update the stack set.

", - "UpdateStackInput$TemplateBody": "

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.

", - "UpdateStackSetInput$TemplateBody": "

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.

", - "ValidateTemplateInput$TemplateBody": "

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.

" + "UpdateStackInput$TemplateBody": "

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.

", + "UpdateStackSetInput$TemplateBody": "

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.

", + "ValidateTemplateInput$TemplateBody": "

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.

" } }, "TemplateConfiguration": { @@ -3537,13 +3537,13 @@ "base": null, "refs": { "CreateChangeSetInput$TemplateURL": "

The location of the file that contains the revised template. 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. CloudFormation generates the change set by comparing this template with the stack that you specified. The location for an Amazon S3 bucket must start with https://.

Conditional: You must specify only TemplateBody or TemplateURL.

", - "CreateStackInput$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, 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.

", - "CreateStackSetInput$TemplateURL": "

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.

", - "EstimateTemplateCostInput$TemplateURL": "

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.

", - "GetTemplateSummaryInput$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.

", - "UpdateStackInput$TemplateURL": "

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.

", - "UpdateStackSetInput$TemplateURL": "

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.

", - "ValidateTemplateInput$TemplateURL": "

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.

" + "CreateStackInput$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 either the TemplateBody or the TemplateURL parameter, but not both.

", + "CreateStackSetInput$TemplateURL": "

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.

", + "EstimateTemplateCostInput$TemplateURL": "

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.

", + "GetTemplateSummaryInput$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.

", + "UpdateStackInput$TemplateURL": "

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.

", + "UpdateStackSetInput$TemplateURL": "

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.

", + "ValidateTemplateInput$TemplateURL": "

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.

" } }, "TestTypeInput": { @@ -3652,7 +3652,7 @@ "Type": { "base": null, "refs": { - "RollbackTrigger$Type": "

The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.

" + "RollbackTrigger$Type": "

The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.

" } }, "TypeArn": { @@ -3678,7 +3678,7 @@ "TypeConfiguration": { "base": null, "refs": { - "SetTypeConfigurationInput$Configuration": "

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.

", + "SetTypeConfigurationInput$Configuration": "

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.

", "TypeConfigurationDetails$Configuration": "

A JSON string specifying the configuration data for the extension, in this account and Region.

If a configuration hasn't been set for a specified extension, CloudFormation returns {}.

" } }, @@ -3699,7 +3699,7 @@ } }, "TypeConfigurationDetails": { - "base": "

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.

", + "base": "

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.

", "refs": { "TypeConfigurationDetailsList$member": null } @@ -3750,20 +3750,20 @@ "DeregisterTypeInput$TypeName": "

The name of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

", "DescribeTypeInput$TypeName": "

The name of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

", "DescribeTypeOutput$TypeName": "

The name of the extension.

If the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the type name alias. For more information, see ActivateType.

", - "DescribeTypeOutput$OriginalTypeName": "

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.

", + "DescribeTypeOutput$OriginalTypeName": "

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.

", "ListTypeRegistrationsInput$TypeName": "

The name of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

", "ListTypeVersionsInput$TypeName": "

The name of the extension for which you want version summary information.

Conditional: You must specify either TypeName and Type, or Arn.

", "PublishTypeInput$TypeName": "

The name of the extension.

Conditional: You must specify Arn, or TypeName and Type.

", - "RegisterTypeInput$TypeName": "

The name of the extension being registered.

We suggest that extension names adhere to the following patterns:

The following organization namespaces are reserved and can't be used in your extension names:

", + "RegisterTypeInput$TypeName": "

The name of the extension being registered.

We suggest that extension names adhere to the following patterns:

The following organization namespaces are reserved and can't be used in your extension names:

", "RequiredActivatedType$TypeNameAlias": "

An alias assigned to the public extension, in this account and Region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.

", - "RequiredActivatedType$OriginalTypeName": "

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.

", + "RequiredActivatedType$OriginalTypeName": "

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.

", "SetTypeConfigurationInput$TypeName": "

The name of the extension.

Conditional: You must specify ConfigurationArn, or Type and TypeName.

", "SetTypeDefaultVersionInput$TypeName": "

The name of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

", "TestTypeInput$TypeName": "

The name of the extension to test.

Conditional: You must specify Arn, or TypeName and Type.

", "TypeConfigurationDetails$TypeName": "

The name of the extension.

", "TypeConfigurationIdentifier$TypeName": "

The name of the extension type to which this configuration applies.

", "TypeSummary$TypeName": "

The name of the extension.

If you specified a TypeNameAlias when you call the ActivateType API operation in your account and Region, CloudFormation considers that alias as the type name.

", - "TypeSummary$OriginalTypeName": "

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.

", + "TypeSummary$OriginalTypeName": "

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.

", "TypeVersionSummary$TypeName": "

The name of the extension.

" } }, @@ -3781,7 +3781,7 @@ "TypeSchema": { "base": null, "refs": { - "DescribeTypeOutput$Schema": "

The schema that defines the extension.

For more information about extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.

" + "DescribeTypeOutput$Schema": "

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.

" } }, "TypeSummaries": { @@ -3799,7 +3799,7 @@ "TypeTestsStatus": { "base": null, "refs": { - "DescribeTypeOutput$TypeTestsStatus": "

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.

" + "DescribeTypeOutput$TypeTestsStatus": "

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.

" } }, "TypeTestsStatusDescription": { @@ -3970,7 +3970,7 @@ "WarningType": { "base": null, "refs": { - "WarningDetail$Type": "

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

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.

" + "WarningDetail$Type": "

The type of this warning. For more information, see Resolve write-only properties in the CloudFormation User Guide.

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.

" } }, "Warnings": { diff --git a/apis/codebuild/2016-10-06/api-2.json b/apis/codebuild/2016-10-06/api-2.json index 58aa35bdf8b..8cc69b50b35 100644 --- a/apis/codebuild/2016-10-06/api-2.json +++ b/apis/codebuild/2016-10-06/api-2.json @@ -1130,6 +1130,7 @@ "scalingConfiguration":{"shape":"ScalingConfigurationInput"}, "overflowBehavior":{"shape":"FleetOverflowBehavior"}, "vpcConfig":{"shape":"VpcConfig"}, + "proxyConfiguration":{"shape":"ProxyConfiguration"}, "imageId":{"shape":"NonEmptyString"}, "fleetServiceRole":{"shape":"NonEmptyString"}, "tags":{"shape":"TagList"} @@ -1476,6 +1477,7 @@ "scalingConfiguration":{"shape":"ScalingConfigurationOutput"}, "overflowBehavior":{"shape":"FleetOverflowBehavior"}, "vpcConfig":{"shape":"VpcConfig"}, + "proxyConfiguration":{"shape":"ProxyConfiguration"}, "imageId":{"shape":"NonEmptyString"}, "fleetServiceRole":{"shape":"NonEmptyString"}, "tags":{"shape":"TagList"} @@ -1520,6 +1522,51 @@ "ON_DEMAND" ] }, + "FleetProxyRule":{ + "type":"structure", + "required":[ + "type", + "effect", + "entities" + ], + "members":{ + "type":{"shape":"FleetProxyRuleType"}, + "effect":{"shape":"FleetProxyRuleEffectType"}, + "entities":{"shape":"FleetProxyRuleEntities"} + } + }, + "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"] @@ -2162,6 +2209,13 @@ "type":"list", "member":{"shape":"Project"} }, + "ProxyConfiguration":{ + "type":"structure", + "members":{ + "defaultBehavior":{"shape":"FleetProxyRuleBehavior"}, + "orderedProxyRules":{"shape":"FleetProxyRules"} + } + }, "PutResourcePolicyInput":{ "type":"structure", "required":[ @@ -2750,6 +2804,7 @@ "scalingConfiguration":{"shape":"ScalingConfigurationInput"}, "overflowBehavior":{"shape":"FleetOverflowBehavior"}, "vpcConfig":{"shape":"VpcConfig"}, + "proxyConfiguration":{"shape":"ProxyConfiguration"}, "imageId":{"shape":"NonEmptyString"}, "fleetServiceRole":{"shape":"NonEmptyString"}, "tags":{"shape":"TagList"} @@ -2904,7 +2959,8 @@ "COMMIT_MESSAGE", "WORKFLOW_NAME", "TAG_NAME", - "RELEASE_NAME" + "RELEASE_NAME", + "REPOSITORY_NAME" ] }, "WebhookScopeType":{ diff --git a/apis/codebuild/2016-10-06/docs-2.json b/apis/codebuild/2016-10-06/docs-2.json index cefb506ca73..2b28d8e477f 100644 --- a/apis/codebuild/2016-10-06/docs-2.json +++ b/apis/codebuild/2016-10-06/docs-2.json @@ -714,6 +714,42 @@ "UpdateFleetInput$overflowBehavior": "

The compute fleet overflow behavior.

" } }, + "FleetProxyRule": { + "base": "

Information about the proxy rule for your reserved capacity instances.

", + "refs": { + "FleetProxyRules$member": null + } + }, + "FleetProxyRuleBehavior": { + "base": null, + "refs": { + "ProxyConfiguration$defaultBehavior": "

The default behavior of outgoing traffic.

" + } + }, + "FleetProxyRuleEffectType": { + "base": null, + "refs": { + "FleetProxyRule$effect": "

The behavior of the proxy rule.

" + } + }, + "FleetProxyRuleEntities": { + "base": null, + "refs": { + "FleetProxyRule$entities": "

The destination of the proxy rule.

" + } + }, + "FleetProxyRuleType": { + "base": null, + "refs": { + "FleetProxyRule$type": "

The type of proxy rule.

" + } + }, + "FleetProxyRules": { + "base": null, + "refs": { + "ProxyConfiguration$orderedProxyRules": "

An array of FleetProxyRule objects that represent the specified destination domains or IPs to allow or deny network access control to.

" + } + }, "FleetScalingMetricType": { "base": null, "refs": { @@ -1369,6 +1405,14 @@ "BatchGetProjectsOutput$projects": "

Information about the requested build projects.

" } }, + "ProxyConfiguration": { + "base": "

Information about the proxy configurations that apply network access control to your reserved capacity instances.

", + "refs": { + "CreateFleetInput$proxyConfiguration": "

The proxy configuration of the compute fleet.

", + "Fleet$proxyConfiguration": "

The proxy configuration of the compute fleet.

", + "UpdateFleetInput$proxyConfiguration": "

The proxy configuration of the compute fleet.

" + } + }, "PutResourcePolicyInput": { "base": null, "refs": { @@ -1777,6 +1821,7 @@ "EnvironmentImage$description": "

The description of the Docker image.

", "EnvironmentVariable$value": "

The value of the environment variable.

We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially Amazon Web Services secret key IDs. PLAINTEXT environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.

", "ExportedEnvironmentVariable$value": "

The value assigned to the exported environment variable.

", + "FleetProxyRuleEntities$member": null, "FleetStatus$message": "

A message associated with the status of a compute fleet.

", "ImageVersions$member": null, "ListBuildBatchesForProjectInput$nextToken": "

The nextToken value returned from a previous call to ListBuildBatchesForProject. This specifies the next item to return. To return the beginning of the list, exclude this parameter.

", diff --git a/apis/ivs/2020-07-14/api-2.json b/apis/ivs/2020-07-14/api-2.json index 4f34ec0011f..c7f73a1c745 100644 --- a/apis/ivs/2020-07-14/api-2.json +++ b/apis/ivs/2020-07-14/api-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":{ @@ -574,10 +575,10 @@ "AudioConfiguration":{ "type":"structure", "members":{ + "channels":{"shape":"Integer"}, "codec":{"shape":"String"}, - "targetBitrate":{"shape":"Integer"}, "sampleRate":{"shape":"Integer"}, - "channels":{"shape":"Integer"} + "targetBitrate":{"shape":"Integer"} } }, "BatchError":{ @@ -616,8 +617,8 @@ "BatchGetStreamKeyResponse":{ "type":"structure", "members":{ - "streamKeys":{"shape":"StreamKeys"}, - "errors":{"shape":"BatchErrors"} + "errors":{"shape":"BatchErrors"}, + "streamKeys":{"shape":"StreamKeys"} } }, "BatchStartViewerSessionRevocationError":{ @@ -628,9 +629,9 @@ ], "members":{ "channelArn":{"shape":"ChannelArn"}, - "viewerId":{"shape":"ViewerId"}, "code":{"shape":"errorCode"}, - "message":{"shape":"errorMessage"} + "message":{"shape":"errorMessage"}, + "viewerId":{"shape":"ViewerId"} } }, "BatchStartViewerSessionRevocationErrors":{ @@ -673,25 +674,25 @@ "type":"structure", "members":{ "arn":{"shape":"ChannelArn"}, - "name":{"shape":"ChannelName"}, - "latencyMode":{"shape":"ChannelLatencyMode"}, - "type":{"shape":"ChannelType"}, - "recordingConfigurationArn":{"shape":"ChannelRecordingConfigurationArn"}, - "ingestEndpoint":{"shape":"IngestEndpoint"}, - "playbackUrl":{"shape":"PlaybackURL"}, "authorized":{"shape":"IsAuthorized"}, - "tags":{"shape":"Tags"}, + "ingestEndpoint":{"shape":"IngestEndpoint"}, "insecureIngest":{"shape":"InsecureIngest"}, + "latencyMode":{"shape":"ChannelLatencyMode"}, + "name":{"shape":"ChannelName"}, + "playbackRestrictionPolicyArn":{"shape":"ChannelPlaybackRestrictionPolicyArn"}, + "playbackUrl":{"shape":"PlaybackURL"}, "preset":{"shape":"TranscodePreset"}, + "recordingConfigurationArn":{"shape":"ChannelRecordingConfigurationArn"}, "srt":{"shape":"Srt"}, - "playbackRestrictionPolicyArn":{"shape":"ChannelPlaybackRestrictionPolicyArn"} + "tags":{"shape":"Tags"}, + "type":{"shape":"ChannelType"} } }, "ChannelArn":{ "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", @@ -714,7 +715,7 @@ "type":"string", "max":128, "min":0, - "pattern":"[a-zA-Z0-9-_]*" + "pattern":"^[a-zA-Z0-9-_]*$" }, "ChannelNotBroadcasting":{ "type":"structure", @@ -731,27 +732,27 @@ "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", "members":{ "arn":{"shape":"ChannelArn"}, - "name":{"shape":"ChannelName"}, - "latencyMode":{"shape":"ChannelLatencyMode"}, "authorized":{"shape":"IsAuthorized"}, - "recordingConfigurationArn":{"shape":"ChannelRecordingConfigurationArn"}, - "tags":{"shape":"Tags"}, "insecureIngest":{"shape":"InsecureIngest"}, - "type":{"shape":"ChannelType"}, + "latencyMode":{"shape":"ChannelLatencyMode"}, + "name":{"shape":"ChannelName"}, + "playbackRestrictionPolicyArn":{"shape":"ChannelPlaybackRestrictionPolicyArn"}, "preset":{"shape":"TranscodePreset"}, - "playbackRestrictionPolicyArn":{"shape":"ChannelPlaybackRestrictionPolicyArn"} + "recordingConfigurationArn":{"shape":"ChannelRecordingConfigurationArn"}, + "tags":{"shape":"Tags"}, + "type":{"shape":"ChannelType"} } }, "ChannelType":{ @@ -781,15 +782,15 @@ "CreateChannelRequest":{ "type":"structure", "members":{ - "name":{"shape":"ChannelName"}, - "latencyMode":{"shape":"ChannelLatencyMode"}, - "type":{"shape":"ChannelType"}, "authorized":{"shape":"Boolean"}, - "recordingConfigurationArn":{"shape":"ChannelRecordingConfigurationArn"}, - "tags":{"shape":"Tags"}, "insecureIngest":{"shape":"Boolean"}, + "latencyMode":{"shape":"ChannelLatencyMode"}, + "name":{"shape":"ChannelName"}, + "playbackRestrictionPolicyArn":{"shape":"ChannelPlaybackRestrictionPolicyArn"}, "preset":{"shape":"TranscodePreset"}, - "playbackRestrictionPolicyArn":{"shape":"ChannelPlaybackRestrictionPolicyArn"} + "recordingConfigurationArn":{"shape":"ChannelRecordingConfigurationArn"}, + "tags":{"shape":"Tags"}, + "type":{"shape":"ChannelType"} } }, "CreateChannelResponse":{ @@ -819,12 +820,12 @@ "type":"structure", "required":["destinationConfiguration"], "members":{ - "name":{"shape":"RecordingConfigurationName"}, "destinationConfiguration":{"shape":"DestinationConfiguration"}, - "tags":{"shape":"Tags"}, - "thumbnailConfiguration":{"shape":"ThumbnailConfiguration"}, + "name":{"shape":"RecordingConfigurationName"}, "recordingReconnectWindowSeconds":{"shape":"RecordingReconnectWindowSeconds"}, - "renditionConfiguration":{"shape":"RenditionConfiguration"} + "renditionConfiguration":{"shape":"RenditionConfiguration"}, + "tags":{"shape":"Tags"}, + "thumbnailConfiguration":{"shape":"ThumbnailConfiguration"} } }, "CreateRecordingConfigurationResponse":{ @@ -989,8 +990,8 @@ "type":"structure", "required":["publicKeyMaterial"], "members":{ - "publicKeyMaterial":{"shape":"PlaybackPublicKeyMaterial"}, "name":{"shape":"PlaybackKeyPairName"}, + "publicKeyMaterial":{"shape":"PlaybackPublicKeyMaterial"}, "tags":{"shape":"Tags"} } }, @@ -1003,8 +1004,8 @@ "IngestConfiguration":{ "type":"structure", "members":{ - "video":{"shape":"VideoConfiguration"}, - "audio":{"shape":"AudioConfiguration"} + "audio":{"shape":"AudioConfiguration"}, + "video":{"shape":"VideoConfiguration"} } }, "IngestEndpoint":{"type":"string"}, @@ -1024,10 +1025,10 @@ "type":"structure", "members":{ "filterByName":{"shape":"ChannelName"}, - "filterByRecordingConfigurationArn":{"shape":"ChannelRecordingConfigurationArn"}, "filterByPlaybackRestrictionPolicyArn":{"shape":"ChannelPlaybackRestrictionPolicyArn"}, - "nextToken":{"shape":"PaginationToken"}, - "maxResults":{"shape":"MaxChannelResults"} + "filterByRecordingConfigurationArn":{"shape":"ChannelRecordingConfigurationArn"}, + "maxResults":{"shape":"MaxChannelResults"}, + "nextToken":{"shape":"PaginationToken"} } }, "ListChannelsResponse":{ @@ -1041,8 +1042,8 @@ "ListPlaybackKeyPairsRequest":{ "type":"structure", "members":{ - "nextToken":{"shape":"PaginationToken"}, - "maxResults":{"shape":"MaxPlaybackKeyPairResults"} + "maxResults":{"shape":"MaxPlaybackKeyPairResults"}, + "nextToken":{"shape":"PaginationToken"} } }, "ListPlaybackKeyPairsResponse":{ @@ -1056,31 +1057,31 @@ "ListPlaybackRestrictionPoliciesRequest":{ "type":"structure", "members":{ - "nextToken":{"shape":"PaginationToken"}, - "maxResults":{"shape":"MaxPlaybackRestrictionPolicyResults"} + "maxResults":{"shape":"MaxPlaybackRestrictionPolicyResults"}, + "nextToken":{"shape":"PaginationToken"} } }, "ListPlaybackRestrictionPoliciesResponse":{ "type":"structure", "required":["playbackRestrictionPolicies"], "members":{ - "playbackRestrictionPolicies":{"shape":"PlaybackRestrictionPolicyList"}, - "nextToken":{"shape":"PaginationToken"} + "nextToken":{"shape":"PaginationToken"}, + "playbackRestrictionPolicies":{"shape":"PlaybackRestrictionPolicyList"} } }, "ListRecordingConfigurationsRequest":{ "type":"structure", "members":{ - "nextToken":{"shape":"PaginationToken"}, - "maxResults":{"shape":"MaxRecordingConfigurationResults"} + "maxResults":{"shape":"MaxRecordingConfigurationResults"}, + "nextToken":{"shape":"PaginationToken"} } }, "ListRecordingConfigurationsResponse":{ "type":"structure", "required":["recordingConfigurations"], "members":{ - "recordingConfigurations":{"shape":"RecordingConfigurationList"}, - "nextToken":{"shape":"PaginationToken"} + "nextToken":{"shape":"PaginationToken"}, + "recordingConfigurations":{"shape":"RecordingConfigurationList"} } }, "ListStreamKeysRequest":{ @@ -1088,16 +1089,16 @@ "required":["channelArn"], "members":{ "channelArn":{"shape":"ChannelArn"}, - "nextToken":{"shape":"PaginationToken"}, - "maxResults":{"shape":"MaxStreamKeyResults"} + "maxResults":{"shape":"MaxStreamKeyResults"}, + "nextToken":{"shape":"PaginationToken"} } }, "ListStreamKeysResponse":{ "type":"structure", "required":["streamKeys"], "members":{ - "streamKeys":{"shape":"StreamKeyList"}, - "nextToken":{"shape":"PaginationToken"} + "nextToken":{"shape":"PaginationToken"}, + "streamKeys":{"shape":"StreamKeyList"} } }, "ListStreamSessionsRequest":{ @@ -1105,32 +1106,32 @@ "required":["channelArn"], "members":{ "channelArn":{"shape":"ChannelArn"}, - "nextToken":{"shape":"PaginationToken"}, - "maxResults":{"shape":"MaxStreamResults"} + "maxResults":{"shape":"MaxStreamResults"}, + "nextToken":{"shape":"PaginationToken"} } }, "ListStreamSessionsResponse":{ "type":"structure", "required":["streamSessions"], "members":{ - "streamSessions":{"shape":"StreamSessionList"}, - "nextToken":{"shape":"PaginationToken"} + "nextToken":{"shape":"PaginationToken"}, + "streamSessions":{"shape":"StreamSessionList"} } }, "ListStreamsRequest":{ "type":"structure", "members":{ "filterBy":{"shape":"StreamFilters"}, - "nextToken":{"shape":"PaginationToken"}, - "maxResults":{"shape":"MaxStreamResults"} + "maxResults":{"shape":"MaxStreamResults"}, + "nextToken":{"shape":"PaginationToken"} } }, "ListStreamsResponse":{ "type":"structure", "required":["streams"], "members":{ - "streams":{"shape":"StreamList"}, - "nextToken":{"shape":"PaginationToken"} + "nextToken":{"shape":"PaginationToken"}, + "streams":{"shape":"StreamList"} } }, "ListTagsForResourceRequest":{ @@ -1191,7 +1192,7 @@ "type":"string", "max":1024, "min":0, - "pattern":"[a-zA-Z0-9+/=_-]*" + "pattern":"^[a-zA-Z0-9+/=_-]*$" }, "PendingVerification":{ "type":"structure", @@ -1208,8 +1209,8 @@ "type":"structure", "members":{ "arn":{"shape":"PlaybackKeyPairArn"}, - "name":{"shape":"PlaybackKeyPairName"}, "fingerprint":{"shape":"PlaybackKeyPairFingerprint"}, + "name":{"shape":"PlaybackKeyPairName"}, "tags":{"shape":"Tags"} } }, @@ -1217,7 +1218,7 @@ "type":"string", "max":128, "min":1, - "pattern":"arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-key/[a-zA-Z0-9-]+" + "pattern":"^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-key/[a-zA-Z0-9-]+$" }, "PlaybackKeyPairFingerprint":{"type":"string"}, "PlaybackKeyPairList":{ @@ -1228,7 +1229,7 @@ "type":"string", "max":128, "min":0, - "pattern":"[a-zA-Z0-9-_]*" + "pattern":"^[a-zA-Z0-9-_]*$" }, "PlaybackKeyPairSummary":{ "type":"structure", @@ -1242,14 +1243,14 @@ "PlaybackRestrictionPolicy":{ "type":"structure", "required":[ - "arn", "allowedCountries", - "allowedOrigins" + "allowedOrigins", + "arn" ], "members":{ - "arn":{"shape":"PlaybackRestrictionPolicyArn"}, "allowedCountries":{"shape":"PlaybackRestrictionPolicyAllowedCountryList"}, "allowedOrigins":{"shape":"PlaybackRestrictionPolicyAllowedOriginList"}, + "arn":{"shape":"PlaybackRestrictionPolicyArn"}, "enableStrictOriginEnforcement":{"shape":"PlaybackRestrictionPolicyEnableStrictOriginEnforcement"}, "name":{"shape":"PlaybackRestrictionPolicyName"}, "tags":{"shape":"Tags"} @@ -1277,7 +1278,7 @@ "type":"string", "max":128, "min":1, - "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-]+$" }, "PlaybackRestrictionPolicyEnableStrictOriginEnforcement":{ "type":"boolean", @@ -1291,19 +1292,19 @@ "type":"string", "max":128, "min":0, - "pattern":"[a-zA-Z0-9-_]*" + "pattern":"^[a-zA-Z0-9-_]*$" }, "PlaybackRestrictionPolicySummary":{ "type":"structure", "required":[ - "arn", "allowedCountries", - "allowedOrigins" + "allowedOrigins", + "arn" ], "members":{ - "arn":{"shape":"PlaybackRestrictionPolicyArn"}, "allowedCountries":{"shape":"PlaybackRestrictionPolicyAllowedCountryList"}, "allowedOrigins":{"shape":"PlaybackRestrictionPolicyAllowedOriginList"}, + "arn":{"shape":"PlaybackRestrictionPolicyArn"}, "enableStrictOriginEnforcement":{"shape":"PlaybackRestrictionPolicyEnableStrictOriginEnforcement"}, "name":{"shape":"PlaybackRestrictionPolicyName"}, "tags":{"shape":"Tags"} @@ -1330,20 +1331,20 @@ ], "members":{ "arn":{"shape":"RecordingConfigurationArn"}, - "name":{"shape":"RecordingConfigurationName"}, "destinationConfiguration":{"shape":"DestinationConfiguration"}, + "name":{"shape":"RecordingConfigurationName"}, + "recordingReconnectWindowSeconds":{"shape":"RecordingReconnectWindowSeconds"}, + "renditionConfiguration":{"shape":"RenditionConfiguration"}, "state":{"shape":"RecordingConfigurationState"}, "tags":{"shape":"Tags"}, - "thumbnailConfiguration":{"shape":"ThumbnailConfiguration"}, - "recordingReconnectWindowSeconds":{"shape":"RecordingReconnectWindowSeconds"}, - "renditionConfiguration":{"shape":"RenditionConfiguration"} + "thumbnailConfiguration":{"shape":"ThumbnailConfiguration"} } }, "RecordingConfigurationArn":{ "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", @@ -1353,7 +1354,7 @@ "type":"string", "max":128, "min":0, - "pattern":"[a-zA-Z0-9-_]*" + "pattern":"^[a-zA-Z0-9-_]*$" }, "RecordingConfigurationState":{ "type":"string", @@ -1372,8 +1373,8 @@ ], "members":{ "arn":{"shape":"RecordingConfigurationArn"}, - "name":{"shape":"RecordingConfigurationName"}, "destinationConfiguration":{"shape":"DestinationConfiguration"}, + "name":{"shape":"RecordingConfigurationName"}, "state":{"shape":"RecordingConfigurationState"}, "tags":{"shape":"Tags"} } @@ -1422,7 +1423,7 @@ "type":"string", "max":128, "min":1, - "pattern":"arn:aws:ivs:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+" + "pattern":"^arn:aws:ivs:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+$" }, "ResourceNotFoundException":{ "type":"structure", @@ -1439,7 +1440,7 @@ "type":"string", "max":63, "min":3, - "pattern":"[a-z0-9-.]+" + "pattern":"^[a-z0-9-.]+$" }, "S3DestinationConfiguration":{ "type":"structure", @@ -1504,20 +1505,21 @@ "type":"structure", "members":{ "channelArn":{"shape":"ChannelArn"}, - "streamId":{"shape":"StreamId"}, + "health":{"shape":"StreamHealth"}, "playbackUrl":{"shape":"PlaybackURL"}, "startTime":{"shape":"StreamStartTime"}, "state":{"shape":"StreamState"}, - "health":{"shape":"StreamHealth"}, + "streamId":{"shape":"StreamId"}, "viewerCount":{"shape":"StreamViewerCount"} } }, "StreamEvent":{ "type":"structure", "members":{ + "code":{"shape":"String"}, + "eventTime":{"shape":"Time"}, "name":{"shape":"String"}, - "type":{"shape":"String"}, - "eventTime":{"shape":"Time"} + "type":{"shape":"String"} } }, "StreamEvents":{ @@ -1544,22 +1546,22 @@ "type":"string", "max":26, "min":26, - "pattern":"st-[a-zA-Z0-9]+" + "pattern":"^st-[a-zA-Z0-9]+$" }, "StreamKey":{ "type":"structure", "members":{ "arn":{"shape":"StreamKeyArn"}, - "value":{"shape":"StreamKeyValue"}, "channelArn":{"shape":"ChannelArn"}, - "tags":{"shape":"Tags"} + "tags":{"shape":"Tags"}, + "value":{"shape":"StreamKeyValue"} } }, "StreamKeyArn":{ "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", @@ -1599,12 +1601,12 @@ "StreamSession":{ "type":"structure", "members":{ - "streamId":{"shape":"StreamId"}, - "startTime":{"shape":"Time"}, - "endTime":{"shape":"Time"}, "channel":{"shape":"Channel"}, + "endTime":{"shape":"Time"}, "ingestConfiguration":{"shape":"IngestConfiguration"}, "recordingConfiguration":{"shape":"RecordingConfiguration"}, + "startTime":{"shape":"Time"}, + "streamId":{"shape":"StreamId"}, "truncatedEvents":{"shape":"StreamEvents"} } }, @@ -1615,10 +1617,10 @@ "StreamSessionSummary":{ "type":"structure", "members":{ - "streamId":{"shape":"StreamId"}, - "startTime":{"shape":"Time"}, "endTime":{"shape":"Time"}, - "hasErrorEvent":{"shape":"Boolean"} + "hasErrorEvent":{"shape":"Boolean"}, + "startTime":{"shape":"Time"}, + "streamId":{"shape":"StreamId"} } }, "StreamStartTime":{ @@ -1636,11 +1638,11 @@ "type":"structure", "members":{ "channelArn":{"shape":"ChannelArn"}, - "streamId":{"shape":"StreamId"}, - "state":{"shape":"StreamState"}, "health":{"shape":"StreamHealth"}, - "viewerCount":{"shape":"StreamViewerCount"}, - "startTime":{"shape":"StreamStartTime"} + "startTime":{"shape":"StreamStartTime"}, + "state":{"shape":"StreamState"}, + "streamId":{"shape":"StreamId"}, + "viewerCount":{"shape":"StreamViewerCount"} } }, "StreamUnavailable":{ @@ -1718,9 +1720,9 @@ "type":"structure", "members":{ "recordingMode":{"shape":"RecordingMode"}, - "targetIntervalSeconds":{"shape":"TargetIntervalSeconds"}, "resolution":{"shape":"ThumbnailConfigurationResolution"}, - "storage":{"shape":"ThumbnailConfigurationStorageList"} + "storage":{"shape":"ThumbnailConfigurationStorageList"}, + "targetIntervalSeconds":{"shape":"TargetIntervalSeconds"} } }, "ThumbnailConfigurationResolution":{ @@ -1783,14 +1785,14 @@ "required":["arn"], "members":{ "arn":{"shape":"ChannelArn"}, - "name":{"shape":"ChannelName"}, - "latencyMode":{"shape":"ChannelLatencyMode"}, - "type":{"shape":"ChannelType"}, "authorized":{"shape":"Boolean"}, - "recordingConfigurationArn":{"shape":"ChannelRecordingConfigurationArn"}, "insecureIngest":{"shape":"Boolean"}, + "latencyMode":{"shape":"ChannelLatencyMode"}, + "name":{"shape":"ChannelName"}, + "playbackRestrictionPolicyArn":{"shape":"ChannelPlaybackRestrictionPolicyArn"}, "preset":{"shape":"TranscodePreset"}, - "playbackRestrictionPolicyArn":{"shape":"ChannelPlaybackRestrictionPolicyArn"} + "recordingConfigurationArn":{"shape":"ChannelRecordingConfigurationArn"}, + "type":{"shape":"ChannelType"} } }, "UpdateChannelResponse":{ @@ -1803,9 +1805,9 @@ "type":"structure", "required":["arn"], "members":{ - "arn":{"shape":"PlaybackRestrictionPolicyArn"}, "allowedCountries":{"shape":"PlaybackRestrictionPolicyAllowedCountryList"}, "allowedOrigins":{"shape":"PlaybackRestrictionPolicyAllowedOriginList"}, + "arn":{"shape":"PlaybackRestrictionPolicyArn"}, "enableStrictOriginEnforcement":{"shape":"PlaybackRestrictionPolicyEnableStrictOriginEnforcement"}, "name":{"shape":"PlaybackRestrictionPolicyName"} } @@ -1830,8 +1832,8 @@ "VideoConfiguration":{ "type":"structure", "members":{ - "avcProfile":{"shape":"String"}, "avcLevel":{"shape":"String"}, + "avcProfile":{"shape":"String"}, "codec":{"shape":"String"}, "encoder":{"shape":"String"}, "targetBitrate":{"shape":"Integer"}, diff --git a/apis/ivs/2020-07-14/docs-2.json b/apis/ivs/2020-07-14/docs-2.json index 474e0a473e9..d9dde6082b0 100644 --- a/apis/ivs/2020-07-14/docs-2.json +++ b/apis/ivs/2020-07-14/docs-2.json @@ -424,9 +424,9 @@ "Integer": { "base": null, "refs": { - "AudioConfiguration$targetBitrate": "

The expected ingest bitrate (bits per second). This is configured in the encoder.

", - "AudioConfiguration$sampleRate": "

Number of audio samples recorded per second.

", "AudioConfiguration$channels": "

Number of audio channels.

", + "AudioConfiguration$sampleRate": "

Number of audio samples recorded per second.

", + "AudioConfiguration$targetBitrate": "

The expected ingest bitrate (bits per second). This is configured in the encoder.

", "VideoConfiguration$targetBitrate": "

The expected ingest bitrate (bits per second). This is configured in the encoder.

", "VideoConfiguration$targetFramerate": "

The expected ingest framerate. This is configured in the encoder.

", "VideoConfiguration$videoHeight": "

Video-resolution height in pixels.

", @@ -1032,10 +1032,11 @@ "base": null, "refs": { "AudioConfiguration$codec": "

Codec used for the audio encoding.

", + "StreamEvent$code": "

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:

", "StreamEvent$name": "

Name that identifies the stream event within a type.

", "StreamEvent$type": "

Logical group for certain events.

", - "VideoConfiguration$avcProfile": "

Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.

", "VideoConfiguration$avcLevel": "

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.

", + "VideoConfiguration$avcProfile": "

Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.

", "VideoConfiguration$codec": "

Codec used for the video encoding.

", "VideoConfiguration$encoder": "

Software or hardware used to encode the video.

" } @@ -1131,10 +1132,10 @@ "base": null, "refs": { "StreamEvent$eventTime": "

Time when the event occurred. This is an ISO 8601 timestamp; note that this is returned as a string.

", - "StreamSession$startTime": "

Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.

", "StreamSession$endTime": "

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.

", - "StreamSessionSummary$startTime": "

Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.

", - "StreamSessionSummary$endTime": "

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.

" + "StreamSession$startTime": "

Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.

", + "StreamSessionSummary$endTime": "

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.

", + "StreamSessionSummary$startTime": "

Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.

" } }, "TranscodePreset": { diff --git a/apis/qbusiness/2023-11-27/api-2.json b/apis/qbusiness/2023-11-27/api-2.json index f37716ce974..94fcf2675d1 100644 --- a/apis/qbusiness/2023-11-27/api-2.json +++ b/apis/qbusiness/2023-11-27/api-2.json @@ -1951,6 +1951,7 @@ "subtitle":{"shape":"WebExperienceSubtitle"}, "welcomeMessage":{"shape":"WebExperienceWelcomeMessage"}, "samplePromptsControlMode":{"shape":"WebExperienceSamplePromptsControlMode"}, + "origins":{"shape":"WebExperienceOrigins"}, "roleArn":{"shape":"RoleArn"}, "tags":{"shape":"Tags"}, "clientToken":{ @@ -2973,6 +2974,7 @@ "subtitle":{"shape":"WebExperienceSubtitle"}, "welcomeMessage":{"shape":"WebExperienceWelcomeMessage"}, "samplePromptsControlMode":{"shape":"WebExperienceSamplePromptsControlMode"}, + "origins":{"shape":"WebExperienceOrigins"}, "roleArn":{"shape":"RoleArn"}, "identityProviderConfiguration":{"shape":"IdentityProviderConfiguration"}, "authenticationConfiguration":{ @@ -3885,6 +3887,12 @@ "secretsRole":{"shape":"RoleArn"} } }, + "Origin":{ + "type":"string", + "max":256, + "min":1, + "pattern":"(http://|https://)[a-zA-Z0-9-_.]+(?::[0-9]{1,5})?" + }, "Payload":{ "type":"string", "sensitive":true @@ -4865,7 +4873,8 @@ "subtitle":{"shape":"WebExperienceSubtitle"}, "welcomeMessage":{"shape":"WebExperienceWelcomeMessage"}, "samplePromptsControlMode":{"shape":"WebExperienceSamplePromptsControlMode"}, - "identityProviderConfiguration":{"shape":"IdentityProviderConfiguration"} + "identityProviderConfiguration":{"shape":"IdentityProviderConfiguration"}, + "origins":{"shape":"WebExperienceOrigins"} } }, "UpdateWebExperienceResponse":{ @@ -4987,6 +4996,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/apis/qbusiness/2023-11-27/docs-2.json b/apis/qbusiness/2023-11-27/docs-2.json index 3f059861ccc..9eba1c5f22e 100644 --- a/apis/qbusiness/2023-11-27/docs-2.json +++ b/apis/qbusiness/2023-11-27/docs-2.json @@ -1992,6 +1992,12 @@ "IdentityProviderConfiguration$openIDConnectConfiguration": null } }, + "Origin": { + "base": null, + "refs": { + "WebExperienceOrigins$member": null + } + }, "Payload": { "base": null, "refs": { @@ -2142,7 +2148,7 @@ } }, "QAppsConfiguration": { - "base": "

Configuration information about Amazon Q Apps. (preview feature)

", + "base": "

Configuration information about Amazon Q Apps.

", "refs": { "CreateApplicationRequest$qAppsConfiguration": "

An option to allow end users to create and use Amazon Q Apps in the web experience.

", "GetApplicationResponse$qAppsConfiguration": "

Settings for whether end users can create and use Amazon Q Apps in the web experience.

", @@ -2241,7 +2247,7 @@ "refs": { "BasicAuthConfiguration$roleArn": "

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

", "BatchPutDocumentRequest$roleArn": "

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.

", - "CreateApplicationRequest$roleArn": "

The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.

", + "CreateApplicationRequest$roleArn": "

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.

", "CreateDataSourceRequest$roleArn": "

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

", "CreateRetrieverRequest$roleArn": "

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

", "CreateWebExperienceRequest$roleArn": "

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.

", @@ -2790,9 +2796,9 @@ "UserGroups": { "base": null, "refs": { - "ChatInput$userGroups": "

The groups that a user associated with the chat input belongs to.

", - "ChatSyncInput$userGroups": "

The groups that a user associated with the chat input belongs to.

", - "UsersAndGroups$userGroups": "

The user groups associated with a topic control rule.

" + "ChatInput$userGroups": "

The group names that a user associated with the chat input belongs to.

", + "ChatSyncInput$userGroups": "

The group names that a user associated with the chat input belongs to.

", + "UsersAndGroups$userGroups": "

The user group names associated with a topic control rule.

" } }, "UserId": { @@ -2821,7 +2827,7 @@ } }, "UsersAndGroups": { - "base": "

Provides information about users and groups associated with a topic control rule.

", + "base": "

Provides information about users and group names associated with a topic control rule.

", "refs": { "Rule$includedUsersAndGroups": "

Users and groups to be included in a rule.

", "Rule$excludedUsersAndGroups": "

Users and groups to be excluded from a rule.

" @@ -2881,6 +2887,14 @@ "WebExperience$webExperienceId": "

The identifier of your Amazon Q Business web experience.

" } }, + "WebExperienceOrigins": { + "base": null, + "refs": { + "CreateWebExperienceRequest$origins": "

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>
", + "GetWebExperienceResponse$origins": "

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>
", + "UpdateWebExperienceRequest$origins": "

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>
" + } + }, "WebExperienceSamplePromptsControlMode": { "base": null, "refs": { diff --git a/apis/redshift/2012-12-01/api-2.json b/apis/redshift/2012-12-01/api-2.json index 72b539e907d..8a81146f394 100644 --- a/apis/redshift/2012-12-01/api-2.json +++ b/apis/redshift/2012-12-01/api-2.json @@ -448,6 +448,29 @@ {"shape":"InvalidTagFault"} ] }, + "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"} + ] + }, "CreateRedshiftIdcApplication":{ "name":"CreateRedshiftIdcApplication", "http":{ @@ -736,6 +759,24 @@ {"shape":"HsmConfigurationNotFoundFault"} ] }, + "DeleteIntegration":{ + "name":"DeleteIntegration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteIntegrationMessage"}, + "output":{ + "shape":"Integration", + "resultWrapper":"DeleteIntegrationResult" + }, + "errors":[ + {"shape":"IntegrationNotFoundFault"}, + {"shape":"IntegrationConflictStateFault"}, + {"shape":"IntegrationConflictOperationFault"}, + {"shape":"UnsupportedOperationFault"} + ] + }, "DeletePartner":{ "name":"DeletePartner", "http":{ @@ -1204,6 +1245,22 @@ {"shape":"UnsupportedOperationFault"} ] }, + "DescribeIntegrations":{ + "name":"DescribeIntegrations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeIntegrationsMessage"}, + "output":{ + "shape":"IntegrationsMessage", + "resultWrapper":"DescribeIntegrationsResult" + }, + "errors":[ + {"shape":"IntegrationNotFoundFault"}, + {"shape":"UnsupportedOperationFault"} + ] + }, "DescribeLoggingStatus":{ "name":"DescribeLoggingStatus", "http":{ @@ -1926,6 +1983,25 @@ {"shape":"InvalidSubscriptionStateFault"} ] }, + "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"} + ] + }, "ModifyRedshiftIdcApplication":{ "name":"ModifyRedshiftIdcApplication", "http":{ @@ -3549,6 +3625,23 @@ "HsmConfiguration":{"shape":"HsmConfiguration"} } }, + "CreateIntegrationMessage":{ + "type":"structure", + "required":[ + "SourceArn", + "TargetArn", + "IntegrationName" + ], + "members":{ + "SourceArn":{"shape":"String"}, + "TargetArn":{"shape":"String"}, + "IntegrationName":{"shape":"IntegrationName"}, + "KMSKeyId":{"shape":"String"}, + "TagList":{"shape":"TagList"}, + "AdditionalEncryptionContext":{"shape":"EncryptionContextMap"}, + "Description":{"shape":"IntegrationDescription"} + } + }, "CreateRedshiftIdcApplicationMessage":{ "type":"structure", "required":[ @@ -3916,6 +4009,13 @@ "HsmConfigurationIdentifier":{"shape":"String"} } }, + "DeleteIntegrationMessage":{ + "type":"structure", + "required":["IntegrationArn"], + "members":{ + "IntegrationArn":{"shape":"IntegrationArn"} + } + }, "DeleteRedshiftIdcApplicationMessage":{ "type":"structure", "required":["RedshiftIdcApplicationArn"], @@ -4262,6 +4362,49 @@ "Marker":{"shape":"String"} } }, + "DescribeIntegrationsFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{"shape":"DescribeIntegrationsFilterName"}, + "Values":{"shape":"DescribeIntegrationsFilterValueList"} + } + }, + "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"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"}, + "Filters":{"shape":"DescribeIntegrationsFilterList"} + } + }, "DescribeLoggingStatusMessage":{ "type":"structure", "required":["ClusterIdentifier"], @@ -4441,6 +4584,12 @@ "TagValues":{"shape":"TagValueList"} } }, + "Description":{ + "type":"string", + "max":1000, + "min":1, + "pattern":"^.*$" + }, "DisableLoggingMessage":{ "type":"structure", "required":["ClusterIdentifier"], @@ -4534,6 +4683,11 @@ "Cluster":{"shape":"Cluster"} } }, + "EncryptionContextMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, "Endpoint":{ "type":"structure", "members":{ @@ -5112,6 +5266,67 @@ }, "Integer":{"type":"integer"}, "IntegerOptional":{"type":"integer"}, + "Integration":{ + "type":"structure", + "members":{ + "IntegrationArn":{"shape":"String"}, + "IntegrationName":{"shape":"IntegrationName"}, + "SourceArn":{"shape":"String"}, + "TargetArn":{"shape":"String"}, + "Status":{"shape":"ZeroETLIntegrationStatus"}, + "Errors":{"shape":"IntegrationErrorList"}, + "CreateTime":{"shape":"TStamp"}, + "Description":{"shape":"Description"}, + "KMSKeyId":{"shape":"String"}, + "AdditionalEncryptionContext":{"shape":"EncryptionContextMap"}, + "Tags":{"shape":"TagList"} + } + }, + "IntegrationAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "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":{ + }, + "error":{ + "code":"IntegrationConflictOperationFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "IntegrationConflictStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"IntegrationConflictStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "IntegrationDescription":{ + "type":"string", + "max":1000, + "min":0, + "pattern":"^.*$" + }, "IntegrationError":{ "type":"structure", "required":["ErrorCode"], @@ -5127,6 +5342,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":{ @@ -5138,6 +5366,46 @@ }, "exception":true }, + "IntegrationQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"IntegrationQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "IntegrationSourceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"IntegrationSourceNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "IntegrationTargetNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"IntegrationTargetNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "IntegrationsMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "Integrations":{"shape":"IntegrationList"} + } + }, "InvalidAuthenticationProfileRequestFault":{ "type":"structure", "members":{ @@ -5802,6 +6070,15 @@ "EventSubscription":{"shape":"EventSubscription"} } }, + "ModifyIntegrationMessage":{ + "type":"structure", + "required":["IntegrationArn"], + "members":{ + "IntegrationArn":{"shape":"IntegrationArn"}, + "Description":{"shape":"IntegrationDescription"}, + "IntegrationName":{"shape":"IntegrationName"} + } + }, "ModifyRedshiftIdcApplicationMessage":{ "type":"structure", "required":["RedshiftIdcApplicationArn"], diff --git a/apis/redshift/2012-12-01/docs-2.json b/apis/redshift/2012-12-01/docs-2.json index 9b3e01ddd87..fa8e09f9293 100644 --- a/apis/redshift/2012-12-01/docs-2.json +++ b/apis/redshift/2012-12-01/docs-2.json @@ -24,6 +24,7 @@ "CreateEventSubscription": "

Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters.

If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your Amazon Web Services account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your Amazon Web Services account. You must specify a source type if you specify a source ID.

", "CreateHsmClientCertificate": "

Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases.

The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.

", "CreateHsmConfiguration": "

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": "

Creates a zero-ETL integration with Amazon Redshift.

", "CreateRedshiftIdcApplication": "

Creates an Amazon Redshift application for use with IAM Identity Center.

", "CreateScheduledAction": "

Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the ResizeCluster API operation.

", "CreateSnapshotCopyGrant": "

Creates a snapshot copy grant that permits Amazon Redshift to use an encrypted symmetric key from Key Management Service (KMS) to encrypt copied snapshots in a destination region.

For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

", @@ -42,6 +43,7 @@ "DeleteEventSubscription": "

Deletes an Amazon Redshift event notification subscription.

", "DeleteHsmClientCertificate": "

Deletes the specified HSM client certificate.

", "DeleteHsmConfiguration": "

Deletes the specified Amazon Redshift HSM configuration.

", + "DeleteIntegration": "

Deletes a zero-ETL integration with Amazon Redshift.

", "DeletePartner": "

Deletes a partner integration from a cluster. Data can still flow to the cluster until the integration is deleted at the partner's website.

", "DeleteRedshiftIdcApplication": "

Deletes an Amazon Redshift IAM Identity Center application.

", "DeleteResourcePolicy": "

Deletes the resource policy for a specified resource.

", @@ -74,6 +76,7 @@ "DescribeHsmClientCertificates": "

Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your Amazon Web Services account.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM client certificates that have any combination of those values are returned.

If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.

", "DescribeHsmConfigurations": "

Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your Amazon Web Services account.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM connections that have any combination of those values are returned.

If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.

", "DescribeInboundIntegrations": "

Returns a list of inbound integrations.

", + "DescribeIntegrations": "

Describes one or more zero-ETL integrations with Amazon Redshift.

", "DescribeLoggingStatus": "

Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.

", "DescribeNodeConfigurationOptions": "

Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.

", "DescribeOrderableClusterOptions": "

Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific Amazon Web Services Region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

", @@ -115,6 +118,7 @@ "ModifyCustomDomainAssociation": "

Contains information for changing a custom domain association.

", "ModifyEndpointAccess": "

Modifies a Redshift-managed VPC endpoint.

", "ModifyEventSubscription": "

Modifies an existing Amazon Redshift event notification subscription.

", + "ModifyIntegration": "

Modifies a zero-ETL integration with Amazon Redshift.

", "ModifyRedshiftIdcApplication": "

Changes an existing Amazon Redshift IAM Identity Center application.

", "ModifyScheduledAction": "

Modifies a scheduled action.

", "ModifySnapshotCopyRetentionPeriod": "

Modifies the number of days to retain snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period.

", @@ -126,7 +130,7 @@ "RebootCluster": "

Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to rebooting. A cluster event is created when the reboot is completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

", "RejectDataShare": "

From a datashare consumer account, rejects the specified datashare.

", "ResetClusterParameterGroup": "

Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to \"engine-default\". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters.

", - "ResizeCluster": "

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:

", + "ResizeCluster": "

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:

", "RestoreFromClusterSnapshot": "

Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore.

If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

", "RestoreTableFromClusterSnapshot": "

Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from.

You cannot use RestoreTableFromClusterSnapshot to restore a table with the same name as an existing table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored table. If you want to replace your original table with a new, restored table, then rename or drop your original table before you call RestoreTableFromClusterSnapshot. When you have renamed your original table, then you can pass the original name of the table as the NewTableName parameter value in the call to RestoreTableFromClusterSnapshot. This way, you can replace the original table with the table created from the snapshot.

You can't use this operation to restore tables with interleaved sort keys.

", "ResumeCluster": "

Resumes a paused cluster.

", @@ -943,6 +947,11 @@ "refs": { } }, + "CreateIntegrationMessage": { + "base": null, + "refs": { + } + }, "CreateRedshiftIdcApplicationMessage": { "base": null, "refs": { @@ -1180,6 +1189,11 @@ "refs": { } }, + "DeleteIntegrationMessage": { + "base": null, + "refs": { + } + }, "DeleteRedshiftIdcApplicationMessage": { "base": null, "refs": { @@ -1375,6 +1389,35 @@ "refs": { } }, + "DescribeIntegrationsFilter": { + "base": "

A set of elements to filter the returned integrations.

", + "refs": { + "DescribeIntegrationsFilterList$member": null + } + }, + "DescribeIntegrationsFilterList": { + "base": null, + "refs": { + "DescribeIntegrationsMessage$Filters": "

A filter that specifies one or more resources to return.

" + } + }, + "DescribeIntegrationsFilterName": { + "base": null, + "refs": { + "DescribeIntegrationsFilter$Name": "

Specifies the type of integration filter.

" + } + }, + "DescribeIntegrationsFilterValueList": { + "base": null, + "refs": { + "DescribeIntegrationsFilter$Values": "

Specifies the values to filter on.

" + } + }, + "DescribeIntegrationsMessage": { + "base": null, + "refs": { + } + }, "DescribeLoggingStatusMessage": { "base": "

", "refs": { @@ -1470,6 +1513,12 @@ "refs": { } }, + "Description": { + "base": null, + "refs": { + "Integration$Description": "

The description of the integration.

" + } + }, "DisableLoggingMessage": { "base": "

", "refs": { @@ -1555,6 +1604,13 @@ "refs": { } }, + "EncryptionContextMap": { + "base": null, + "refs": { + "CreateIntegrationMessage$AdditionalEncryptionContext": "

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.

", + "Integration$AdditionalEncryptionContext": "

The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.

" + } + }, "Endpoint": { "base": "

Describes a connection endpoint.

", "refs": { @@ -1986,6 +2042,7 @@ "DescribeHsmClientCertificatesMessage$MaxRecords": "

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.

", "DescribeHsmConfigurationsMessage$MaxRecords": "

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.

", "DescribeInboundIntegrationsMessage$MaxRecords": "

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.

", + "DescribeIntegrationsMessage$MaxRecords": "

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.

", "DescribeNodeConfigurationOptionsMessage$MaxRecords": "

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: 500

Constraints: minimum 100, maximum 500.

", "DescribeOrderableClusterOptionsMessage$MaxRecords": "

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.

", "DescribeRedshiftIdcApplicationsMessage$MaxRecords": "

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.

", @@ -2025,6 +2082,42 @@ "SnapshotSchedule$AssociatedClusterCount": "

The number of clusters associated with the schedule.

" } }, + "Integration": { + "base": null, + "refs": { + "IntegrationList$member": null + } + }, + "IntegrationAlreadyExistsFault": { + "base": "

The integration you are trying to create already exists.

", + "refs": { + } + }, + "IntegrationArn": { + "base": null, + "refs": { + "DeleteIntegrationMessage$IntegrationArn": "

The unique identifier of the integration to delete.

", + "DescribeIntegrationsMessage$IntegrationArn": "

The unique identifier of the integration.

", + "ModifyIntegrationMessage$IntegrationArn": "

The unique identifier of the integration to modify.

" + } + }, + "IntegrationConflictOperationFault": { + "base": "

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.

", + "refs": { + } + }, + "IntegrationConflictStateFault": { + "base": "

The integration is in an invalid state and can't perform the requested operation.

", + "refs": { + } + }, + "IntegrationDescription": { + "base": null, + "refs": { + "CreateIntegrationMessage$Description": "

A description of the integration.

", + "ModifyIntegrationMessage$Description": "

A new description for the integration.

" + } + }, "IntegrationError": { "base": "

The error of an inbound integration.

", "refs": { @@ -2034,7 +2127,22 @@ "IntegrationErrorList": { "base": null, "refs": { - "InboundIntegration$Errors": "

The outstanding errors of an inbound integration. Each item is an \"IntegrationError\". This is null if there is no error.

" + "InboundIntegration$Errors": "

The outstanding errors of an inbound integration. Each item is an \"IntegrationError\". This is null if there is no error.

", + "Integration$Errors": "

Any errors associated with the integration.

" + } + }, + "IntegrationList": { + "base": null, + "refs": { + "IntegrationsMessage$Integrations": "

List of integrations that are described.

" + } + }, + "IntegrationName": { + "base": null, + "refs": { + "CreateIntegrationMessage$IntegrationName": "

The name of the integration.

", + "Integration$IntegrationName": "

The name of the integration.

", + "ModifyIntegrationMessage$IntegrationName": "

A new name for the integration.

" } }, "IntegrationNotFoundFault": { @@ -2042,6 +2150,26 @@ "refs": { } }, + "IntegrationQuotaExceededFault": { + "base": "

You can't create any more zero-ETL integrations because the quota has been reached.

", + "refs": { + } + }, + "IntegrationSourceNotFoundFault": { + "base": "

The specified integration source can't be found.

", + "refs": { + } + }, + "IntegrationTargetNotFoundFault": { + "base": "

The specified integration target can't be found.

", + "refs": { + } + }, + "IntegrationsMessage": { + "base": null, + "refs": { + } + }, "InvalidAuthenticationProfileRequestFault": { "base": "

The authentication profile request is not valid. The profile name can't be null or empty. The authentication profile API operation must be available in the Amazon Web Services Region.

", "refs": { @@ -2412,6 +2540,11 @@ "refs": { } }, + "ModifyIntegrationMessage": { + "base": null, + "refs": { + } + }, "ModifyRedshiftIdcApplicationMessage": { "base": null, "refs": { @@ -3464,7 +3597,7 @@ "CreateClusterMessage$DBName": "

The name of the first database to be created when the cluster is created.

To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.

Default: dev

Constraints:

", "CreateClusterMessage$ClusterIdentifier": "

A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

Constraints:

Example: myexamplecluster

", "CreateClusterMessage$ClusterType": "

The type of the cluster. When cluster type is specified as

Valid Values: multi-node | single-node

Default: multi-node

", - "CreateClusterMessage$NodeType": "

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

", + "CreateClusterMessage$NodeType": "

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

", "CreateClusterMessage$MasterUsername": "

The user name associated with the admin user account for the cluster that is being created.

Constraints:

", "CreateClusterMessage$ClusterSubnetGroupName": "

The name of a cluster subnet group to be associated with this cluster.

If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

", "CreateClusterMessage$AvailabilityZone": "

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

Example: us-east-2d

Constraint: The specified Availability Zone must be in the same region as the current endpoint.

", @@ -3510,6 +3643,9 @@ "CreateHsmConfigurationMessage$HsmPartitionName": "

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

", "CreateHsmConfigurationMessage$HsmPartitionPassword": "

The password required to access the HSM partition.

", "CreateHsmConfigurationMessage$HsmServerPublicCertificate": "

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

", + "CreateIntegrationMessage$SourceArn": "

The Amazon Resource Name (ARN) of the database to use as the source for replication.

", + "CreateIntegrationMessage$TargetArn": "

The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.

", + "CreateIntegrationMessage$KMSKeyId": "

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.

", "CreateRedshiftIdcApplicationMessage$IdcInstanceArn": "

The Amazon resource name (ARN) of the IAM Identity Center instance where Amazon Redshift creates a new managed application.

", "CreateRedshiftIdcApplicationMessage$IamRoleArn": "

The IAM role ARN for the Amazon Redshift IAM Identity Center application instance. It has the required permissions to be assumed and invoke the IDC Identity Center API.

", "CreateScheduledActionMessage$ScheduledActionName": "

The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see ScheduledAction.

", @@ -3610,6 +3746,8 @@ "DescribeInboundIntegrationsMessage$IntegrationArn": "

The Amazon Resource Name (ARN) of the inbound integration.

", "DescribeInboundIntegrationsMessage$TargetArn": "

The Amazon Resource Name (ARN) of the target of an inbound integration.

", "DescribeInboundIntegrationsMessage$Marker": "

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeInboundIntegrations request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

", + "DescribeIntegrationsFilterValueList$member": null, + "DescribeIntegrationsMessage$Marker": "

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.

", "DescribeLoggingStatusMessage$ClusterIdentifier": "

The identifier of the cluster from which to get the logging status.

Example: examplecluster

", "DescribeNodeConfigurationOptionsMessage$ClusterIdentifier": "

The identifier of the cluster to evaluate for possible node configurations.

", "DescribeNodeConfigurationOptionsMessage$SnapshotIdentifier": "

The identifier of the snapshot to evaluate for possible node configurations.

", @@ -3643,7 +3781,7 @@ "DescribeTableRestoreStatusMessage$TableRestoreRequestId": "

The identifier of the table restore request to return status for. If you don't specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.

", "DescribeTableRestoreStatusMessage$Marker": "

An optional pagination token provided by a previous DescribeTableRestoreStatus request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

", "DescribeTagsMessage$ResourceName": "

The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

", - "DescribeTagsMessage$ResourceType": "

The type of resource with which you want to view tags. Valid resource types are:

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.

", + "DescribeTagsMessage$ResourceType": "

The type of resource with which you want to view tags. Valid resource types are:

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.

", "DescribeTagsMessage$Marker": "

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.

", "DescribeUsageLimitsMessage$UsageLimitId": "

The identifier of the usage limit to describe.

", "DescribeUsageLimitsMessage$ClusterIdentifier": "

The identifier of the cluster for which you want to describe usage limits.

", @@ -3663,6 +3801,8 @@ "EnableSnapshotCopyMessage$ClusterIdentifier": "

The unique identifier of the source cluster to copy snapshots from.

Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.

", "EnableSnapshotCopyMessage$DestinationRegion": "

The destination Amazon Web Services Region that you want to copy snapshots to.

Constraints: Must be the name of a valid Amazon Web Services Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.

", "EnableSnapshotCopyMessage$SnapshotCopyGrantName": "

The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.

", + "EncryptionContextMap$key": null, + "EncryptionContextMap$value": null, "Endpoint$Address": "

The DNS address of the Cluster.

", "EndpointAccess$ClusterIdentifier": "

The cluster identifier of the cluster associated with the endpoint.

", "EndpointAccess$ResourceOwner": "

The Amazon Web Services account ID of the owner of the cluster.

", @@ -3730,8 +3870,13 @@ "InboundIntegration$SourceArn": "

The Amazon Resource Name (ARN) of the source of an inbound integration.

", "InboundIntegration$TargetArn": "

The Amazon Resource Name (ARN) of the target of an inbound integration.

", "InboundIntegrationsMessage$Marker": "

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.

", + "Integration$IntegrationArn": "

The Amazon Resource Name (ARN) of the integration.

", + "Integration$SourceArn": "

The Amazon Resource Name (ARN) of the database used as the source for replication.

", + "Integration$TargetArn": "

The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.

", + "Integration$KMSKeyId": "

The Key Management Service (KMS) key identifier for the key used to encrypt the integration.

", "IntegrationError$ErrorCode": "

The error code of an inbound integration error.

", "IntegrationError$ErrorMessage": "

The error message of an inbound integration error.

", + "IntegrationsMessage$Marker": "

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.

", "ListRecommendationsMessage$ClusterIdentifier": "

The unique identifier of the Amazon Redshift cluster for which the list of Advisor recommendations is returned. If the neither the cluster identifier and the cluster namespace ARN parameters are specified, then recommendations for all clusters in the account are returned.

", "ListRecommendationsMessage$NamespaceArn": "

The Amazon Redshift cluster namespace Amazon Resource Name (ARN) for which the list of Advisor recommendations is returned. If the neither the cluster identifier and the cluster namespace ARN parameters are specified, then recommendations for all clusters in the account are returned.

", "ListRecommendationsMessage$Marker": "

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.

", @@ -3752,7 +3897,7 @@ "ModifyClusterMaintenanceMessage$DeferMaintenanceIdentifier": "

A unique identifier for the deferred maintenance window.

", "ModifyClusterMessage$ClusterIdentifier": "

The unique identifier of the cluster to be modified.

Example: examplecluster

", "ModifyClusterMessage$ClusterType": "

The new cluster type.

When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.

Valid Values: multi-node | single-node

", - "ModifyClusterMessage$NodeType": "

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

", + "ModifyClusterMessage$NodeType": "

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

", "ModifyClusterMessage$ClusterParameterGroupName": "

The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster.

Default: Uses existing setting.

Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.

", "ModifyClusterMessage$PreferredMaintenanceWindow": "

The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage.

This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied.

Default: Uses existing setting.

Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes.

", "ModifyClusterMessage$ClusterVersion": "

The new version number of the Amazon Redshift engine to upgrade to.

For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Example: 1.0

", @@ -4093,6 +4238,7 @@ "Event$Date": "

The date and time of the event.

", "EventSubscription$SubscriptionCreationTime": "

The date and time the Amazon Redshift event notification subscription was created.

", "InboundIntegration$CreateTime": "

The creation time of an inbound integration.

", + "Integration$CreateTime": "

The time (UTC) when the integration was created.

", "LoggingStatus$LastSuccessfulDeliveryTime": "

The last time that logs were delivered.

", "LoggingStatus$LastFailureTime": "

The last time when logs failed to be delivered.

", "ModifyClusterMaintenanceMessage$DeferMaintenanceStartTime": "

A timestamp indicating the start time for the deferred maintenance window.

", @@ -4194,6 +4340,7 @@ "CreateEventSubscriptionMessage$Tags": "

A list of tag instances.

", "CreateHsmClientCertificateMessage$Tags": "

A list of tag instances.

", "CreateHsmConfigurationMessage$Tags": "

A list of tag instances.

", + "CreateIntegrationMessage$TagList": "

A list of tags.

", "CreateSnapshotCopyGrantMessage$Tags": "

A list of tag instances.

", "CreateSnapshotScheduleMessage$Tags": "

An optional set of tags you can use to search for the schedule.

", "CreateTagsMessage$Tags": "

One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter Key and the corresponding value is passed in with the parameter Value. The Key and Value parameters are separated by a comma (,). Separate multiple tags with a space. For example, --tags \"Key\"=\"owner\",\"Value\"=\"admin\" \"Key\"=\"environment\",\"Value\"=\"test\" \"Key\"=\"version\",\"Value\"=\"1.0\".

", @@ -4203,6 +4350,7 @@ "HsmClientCertificate$Tags": "

The list of tags for the HSM client certificate.

", "HsmConfiguration$Tags": "

The list of tags for the HSM configuration.

", "IPRange$Tags": "

The list of tags for the IP range.

", + "Integration$Tags": "

The list of tags associated with the integration.

", "Snapshot$Tags": "

The list of tags for the cluster snapshot.

", "SnapshotCopyGrant$Tags": "

A list of tag instances.

", "SnapshotSchedule$Tags": "

An optional set of tags describing the schedule.

", @@ -4402,7 +4550,8 @@ "ZeroETLIntegrationStatus": { "base": null, "refs": { - "InboundIntegration$Status": "

The status of an inbound integration.

" + "InboundIntegration$Status": "

The status of an inbound integration.

", + "Integration$Status": "

The current status of the integration.

" } } } diff --git a/apis/redshift/2012-12-01/paginators-1.json b/apis/redshift/2012-12-01/paginators-1.json index 8dc4a35f6b6..130a2974744 100644 --- a/apis/redshift/2012-12-01/paginators-1.json +++ b/apis/redshift/2012-12-01/paginators-1.json @@ -126,6 +126,12 @@ "output_token": "Marker", "result_key": "InboundIntegrations" }, + "DescribeIntegrations": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Integrations" + }, "DescribeNodeConfigurationOptions": { "input_token": "Marker", "limit_key": "MaxRecords", diff --git a/apis/resiliencehub/2020-04-30/api-2.json b/apis/resiliencehub/2020-04-30/api-2.json index cbe149daf31..19c47e98623 100644 --- a/apis/resiliencehub/2020-04-30/api-2.json +++ b/apis/resiliencehub/2020-04-30/api-2.json @@ -1205,6 +1205,7 @@ "members":{ "appArn":{"shape":"Arn"}, "assessmentSchedule":{"shape":"AppAssessmentScheduleType"}, + "awsApplicationArn":{"shape":"Arn"}, "complianceStatus":{"shape":"AppComplianceStatusType"}, "creationTime":{"shape":"TimeStamp"}, "description":{"shape":"EntityDescription"}, @@ -1370,6 +1371,7 @@ "members":{ "appArn":{"shape":"Arn"}, "assessmentSchedule":{"shape":"AppAssessmentScheduleType"}, + "awsApplicationArn":{"shape":"Arn"}, "complianceStatus":{"shape":"AppComplianceStatusType"}, "creationTime":{"shape":"TimeStamp"}, "description":{"shape":"EntityDescription"}, @@ -1512,7 +1514,6 @@ "required":[ "entryId", "excluded", - "item", "referenceId" ], "members":{ @@ -1657,6 +1658,7 @@ "required":["name"], "members":{ "assessmentSchedule":{"shape":"AppAssessmentScheduleType"}, + "awsApplicationArn":{"shape":"Arn"}, "clientToken":{ "shape":"ClientToken", "idempotencyToken":true @@ -2145,6 +2147,7 @@ "members":{ "appArn":{"shape":"Arn"}, "appVersion":{"shape":"EntityVersion"}, + "errorDetails":{"shape":"ErrorDetailList"}, "errorMessage":{"shape":"String500"}, "status":{"shape":"ResourceImportStatusType"}, "statusChangeTime":{"shape":"TimeStamp"} @@ -2309,6 +2312,16 @@ "type":"string", "pattern":"^\\S{1,50}$" }, + "ErrorDetail":{ + "type":"structure", + "members":{ + "errorMessage":{"shape":"ErrorMessage"} + } + }, + "ErrorDetailList":{ + "type":"list", + "member":{"shape":"ErrorDetail"} + }, "ErrorMessage":{ "type":"string", "max":500, @@ -2792,6 +2805,11 @@ "location":"querystring", "locationName":"appArn" }, + "awsApplicationArn":{ + "shape":"Arn", + "location":"querystring", + "locationName":"awsApplicationArn" + }, "fromLastAssessmentTime":{ "shape":"TimeStamp", "location":"querystring", @@ -3965,7 +3983,6 @@ "required":[ "entryId", "excluded", - "item", "referenceId" ], "members":{ diff --git a/apis/resiliencehub/2020-04-30/docs-2.json b/apis/resiliencehub/2020-04-30/docs-2.json index 09aa050fd48..592cf05b60c 100644 --- a/apis/resiliencehub/2020-04-30/docs-2.json +++ b/apis/resiliencehub/2020-04-30/docs-2.json @@ -29,7 +29,7 @@ "DescribeResourceGroupingRecommendationTask": "

Describes the resource grouping recommendation tasks run by Resilience Hub for your application.

", "ImportResourcesToDraftAppVersion": "

Imports resources to Resilience Hub application draft version from different input sources. For more information about the input sources supported by Resilience Hub, see Discover the structure and describe your Resilience Hub application.

", "ListAlarmRecommendations": "

Lists the alarm recommendations for an Resilience Hub application.

", - "ListAppAssessmentComplianceDrifts": "

List of compliance drifts that were detected while running an assessment.

", + "ListAppAssessmentComplianceDrifts": "

Indicates the list of compliance drifts that were detected while running an assessment.

", "ListAppAssessmentResourceDrifts": "

Indicates the list of resource drifts that were detected while running an assessment.

", "ListAppAssessments": "

Lists the assessments for an Resilience Hub application. You can use request parameters to refine the results for the response object.

", "ListAppComponentCompliances": "

Lists the compliances for an Resilience Hub Application Component.

", @@ -286,6 +286,7 @@ "AddDraftAppVersionResourceMappingsRequest$appArn": "

Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

", "AddDraftAppVersionResourceMappingsResponse$appArn": "

Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

", "App$appArn": "

Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

", + "App$awsApplicationArn": "

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.

", "App$policyArn": "

Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

", "AppAssessment$appArn": "

Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

", "AppAssessment$assessmentArn": "

Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

", @@ -293,9 +294,11 @@ "AppAssessmentSummary$assessmentArn": "

Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

", "AppInputSource$sourceArn": "

The Amazon Resource Name (ARN) of the input source. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

", "AppSummary$appArn": "

Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

", + "AppSummary$awsApplicationArn": "

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.

", "ArnList$member": null, "BatchUpdateRecommendationStatusRequest$appArn": "

Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

", "BatchUpdateRecommendationStatusResponse$appArn": "

Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

", + "CreateAppRequest$awsApplicationArn": "

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.

", "CreateAppRequest$policyArn": "

Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

", "CreateAppVersionAppComponentRequest$appArn": "

Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

", "CreateAppVersionAppComponentResponse$appArn": "

Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

", @@ -351,6 +354,7 @@ "ListAppVersionResourcesRequest$appArn": "

Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

", "ListAppVersionsRequest$appArn": "

Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

", "ListAppsRequest$appArn": "

Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

", + "ListAppsRequest$awsApplicationArn": "

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.

", "ListRecommendationTemplatesRequest$assessmentArn": "

Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

", "ListRecommendationTemplatesRequest$recommendationTemplateArn": "

The Amazon Resource Name (ARN) for a recommendation template.

", "ListResourceGroupingRecommendationsRequest$appArn": "

Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

", @@ -444,7 +448,7 @@ "AssessmentSummary": { "base": "

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.

", "refs": { - "AppAssessment$summary": "

Indicates a concise summary that provides an overview of the Resilience Hub assessment.

" + "AppAssessment$summary": "

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.

" } }, "AwsRegion": { @@ -1081,10 +1085,23 @@ "UpdateAppVersionResponse$appVersion": "

Resilience Hub application version.

" } }, + "ErrorDetail": { + "base": "

Indicates the error that was encountered while importing a resource.

", + "refs": { + "ErrorDetailList$member": null + } + }, + "ErrorDetailList": { + "base": null, + "refs": { + "DescribeDraftAppVersionResourcesImportStatusResponse$errorDetails": "

List of errors that were encountered while importing resources.

" + } + }, "ErrorMessage": { "base": null, "refs": { "BatchUpdateRecommendationStatusFailedEntry$errorMessage": "

Indicates the error that occurred while excluding an operational recommendation.

", + "ErrorDetail$errorMessage": "

Provides additional information about the error.

", "FailedGroupingRecommendationEntry$errorMessage": "

Indicates the error that occurred while implementing a grouping recommendation.

", "ResourceError$reason": "

This is the error message.

" } @@ -2083,7 +2100,7 @@ "AssessmentSummary$summary": "

Indicates a concise summary that provides an overview of the Resilience Hub assessment.

This property is available only in the US East (N. Virginia) Region.

", "ConflictException$message": null, "DescribeAppVersionResourcesResolutionStatusResponse$errorMessage": "

The returned error message for the request.

", - "DescribeDraftAppVersionResourcesImportStatusResponse$errorMessage": "

The returned error message for the request.

", + "DescribeDraftAppVersionResourcesImportStatusResponse$errorMessage": "

The error message returned for the resource request.

", "DescribeResourceGroupingRecommendationTaskResponse$errorMessage": "

Indicates the error that occurred while generating a grouping recommendation.

", "DisruptionCompliance$message": "

The disruption compliance message.

", "DisruptionCompliance$rpoDescription": "

The RPO description.

", diff --git a/apis/sesv2/2019-09-27/api-2.json b/apis/sesv2/2019-09-27/api-2.json index 938ad1fefc0..98b12bc28d6 100644 --- a/apis/sesv2/2019-09-27/api-2.json +++ b/apis/sesv2/2019-09-27/api-2.json @@ -2199,7 +2199,8 @@ "type":"structure", "members":{ "TlsPolicy":{"shape":"TlsPolicy"}, - "SendingPoolName":{"shape":"PoolName"} + "SendingPoolName":{"shape":"PoolName"}, + "MaxDeliverySeconds":{"shape":"MaxDeliverySeconds"} } }, "Description":{"type":"string"}, @@ -3636,6 +3637,11 @@ ] }, "Max24HourSend":{"type":"double"}, + "MaxDeliverySeconds":{ + "type":"long", + "max":50400, + "min":300 + }, "MaxItems":{"type":"integer"}, "MaxSendRate":{"type":"double"}, "Message":{ @@ -3949,7 +3955,8 @@ "locationName":"ConfigurationSetName" }, "TlsPolicy":{"shape":"TlsPolicy"}, - "SendingPoolName":{"shape":"SendingPoolName"} + "SendingPoolName":{"shape":"SendingPoolName"}, + "MaxDeliverySeconds":{"shape":"MaxDeliverySeconds"} } }, "PutConfigurationSetDeliveryOptionsResponse":{ diff --git a/apis/sesv2/2019-09-27/docs-2.json b/apis/sesv2/2019-09-27/docs-2.json index deb36a4a96f..f76d1999056 100644 --- a/apis/sesv2/2019-09-27/docs-2.json +++ b/apis/sesv2/2019-09-27/docs-2.json @@ -2001,6 +2001,13 @@ "SendQuota$Max24HourSend": "

The maximum number of emails that you can send in the current Amazon Web Services Region over a 24-hour period. A value of -1 signifies an unlimited quota. (This value is also referred to as your sending quota.)

" } }, + "MaxDeliverySeconds": { + "base": null, + "refs": { + "DeliveryOptions$MaxDeliverySeconds": "

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).

", + "PutConfigurationSetDeliveryOptionsRequest$MaxDeliverySeconds": "

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).

" + } + }, "MaxItems": { "base": null, "refs": { diff --git a/apis/transcribe-streaming/2017-10-26/api-2.json b/apis/transcribe-streaming/2017-10-26/api-2.json index 9893c2ec953..cd7a9607d6f 100755 --- a/apis/transcribe-streaming/2017-10-26/api-2.json +++ b/apis/transcribe-streaming/2017-10-26/api-2.json @@ -306,8 +306,48 @@ "ja-JP", "ko-KR", "zh-CN", + "th-TH", + "es-ES", + "ar-SA", + "pt-PT", + "ca-ES", + "ar-AE", "hi-IN", - "th-TH" + "zh-HK", + "nl-NL", + "no-NO", + "sv-SE", + "pl-PL", + "fi-FI", + "zh-TW", + "en-IN", + "en-IE", + "en-NZ", + "en-AB", + "en-ZA", + "en-WL", + "de-CH", + "af-ZA", + "eu-ES", + "hr-HR", + "cs-CZ", + "da-DK", + "fa-IR", + "gl-ES", + "el-GR", + "he-IL", + "id-ID", + "lv-LV", + "ms-MY", + "ro-RO", + "ru-RU", + "sr-RS", + "sk-SK", + "so-SO", + "tl-PH", + "uk-UA", + "vi-VN", + "zu-ZA" ] }, "LanguageIdentification":{ diff --git a/apis/transcribe-streaming/2017-10-26/docs-2.json b/apis/transcribe-streaming/2017-10-26/docs-2.json index 202abd956cd..b887cbfaa59 100755 --- a/apis/transcribe-streaming/2017-10-26/docs-2.json +++ b/apis/transcribe-streaming/2017-10-26/docs-2.json @@ -34,13 +34,13 @@ "AudioStream": { "base": "

An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.

For more information, see Transcribing streaming audio.

", "refs": { - "StartCallAnalyticsStreamTranscriptionRequest$AudioStream": null, + "StartCallAnalyticsStreamTranscriptionRequest$AudioStream": "

An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.

For more information, see Transcribing streaming audio.

", "StartMedicalStreamTranscriptionRequest$AudioStream": null, "StartStreamTranscriptionRequest$AudioStream": "

An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.

For more information, see Transcribing streaming audio.

" } }, "BadRequestException": { - "base": "

One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used not valid values. Check the specified parameters and try your request again.

", + "base": "

One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used unsupported values. Check the specified parameters and try your request again.

", "refs": { "CallAnalyticsTranscriptResultStream$BadRequestException": null, "MedicalTranscriptResultStream$BadRequestException": null, @@ -57,14 +57,14 @@ "StartCallAnalyticsStreamTranscriptionRequest$EnablePartialResultsStabilization": "

Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy. For more information, see Partial-result stabilization.

", "StartCallAnalyticsStreamTranscriptionResponse$EnablePartialResultsStabilization": "

Shows whether partial results stabilization was enabled for your Call Analytics transcription.

", "StartMedicalStreamTranscriptionRequest$ShowSpeakerLabel": "

Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.

For more information, see Partitioning speakers (diarization).

", - "StartMedicalStreamTranscriptionRequest$EnableChannelIdentification": "

Enables channel identification in multi-channel audio.

Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript is not separated by channel.

For more information, see Transcribing multi-channel audio.

", + "StartMedicalStreamTranscriptionRequest$EnableChannelIdentification": "

Enables channel identification in multi-channel audio.

Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript is not separated by channel.

If you include EnableChannelIdentification in your request, you must also include NumberOfChannels.

For more information, see Transcribing multi-channel audio.

", "StartMedicalStreamTranscriptionResponse$ShowSpeakerLabel": "

Shows whether speaker partitioning was enabled for your transcription.

", "StartMedicalStreamTranscriptionResponse$EnableChannelIdentification": "

Shows whether channel identification was enabled for your transcription.

", "StartStreamTranscriptionRequest$ShowSpeakerLabel": "

Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.

For more information, see Partitioning speakers (diarization).

", - "StartStreamTranscriptionRequest$EnableChannelIdentification": "

Enables channel identification in multi-channel audio.

Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript is not separated by channel.

For more information, see Transcribing multi-channel audio.

", + "StartStreamTranscriptionRequest$EnableChannelIdentification": "

Enables channel identification in multi-channel audio.

Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript is not separated by channel.

If you include EnableChannelIdentification in your request, you must also include NumberOfChannels.

For more information, see Transcribing multi-channel audio.

", "StartStreamTranscriptionRequest$EnablePartialResultsStabilization": "

Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy. For more information, see Partial-result stabilization.

", - "StartStreamTranscriptionRequest$IdentifyLanguage": "

Enables automatic language identification for your transcription.

If you include IdentifyLanguage, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your audio stream. Including language options can improve transcription accuracy.

You can also include a preferred language using PreferredLanguage. Adding a preferred language can help Amazon Transcribe identify the language faster than if you omit this parameter.

If you have multi-channel audio that contains different languages on each channel, and you've enabled channel identification, automatic language identification identifies the dominant language on each audio channel.

Note that you must include either LanguageCode or IdentifyLanguage or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.

Streaming language identification can't be combined with custom language models or redaction.

", - "StartStreamTranscriptionRequest$IdentifyMultipleLanguages": "

Enables automatic multi-language identification in your transcription job request. Use this parameter if your stream contains more than one language. If your stream contains only one language, use IdentifyLanguage instead.

If you include IdentifyMultipleLanguages, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your stream. Including LanguageOptions restricts IdentifyMultipleLanguages to only the language options that you specify, which can improve transcription accuracy.

If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic multiple language identification request, include VocabularyNames or VocabularyFilterNames.

Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.

", + "StartStreamTranscriptionRequest$IdentifyLanguage": "

Enables automatic language identification for your transcription.

If you include IdentifyLanguage, you must include a list of language codes, using LanguageOptions, that you think may be present in your audio stream.

You can also include a preferred language using PreferredLanguage. Adding a preferred language can help Amazon Transcribe identify the language faster than if you omit this parameter.

If you have multi-channel audio that contains different languages on each channel, and you've enabled channel identification, automatic language identification identifies the dominant language on each audio channel.

Note that you must include either LanguageCode or IdentifyLanguage or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.

Streaming language identification can't be combined with custom language models or redaction.

", + "StartStreamTranscriptionRequest$IdentifyMultipleLanguages": "

Enables automatic multi-language identification in your transcription job request. Use this parameter if your stream contains more than one language. If your stream contains only one language, use IdentifyLanguage instead.

If you include IdentifyMultipleLanguages, you must include a list of language codes, using LanguageOptions, that you think may be present in your stream.

If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic multiple language identification request, include VocabularyNames or VocabularyFilterNames.

Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.

", "StartStreamTranscriptionResponse$ShowSpeakerLabel": "

Shows whether speaker partitioning was enabled for your transcription.

", "StartStreamTranscriptionResponse$EnableChannelIdentification": "

Shows whether channel identification was enabled for your transcription.

", "StartStreamTranscriptionResponse$EnablePartialResultsStabilization": "

Shows whether partial results stabilization was enabled for your transcription.

", @@ -100,14 +100,14 @@ "CallAnalyticsLanguageCode": { "base": null, "refs": { - "StartCallAnalyticsStreamTranscriptionRequest$LanguageCode": "

Specify the language code that represents the language spoken in your audio.

If you're unsure of the language spoken in your audio, consider using IdentifyLanguage to enable automatic language identification.

For a list of languages supported with streaming Call Analytics, refer to the Supported languages table.

", + "StartCallAnalyticsStreamTranscriptionRequest$LanguageCode": "

Specify the language code that represents the language spoken in your audio.

For a list of languages supported with real-time Call Analytics, refer to the Supported languages table.

", "StartCallAnalyticsStreamTranscriptionResponse$LanguageCode": "

Provides the language code that you specified in your Call Analytics request.

" } }, "CallAnalyticsTranscriptResultStream": { - "base": "

Contains detailed information about your Call Analytics streaming session. These details are provided in the UtteranceEvent and CategoryEvent objects.

", + "base": "

Contains detailed information about your real-time Call Analytics session. These details are provided in the UtteranceEvent and CategoryEvent objects.

", "refs": { - "StartCallAnalyticsStreamTranscriptionResponse$CallAnalyticsTranscriptResultStream": "

Provides detailed information about your Call Analytics streaming session.

" + "StartCallAnalyticsStreamTranscriptionResponse$CallAnalyticsTranscriptResultStream": "

Provides detailed information about your real-time Call Analytics session.

" } }, "CategoryEvent": { @@ -168,9 +168,9 @@ "ContentIdentificationType": { "base": null, "refs": { - "StartCallAnalyticsStreamTranscriptionRequest$ContentIdentificationType": "

Labels all personally identifiable information (PII) identified in your transcript.

Content identification is performed at the segment level; PII specified in PiiEntityTypes is flagged upon complete transcription of an audio segment.

You can’t set ContentIdentificationType and ContentRedactionType in the same request. If you set both, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information.

", + "StartCallAnalyticsStreamTranscriptionRequest$ContentIdentificationType": "

Labels all personally identifiable information (PII) identified in your transcript.

Content identification is performed at the segment level; PII specified in PiiEntityTypes is flagged upon complete transcription of an audio segment. If you don't include PiiEntityTypes in your request, all PII is identified.

You can’t set ContentIdentificationType and ContentRedactionType in the same request. If you set both, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information.

", "StartCallAnalyticsStreamTranscriptionResponse$ContentIdentificationType": "

Shows whether content identification was enabled for your Call Analytics transcription.

", - "StartStreamTranscriptionRequest$ContentIdentificationType": "

Labels all personally identifiable information (PII) identified in your transcript.

Content identification is performed at the segment level; PII specified in PiiEntityTypes is flagged upon complete transcription of an audio segment.

You can’t set ContentIdentificationType and ContentRedactionType in the same request. If you set both, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information.

", + "StartStreamTranscriptionRequest$ContentIdentificationType": "

Labels all personally identifiable information (PII) identified in your transcript.

Content identification is performed at the segment level; PII specified in PiiEntityTypes is flagged upon complete transcription of an audio segment. If you don't include PiiEntityTypes in your request, all PII is identified.

You can’t set ContentIdentificationType and ContentRedactionType in the same request. If you set both, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information.

", "StartStreamTranscriptionResponse$ContentIdentificationType": "

Shows whether content identification was enabled for your transcription.

" } }, @@ -183,9 +183,9 @@ "ContentRedactionType": { "base": null, "refs": { - "StartCallAnalyticsStreamTranscriptionRequest$ContentRedactionType": "

Redacts all personally identifiable information (PII) identified in your transcript.

Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment.

You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information.

", + "StartCallAnalyticsStreamTranscriptionRequest$ContentRedactionType": "

Redacts all personally identifiable information (PII) identified in your transcript.

Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment. If you don't include PiiEntityTypes in your request, all PII is redacted.

You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information.

", "StartCallAnalyticsStreamTranscriptionResponse$ContentRedactionType": "

Shows whether content redaction was enabled for your Call Analytics transcription.

", - "StartStreamTranscriptionRequest$ContentRedactionType": "

Redacts all personally identifiable information (PII) identified in your transcript.

Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment.

You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information.

", + "StartStreamTranscriptionRequest$ContentRedactionType": "

Redacts all personally identifiable information (PII) identified in your transcript.

Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment. If you don't include PiiEntityTypes in your request, all PII is redacted.

You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information.

", "StartStreamTranscriptionResponse$ContentRedactionType": "

Shows whether content redaction was enabled for your transcription.

" } }, @@ -288,7 +288,7 @@ "LanguageOptions": { "base": null, "refs": { - "StartStreamTranscriptionRequest$LanguageOptions": "

Specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.

Including language options can improve the accuracy of language identification.

If you include LanguageOptions in your request, you must also include IdentifyLanguage.

For a list of languages supported with Amazon Transcribe streaming, refer to the Supported languages table.

You can only include one language dialect per language per stream. For example, you cannot include en-US and en-AU in the same request.

", + "StartStreamTranscriptionRequest$LanguageOptions": "

Specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended.

Including language options can improve the accuracy of language identification.

If you include LanguageOptions in your request, you must also include IdentifyLanguage or IdentifyMultipleLanguages.

For a list of languages supported with Amazon Transcribe streaming, refer to the Supported languages table.

You can only include one language dialect per language per stream. For example, you cannot include en-US and en-AU in the same request.

", "StartStreamTranscriptionResponse$LanguageOptions": "

Provides the language codes that you specified in your request.

" } }, @@ -432,9 +432,9 @@ "NumberOfChannels": { "base": null, "refs": { - "StartMedicalStreamTranscriptionRequest$NumberOfChannels": "

Specify the number of channels in your audio stream. Up to two channels are supported.

", + "StartMedicalStreamTranscriptionRequest$NumberOfChannels": "

Specify the number of channels in your audio stream. This value must be 2, as only two channels are supported. If your audio doesn't contain multiple channels, do not include this parameter in your request.

If you include NumberOfChannels in your request, you must also include EnableChannelIdentification.

", "StartMedicalStreamTranscriptionResponse$NumberOfChannels": "

Provides the number of channels that you specified in your request.

", - "StartStreamTranscriptionRequest$NumberOfChannels": "

Specify the number of channels in your audio stream. Up to two channels are supported.

", + "StartStreamTranscriptionRequest$NumberOfChannels": "

Specify the number of channels in your audio stream. This value must be 2, as only two channels are supported. If your audio doesn't contain multiple channels, do not include this parameter in your request.

If you include NumberOfChannels in your request, you must also include EnableChannelIdentification.

", "StartStreamTranscriptionResponse$NumberOfChannels": "

Provides the number of channels that you specified in your request.

" } }, @@ -457,9 +457,9 @@ "PiiEntityTypes": { "base": null, "refs": { - "StartCallAnalyticsStreamTranscriptionRequest$PiiEntityTypes": "

Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL.

To include PiiEntityTypes in your Call Analytics request, you must also include either ContentIdentificationType or ContentRedactionType.

Values must be comma-separated and can include: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, or ALL.

", + "StartCallAnalyticsStreamTranscriptionRequest$PiiEntityTypes": "

Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL.

Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, CREDIT_DEBIT_NUMBER, EMAIL, NAME, PHONE, PIN, SSN, or ALL.

Note that if you include PiiEntityTypes in your request, you must also include ContentIdentificationType or ContentRedactionType.

If you include ContentRedactionType or ContentIdentificationType in your request, but do not include PiiEntityTypes, all PII is redacted or identified.

", "StartCallAnalyticsStreamTranscriptionResponse$PiiEntityTypes": "

Lists the PII entity types you specified in your Call Analytics request.

", - "StartStreamTranscriptionRequest$PiiEntityTypes": "

Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL.

To include PiiEntityTypes in your request, you must also include either ContentIdentificationType or ContentRedactionType.

Values must be comma-separated and can include: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, or ALL.

", + "StartStreamTranscriptionRequest$PiiEntityTypes": "

Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL.

Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, CREDIT_DEBIT_NUMBER, EMAIL, NAME, PHONE, PIN, SSN, or ALL.

Note that if you include PiiEntityTypes in your request, you must also include ContentIdentificationType or ContentRedactionType.

If you include ContentRedactionType or ContentIdentificationType in your request, but do not include PiiEntityTypes, all PII is redacted or identified.

", "StartStreamTranscriptionResponse$PiiEntityTypes": "

Lists the PII entity types you specified in your request.

" } }, @@ -470,15 +470,15 @@ } }, "PostCallAnalyticsSettings": { - "base": "

Allows you to specify additional settings for your streaming Call Analytics post-call request, including output locations for your redacted and unredacted transcript, which IAM role to use, and, optionally, which encryption key to use.

ContentRedactionOutput, DataAccessRoleArn, and OutputLocation are required fields.

", + "base": "

Allows you to specify additional settings for your Call Analytics post-call request, including output locations for your redacted transcript, which IAM role to use, and which encryption key to use.

DataAccessRoleArn and OutputLocation are required fields.

PostCallAnalyticsSettings provides you with the same insights as a Call Analytics post-call transcription. Refer to Post-call analytics for more information on this feature.

", "refs": { - "ConfigurationEvent$PostCallAnalyticsSettings": "

Provides additional optional settings for your Call Analytics post-call request, including encryption and output locations for your redacted and unredacted transcript.

" + "ConfigurationEvent$PostCallAnalyticsSettings": "

Provides additional optional settings for your Call Analytics post-call request, including encryption and output locations for your redacted transcript.

PostCallAnalyticsSettings provides you with the same insights as a Call Analytics post-call transcription. Refer to Post-call analytics for more information on this feature.

" } }, "RequestId": { "base": null, "refs": { - "StartCallAnalyticsStreamTranscriptionResponse$RequestId": "

Provides the identifier for your Call Analytics streaming request.

", + "StartCallAnalyticsStreamTranscriptionResponse$RequestId": "

Provides the identifier for your real-time Call Analytics request.

", "StartMedicalStreamTranscriptionResponse$RequestId": "

Provides the identifier for your streaming request.

", "StartStreamTranscriptionResponse$RequestId": "

Provides the identifier for your streaming request.

" } @@ -512,11 +512,11 @@ "SessionId": { "base": null, "refs": { - "StartCallAnalyticsStreamTranscriptionRequest$SessionId": "

Specify a name for your Call Analytics transcription session. If you don't include this parameter in your request, Amazon Transcribe generates an ID and returns it in the response.

You can use a session ID to retry a streaming session.

", + "StartCallAnalyticsStreamTranscriptionRequest$SessionId": "

Specify a name for your Call Analytics transcription session. If you don't include this parameter in your request, Amazon Transcribe generates an ID and returns it in the response.

", "StartCallAnalyticsStreamTranscriptionResponse$SessionId": "

Provides the identifier for your Call Analytics transcription session.

", - "StartMedicalStreamTranscriptionRequest$SessionId": "

Specify a name for your transcription session. If you don't include this parameter in your request, Amazon Transcribe Medical generates an ID and returns it in the response.

You can use a session ID to retry a streaming session.

", + "StartMedicalStreamTranscriptionRequest$SessionId": "

Specify a name for your transcription session. If you don't include this parameter in your request, Amazon Transcribe Medical generates an ID and returns it in the response.

", "StartMedicalStreamTranscriptionResponse$SessionId": "

Provides the identifier for your transcription session.

", - "StartStreamTranscriptionRequest$SessionId": "

Specify a name for your transcription session. If you don't include this parameter in your request, Amazon Transcribe generates an ID and returns it in the response.

You can use a session ID to retry a streaming session.

", + "StartStreamTranscriptionRequest$SessionId": "

Specify a name for your transcription session. If you don't include this parameter in your request, Amazon Transcribe generates an ID and returns it in the response.

", "StartStreamTranscriptionResponse$SessionId": "

Provides the identifier for your transcription session.

" } }, @@ -591,7 +591,7 @@ "MedicalResult$ChannelId": "

Indicates the channel identified for the Result.

", "PostCallAnalyticsSettings$OutputLocation": "

The Amazon S3 location where you want your Call Analytics post-call transcription output stored. You can use any of the following formats to specify the output location:

  1. s3://DOC-EXAMPLE-BUCKET

  2. s3://DOC-EXAMPLE-BUCKET/my-output-folder/

  3. s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json

", "PostCallAnalyticsSettings$DataAccessRoleArn": "

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs.

", - "PostCallAnalyticsSettings$OutputEncryptionKMSKeyId": "

The KMS key you want to use to encrypt your Call Analytics post-call output.

If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:

  1. Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

  2. Use an alias for the KMS key ID. For example, alias/ExampleAlias.

  3. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  4. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:

  1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

Note that the user making the request must have permission to use the specified KMS key.

", + "PostCallAnalyticsSettings$OutputEncryptionKMSKeyId": "

The KMS key you want to use to encrypt your Call Analytics post-call output.

If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:

  1. Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

  2. Use an alias for the KMS key ID. For example, alias/ExampleAlias.

  3. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  4. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:

  1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

Note that the role making the request must have permission to use the specified KMS key.

", "Result$ResultId": "

Provides a unique identifier for the Result.

", "Result$ChannelId": "

Indicates which audio channel is associated with the Result.

", "ServiceUnavailableException$Message": null, diff --git a/gems/aws-partitions/CHANGELOG.md b/gems/aws-partitions/CHANGELOG.md index 5898d2099b4..34a8ea0c89a 100644 --- a/gems/aws-partitions/CHANGELOG.md +++ b/gems/aws-partitions/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.991.0 (2024-10-15) +------------------ + +* Feature - Updated the partitions source data the determines the AWS service regions and endpoints. + 1.990.0 (2024-10-14) ------------------ diff --git a/gems/aws-partitions/VERSION b/gems/aws-partitions/VERSION index c35e2ec4c1e..4d774e9afb9 100644 --- a/gems/aws-partitions/VERSION +++ b/gems/aws-partitions/VERSION @@ -1 +1 @@ -1.990.0 +1.991.0 diff --git a/gems/aws-partitions/partitions.json b/gems/aws-partitions/partitions.json index d05ebee7cd4..5eaa9881086 100644 --- a/gems/aws-partitions/partitions.json +++ b/gems/aws-partitions/partitions.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/gems/aws-sdk-amplify/CHANGELOG.md b/gems/aws-sdk-amplify/CHANGELOG.md index 12c07d40e87..a8efaf31c0e 100644 --- a/gems/aws-sdk-amplify/CHANGELOG.md +++ b/gems/aws-sdk-amplify/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.74.0 (2024-10-15) +------------------ + +* Feature - Added sourceUrlType field to StartDeployment request + 1.73.0 (2024-09-24) ------------------ diff --git a/gems/aws-sdk-amplify/VERSION b/gems/aws-sdk-amplify/VERSION index 5e3a4256626..dc87e8af82f 100644 --- a/gems/aws-sdk-amplify/VERSION +++ b/gems/aws-sdk-amplify/VERSION @@ -1 +1 @@ -1.73.0 +1.74.0 diff --git a/gems/aws-sdk-amplify/lib/aws-sdk-amplify.rb b/gems/aws-sdk-amplify/lib/aws-sdk-amplify.rb index 4a52b758e4a..1ba6f5d22ab 100644 --- a/gems/aws-sdk-amplify/lib/aws-sdk-amplify.rb +++ b/gems/aws-sdk-amplify/lib/aws-sdk-amplify.rb @@ -54,7 +54,7 @@ module Plugins autoload :EndpointProvider, 'aws-sdk-amplify/endpoint_provider' autoload :Endpoints, 'aws-sdk-amplify/endpoints' - GEM_VERSION = '1.73.0' + GEM_VERSION = '1.74.0' end diff --git a/gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb b/gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb index f124b112628..75fbbd734cd 100644 --- a/gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb +++ b/gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb @@ -894,7 +894,7 @@ def create_branch(params = {}, options = {}) end # Creates a deployment for a manually deployed Amplify app. Manually - # deployed apps are not connected to a repository. + # 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 @@ -1329,6 +1329,8 @@ def delete_domain_association(params = {}, options = {}) # resp.job_summary.status #=> String, one of "PENDING", "PROVISIONING", "RUNNING", "FAILED", "SUCCEED", "CANCELLING", "CANCELLED" # resp.job_summary.end_time #=> Time # resp.job_summary.job_type #=> String, one of "RELEASE", "RETRY", "MANUAL", "WEB_HOOK" + # resp.job_summary.source_url #=> String + # resp.job_summary.source_url_type #=> String, one of "ZIP", "BUCKET_PREFIX" # # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteJob AWS API Documentation # @@ -1707,6 +1709,8 @@ def get_domain_association(params = {}, options = {}) # resp.job.summary.status #=> String, one of "PENDING", "PROVISIONING", "RUNNING", "FAILED", "SUCCEED", "CANCELLING", "CANCELLED" # resp.job.summary.end_time #=> Time # resp.job.summary.job_type #=> String, one of "RELEASE", "RETRY", "MANUAL", "WEB_HOOK" + # resp.job.summary.source_url #=> String + # resp.job.summary.source_url_type #=> String, one of "ZIP", "BUCKET_PREFIX" # resp.job.steps #=> Array # resp.job.steps[0].step_name #=> String # resp.job.steps[0].start_time #=> Time @@ -2131,6 +2135,8 @@ def list_domain_associations(params = {}, options = {}) # resp.job_summaries[0].status #=> String, one of "PENDING", "PROVISIONING", "RUNNING", "FAILED", "SUCCEED", "CANCELLING", "CANCELLED" # resp.job_summaries[0].end_time #=> Time # resp.job_summaries[0].job_type #=> String, one of "RELEASE", "RETRY", "MANUAL", "WEB_HOOK" + # resp.job_summaries[0].source_url #=> String + # resp.job_summaries[0].source_url_type #=> String, one of "ZIP", "BUCKET_PREFIX" # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListJobs AWS API Documentation @@ -2219,7 +2225,7 @@ def list_webhooks(params = {}, options = {}) end # Starts a deployment for a manually deployed app. Manually deployed - # apps are not connected to a repository. + # 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 @@ -2230,16 +2236,23 @@ def list_webhooks(params = {}, options = {}) # The unique ID for an Amplify app. # # @option params [required, String] :branch_name - # The name of the branch to use for the job. + # The name of the branch to use for the deployment job. # # @option params [String] :job_id - # The job ID for this deployment, generated by the create deployment - # request. + # The job ID for this deployment that is generated by the + # `CreateDeployment` request. # # @option params [String] :source_url - # 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. + # 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. + # + # @option params [String] :source_url_type + # 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`. # # @return [Types::StartDeploymentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -2252,6 +2265,7 @@ def list_webhooks(params = {}, options = {}) # branch_name: "BranchName", # required # job_id: "JobId", # source_url: "SourceUrl", + # source_url_type: "ZIP", # accepts ZIP, BUCKET_PREFIX # }) # # @example Response structure @@ -2265,6 +2279,8 @@ def list_webhooks(params = {}, options = {}) # resp.job_summary.status #=> String, one of "PENDING", "PROVISIONING", "RUNNING", "FAILED", "SUCCEED", "CANCELLING", "CANCELLED" # resp.job_summary.end_time #=> Time # resp.job_summary.job_type #=> String, one of "RELEASE", "RETRY", "MANUAL", "WEB_HOOK" + # resp.job_summary.source_url #=> String + # resp.job_summary.source_url_type #=> String, one of "ZIP", "BUCKET_PREFIX" # # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StartDeployment AWS API Documentation # @@ -2335,6 +2351,8 @@ def start_deployment(params = {}, options = {}) # resp.job_summary.status #=> String, one of "PENDING", "PROVISIONING", "RUNNING", "FAILED", "SUCCEED", "CANCELLING", "CANCELLED" # resp.job_summary.end_time #=> Time # resp.job_summary.job_type #=> String, one of "RELEASE", "RETRY", "MANUAL", "WEB_HOOK" + # resp.job_summary.source_url #=> String + # resp.job_summary.source_url_type #=> String, one of "ZIP", "BUCKET_PREFIX" # # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StartJob AWS API Documentation # @@ -2379,6 +2397,8 @@ def start_job(params = {}, options = {}) # resp.job_summary.status #=> String, one of "PENDING", "PROVISIONING", "RUNNING", "FAILED", "SUCCEED", "CANCELLING", "CANCELLED" # resp.job_summary.end_time #=> Time # resp.job_summary.job_type #=> String, one of "RELEASE", "RETRY", "MANUAL", "WEB_HOOK" + # resp.job_summary.source_url #=> String + # resp.job_summary.source_url_type #=> String, one of "ZIP", "BUCKET_PREFIX" # # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StopJob AWS API Documentation # @@ -2954,7 +2974,7 @@ def build_request(operation_name, params = {}) tracer: tracer ) context[:gem_name] = 'aws-sdk-amplify' - context[:gem_version] = '1.73.0' + context[:gem_version] = '1.74.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-amplify/lib/aws-sdk-amplify/client_api.rb b/gems/aws-sdk-amplify/lib/aws-sdk-amplify/client_api.rb index 02050fc6e9d..128790de156 100644 --- a/gems/aws-sdk-amplify/lib/aws-sdk-amplify/client_api.rb +++ b/gems/aws-sdk-amplify/lib/aws-sdk-amplify/client_api.rb @@ -181,6 +181,7 @@ module ClientApi ServiceRoleArn = Shapes::StringShape.new(name: 'ServiceRoleArn') Source = Shapes::StringShape.new(name: 'Source') SourceUrl = Shapes::StringShape.new(name: 'SourceUrl') + SourceUrlType = Shapes::StringShape.new(name: 'SourceUrlType') StackArn = Shapes::StringShape.new(name: 'StackArn') StackName = Shapes::StringShape.new(name: 'StackName') Stage = Shapes::StringShape.new(name: 'Stage') @@ -588,6 +589,8 @@ module ClientApi JobSummary.add_member(:status, Shapes::ShapeRef.new(shape: JobStatus, required: true, location_name: "status")) JobSummary.add_member(:end_time, Shapes::ShapeRef.new(shape: EndTime, location_name: "endTime")) JobSummary.add_member(:job_type, Shapes::ShapeRef.new(shape: JobType, required: true, location_name: "jobType")) + JobSummary.add_member(:source_url, Shapes::ShapeRef.new(shape: SourceUrl, location_name: "sourceUrl")) + JobSummary.add_member(:source_url_type, Shapes::ShapeRef.new(shape: SourceUrlType, location_name: "sourceUrlType")) JobSummary.struct_class = Types::JobSummary LimitExceededException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message")) @@ -685,6 +688,7 @@ module ClientApi StartDeploymentRequest.add_member(:branch_name, Shapes::ShapeRef.new(shape: BranchName, required: true, location: "uri", location_name: "branchName")) StartDeploymentRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "jobId")) StartDeploymentRequest.add_member(:source_url, Shapes::ShapeRef.new(shape: SourceUrl, location_name: "sourceUrl")) + StartDeploymentRequest.add_member(:source_url_type, Shapes::ShapeRef.new(shape: SourceUrlType, location_name: "sourceUrlType")) StartDeploymentRequest.struct_class = Types::StartDeploymentRequest StartDeploymentResult.add_member(:job_summary, Shapes::ShapeRef.new(shape: JobSummary, required: true, location_name: "jobSummary")) diff --git a/gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb b/gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb index a93ea740589..06f61191f40 100644 --- a/gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb +++ b/gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb @@ -1863,10 +1863,27 @@ class Job < Struct.new( # # @!attribute [rw] job_type # 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 + # 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. + # 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. + # @return [String] + # + # @!attribute [rw] source_url + # 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. + # @return [String] + # + # @!attribute [rw] source_url_type + # 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`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/JobSummary AWS API Documentation @@ -1880,7 +1897,9 @@ class JobSummary < Struct.new( :start_time, :status, :end_time, - :job_type) + :job_type, + :source_url, + :source_url_type) SENSITIVE = [] include Aws::Structure end @@ -2334,19 +2353,26 @@ class ResourceNotFoundException < Struct.new( # @return [String] # # @!attribute [rw] branch_name - # The name of the branch to use for the job. + # The name of the branch to use for the deployment job. # @return [String] # # @!attribute [rw] job_id - # The job ID for this deployment, generated by the create deployment - # request. + # The job ID for this deployment that is generated by the + # `CreateDeployment` request. # @return [String] # # @!attribute [rw] source_url - # 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. + # 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. + # @return [String] + # + # @!attribute [rw] source_url_type + # 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`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StartDeploymentRequest AWS API Documentation @@ -2355,7 +2381,8 @@ class StartDeploymentRequest < Struct.new( :app_id, :branch_name, :job_id, - :source_url) + :source_url, + :source_url_type) SENSITIVE = [] include Aws::Structure end diff --git a/gems/aws-sdk-amplify/sig/client.rbs b/gems/aws-sdk-amplify/sig/client.rbs index fa5f9cc6bd6..618dca21288 100644 --- a/gems/aws-sdk-amplify/sig/client.rbs +++ b/gems/aws-sdk-amplify/sig/client.rbs @@ -484,7 +484,8 @@ module Aws app_id: ::String, branch_name: ::String, ?job_id: ::String, - ?source_url: ::String + ?source_url: ::String, + ?source_url_type: ("ZIP" | "BUCKET_PREFIX") ) -> _StartDeploymentResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartDeploymentResponseSuccess diff --git a/gems/aws-sdk-amplify/sig/types.rbs b/gems/aws-sdk-amplify/sig/types.rbs index da1179d5ae4..7190a2ff5fc 100644 --- a/gems/aws-sdk-amplify/sig/types.rbs +++ b/gems/aws-sdk-amplify/sig/types.rbs @@ -442,6 +442,8 @@ module Aws::Amplify attr_accessor status: ("PENDING" | "PROVISIONING" | "RUNNING" | "FAILED" | "SUCCEED" | "CANCELLING" | "CANCELLED") attr_accessor end_time: ::Time attr_accessor job_type: ("RELEASE" | "RETRY" | "MANUAL" | "WEB_HOOK") + attr_accessor source_url: ::String + attr_accessor source_url_type: ("ZIP" | "BUCKET_PREFIX") SENSITIVE: [] end @@ -578,6 +580,7 @@ module Aws::Amplify attr_accessor branch_name: ::String attr_accessor job_id: ::String attr_accessor source_url: ::String + attr_accessor source_url_type: ("ZIP" | "BUCKET_PREFIX") SENSITIVE: [] end diff --git a/gems/aws-sdk-cloudformation/CHANGELOG.md b/gems/aws-sdk-cloudformation/CHANGELOG.md index 96729eae5a0..039708e65fb 100644 --- a/gems/aws-sdk-cloudformation/CHANGELOG.md +++ b/gems/aws-sdk-cloudformation/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.121.0 (2024-10-15) +------------------ + +* Feature - Documentation update for AWS CloudFormation API Reference. + 1.120.0 (2024-09-24) ------------------ diff --git a/gems/aws-sdk-cloudformation/VERSION b/gems/aws-sdk-cloudformation/VERSION index 499526a0114..83bd3452721 100644 --- a/gems/aws-sdk-cloudformation/VERSION +++ b/gems/aws-sdk-cloudformation/VERSION @@ -1 +1 @@ -1.120.0 +1.121.0 diff --git a/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation.rb b/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation.rb index 4f31c6fe7a8..084eb28a4ab 100644 --- a/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation.rb +++ b/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation.rb @@ -59,7 +59,7 @@ module Plugins autoload :StackResource, 'aws-sdk-cloudformation/stack_resource' autoload :StackResourceSummary, 'aws-sdk-cloudformation/stack_resource_summary' - GEM_VERSION = '1.120.0' + GEM_VERSION = '1.121.0' end diff --git a/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb b/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb index cb8d44efba8..e678847e408 100644 --- a/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb +++ b/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb @@ -463,20 +463,16 @@ def activate_organizations_access(params = {}, options = {}) end # Activates a public third-party extension, making it available for use - # in stack templates. For more information, see [Using public - # extensions][1] in the *CloudFormation User Guide*. - # - # Once you have activated a public third-party extension in your account - # and Region, use [SetTypeConfiguration][2] to specify configuration - # properties for the extension. For more information, see [Configuring - # extensions at the account level][3] in the *CloudFormation User - # Guide*. + # in stack templates. Once you have activated a public third-party + # extension in your account and Region, use [SetTypeConfiguration][1] to + # specify configuration properties for the extension. For more + # information, see [Using public extensions][2] in the *CloudFormation + # User Guide*. # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html - # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html - # [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-private.html#registry-set-configuration + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html + # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html # # @option params [String] :type # The extension type. @@ -585,12 +581,12 @@ def activate_type(params = {}, options = {}) # extensions, from the CloudFormation registry for the account and # Region. # - # For more information, see [Configuring extensions at the account - # level][1] in the *CloudFormation User Guide*. + # For more information, see [Edit configuration data for extensions in + # your account][1] in the *CloudFormation User Guide*. # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-private.html#registry-set-configuration + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html # # @option params [required, Array] :type_configuration_identifiers # The list of identifiers for the desired extension configurations. @@ -700,7 +696,7 @@ def cancel_update_stack(params = {}, options = {}) # 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 + # Depending on the cause of the failure, you can manually [fix the # error][1] 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 @@ -730,13 +726,13 @@ def cancel_update_stack(params = {}, options = {}) # # # @option params [String] :role_arn - # 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. + # 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, @@ -777,8 +773,8 @@ def cancel_update_stack(params = {}, options = {}) # # 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][2]. + # rollback operation with nested stacks, see [Continue rolling back from + # failed nested stack updates][2]. # # # @@ -883,9 +879,8 @@ def continue_update_rollback(params = {}, options = {}) # # 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. + # 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. @@ -944,8 +939,8 @@ def continue_update_rollback(params = {}, options = {}) # # # - # For more information about macros, see [Using CloudFormation macros - # to perform custom processing on templates][11]. + # For more information about macros, see [Perform custom processing on + # CloudFormation templates with template macros][11]. # # Only one of the `Capabilities` and `ResourceType` parameters can be # specified. @@ -954,14 +949,14 @@ def continue_update_rollback(params = {}, options = {}) # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html - # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html + # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html # [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html - # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html + # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html # [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html - # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html - # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html - # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities + # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html + # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html + # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities # [9]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html # [10]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html # [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html @@ -973,11 +968,10 @@ def continue_update_rollback(params = {}, options = {}) # # 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][1] in the *CloudFormation - # User Guide*. + # 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][1] in the *CloudFormation User Guide*. # # Only one of the `Capabilities` and `ResourceType` parameters can be # specified. @@ -989,13 +983,13 @@ def continue_update_rollback(params = {}, options = {}) # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html # # @option params [String] :role_arn - # 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. + # 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, @@ -1008,9 +1002,9 @@ def continue_update_rollback(params = {}, options = {}) # period afterwards. # # @option params [Array] :notification_arns - # 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. + # 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. # # @option params [Array] :tags # Key-value pairs to associate with this stack. CloudFormation also @@ -1043,17 +1037,13 @@ def continue_update_rollback(params = {}, options = {}) # # 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][1] state until you execute the - # change set. + # 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. # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html#d0e11995 - # # @option params [Array] :resources_to_import # The resources to import into your stack. # @@ -1097,8 +1087,9 @@ def continue_update_rollback(params = {}, options = {}) # templates. For more information, see [name type][1] 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][2] in the *CloudFormation User Guide*. + # instead. For more information, see [Import Amazon Web Services + # resources into a CloudFormation stack with a resource import][2] in + # the *CloudFormation User Guide*. # # # @@ -1270,6 +1261,14 @@ def create_generated_template(params = {}, options = {}) # 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][1] in the *CloudFormation User Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html + # # @option params [required, String] :stack_name # The name that's associated with the stack. The name must be unique in # the Region in which you are creating the stack. @@ -1282,30 +1281,20 @@ def create_generated_template(params = {}, options = {}) # # @option params [String] :template_body # 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][1] in the *CloudFormation User Guide*. + # and a maximum length of 51,200 bytes. # # Conditional: You must specify either the `TemplateBody` or the # `TemplateURL` parameter, but not both. # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html - # # @option params [String] :template_url # 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][1] in the *CloudFormation User Guide*. The location - # for an Amazon S3 bucket must start with `https://`. + # 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. # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html - # # @option params [Array] :parameters # A list of `Parameter` structures that specify input parameters for the # stack. For more information, see the [Parameter][1] data type. @@ -1332,9 +1321,9 @@ def create_generated_template(params = {}, options = {}) # the stack will be rolled back. # # @option params [Array] :notification_arns - # 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). + # 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). # # @option params [Array] :capabilities # In some cases, you must explicitly acknowledge that your stack @@ -1345,9 +1334,8 @@ def create_generated_template(params = {}, options = {}) # # 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. + # 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. @@ -1378,8 +1366,8 @@ def create_generated_template(params = {}, options = {}) # # * [AWS::IAM::UserToGroupAddition][7] # - # For more information, see [Acknowledging IAM Resources in - # CloudFormation Templates][8]. + # For more information, see [Acknowledging IAM resources in + # CloudFormation templates][8]. # # * `CAPABILITY_AUTO_EXPAND` # @@ -1408,8 +1396,8 @@ def create_generated_template(params = {}, options = {}) # can update the function operation without CloudFormation being # notified. # - # For more information, see [Using CloudFormation macros to perform - # custom processing on templates][11]. + # For more information, see [Perform custom processing on + # CloudFormation templates with template macros][11]. # # Only one of the `Capabilities` and `ResourceType` parameters can be # specified. @@ -1418,14 +1406,14 @@ def create_generated_template(params = {}, options = {}) # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html - # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html + # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html # [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html - # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html + # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html # [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html - # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html - # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html - # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities + # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html + # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html + # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities # [9]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html # [10]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html # [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html @@ -1443,10 +1431,10 @@ def create_generated_template(params = {}, options = {}) # # 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][1]. + # 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][1]. # # Only one of the `Capabilities` and `ResourceType` parameters can be # specified. @@ -1458,13 +1446,13 @@ def create_generated_template(params = {}, options = {}) # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html # # @option params [String] :role_arn - # 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. + # 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, @@ -1479,9 +1467,9 @@ def create_generated_template(params = {}, options = {}) # Default: `ROLLBACK` # # @option params [String] :stack_policy_body - # Structure containing the stack policy body. For more information, go - # to [ Prevent Updates to Stack Resources][1] in the *CloudFormation - # User Guide*. You can specify either the `StackPolicyBody` or the + # Structure containing the stack policy body. For more information, see + # [Prevent updates to stack resources][1] in the *CloudFormation User + # Guide*. You can specify either the `StackPolicyBody` or the # `StackPolicyURL` parameter, but not both. # # @@ -1525,9 +1513,9 @@ def create_generated_template(params = {}, options = {}) # 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][1] in the - # *CloudFormation User Guide*. Termination protection is deactivated on - # stacks by default. + # information, see [Protect CloudFormation stacks from being deleted][1] + # in the *CloudFormation User Guide*. Termination protection is + # deactivated on stacks by default. # # For [nested stacks][2], termination protection is set on the root # stack and can't be changed directly on the nested stack. @@ -1778,30 +1766,19 @@ def create_stack_instances(params = {}, options = {}) # # @option params [String] :template_body # 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][1] in the *CloudFormation User Guide*. + # 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. # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html - # # @option params [String] :template_url # 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][1] in the *CloudFormation User - # Guide*. + # an Amazon S3 bucket or a Systems Manager document. # # Conditional: You must specify either the TemplateBody or the # TemplateURL parameter, but not both. # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html - # # @option params [String] :stack_id # The stack ID you are importing into a new stack set. Specify the # Amazon Resource Name (ARN) of the stack. @@ -1818,9 +1795,8 @@ def create_stack_instances(params = {}, options = {}) # # 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. + # 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. @@ -1851,8 +1827,8 @@ def create_stack_instances(params = {}, options = {}) # # * [AWS::IAM::UserToGroupAddition][7] # - # For more information, see [Acknowledging IAM Resources in - # CloudFormation Templates][8]. + # For more information, see [Acknowledging IAM resources in + # CloudFormation templates][8]. # # * `CAPABILITY_AUTO_EXPAND` # @@ -1874,14 +1850,14 @@ def create_stack_instances(params = {}, options = {}) # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html - # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html + # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html # [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html - # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html + # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html # [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html - # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html - # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html - # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities + # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html + # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html + # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities # [9]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html # [10]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html # [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html @@ -2174,6 +2150,13 @@ def delete_generated_template(params = {}, options = {}) # 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][1] in the *CloudFormation User Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-console-delete-stack.html + # # @option params [required, String] :stack_name # The name or the unique stack ID that's associated with the stack. # @@ -2187,10 +2170,9 @@ def delete_generated_template(params = {}, options = {}) # as a non-empty S3 bucket, but you want to delete the stack. # # @option params [String] :role_arn - # 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. + # 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, @@ -2283,7 +2265,7 @@ def delete_stack(params = {}, options = {}) # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html#stackset-ops-options # # @option params [String] :operation_id # The unique identifier for this stack set operation. @@ -2481,8 +2463,8 @@ def deregister_type(params = {}, options = {}) # 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][1] in - # the *CloudFormation User Guide*. + # information about account limits, see [Understand CloudFormation + # quotas][1] in the *CloudFormation User Guide*. # # # @@ -2523,8 +2505,8 @@ def describe_account_limits(params = {}, options = {}) # 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][1] in the - # *CloudFormation User Guide*. + # information, see [Update CloudFormation stacks using change sets][1] + # in the *CloudFormation User Guide*. # # # @@ -2879,7 +2861,7 @@ def describe_organizations_access(params = {}, options = {}) # * [RegisterPublisher][1] # # * [Publishing extensions to make them available for public use][2] in - # the *CloudFormation CLI User Guide* + # the *CloudFormation Command Line Interface (CLI) User Guide* # # # @@ -3068,8 +3050,9 @@ def describe_resource_scan(params = {}, options = {}) # 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][1]. + # information about stack and resource drift, see [Detect unmanaged + # configuration changes to stacks and resources with drift + # detection][1]. # # Use DetectStackDrift to initiate a stack drift detection operation. # `DetectStackDrift` returns a `StackDriftDetectionId` you can use to @@ -3127,8 +3110,8 @@ def describe_stack_drift_detection_status(params = {}, options = {}) # 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][1] in the - # *CloudFormation User Guide*. + # history, see [Understand CloudFormation stack creation events][1] 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). @@ -3348,7 +3331,7 @@ def describe_stack_resource(params = {}, options = {}) # 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][1]. + # [Resource type support for imports and drift detection][1]. # # Use DetectStackResourceDrift to detect drift on individual resources, # or DetectStackDrift to detect drift on all supported resources for a @@ -3356,7 +3339,7 @@ def describe_stack_resource(params = {}, options = {}) # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html # # @option params [required, String] :stack_name # The name of the stack for which you want drift information. @@ -3451,8 +3434,8 @@ def describe_stack_resource_drifts(params = {}, options = {}) # 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][1]. + # `LogicalResourceId` and `PhysicalResourceId`, see the [CloudFormation + # User Guide][1]. # # A `ValidationError` is returned if you specify both `StackName` and # `PhysicalResourceId` in the same request. @@ -3708,8 +3691,8 @@ def describe_stack_set_operation(params = {}, options = {}) # 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][1] in the *CloudFormation User + # For more information about a stack's event history, see [Understand + # CloudFormation stack creation events][1] in the *CloudFormation User # Guide*. # # If the stack doesn't exist, a `ValidationError` is returned. @@ -4017,15 +4000,16 @@ def describe_type_registration(params = {}, options = {}) # 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][1]. + # expected template configurations. For more information, see [Detect + # unmanaged configuration changes to stacks and resources with drift + # detection][1]. # # 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][2]. + # see [Resource type support for imports and drift detection][2]. # # `DetectStackDrift` can take up to several minutes, depending on the # number of resources contained within the stack. Use @@ -4041,7 +4025,7 @@ def describe_type_registration(params = {}, options = {}) # # # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html - # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html + # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html # # @option params [required, String] :stack_name # The name of the stack for which you want to detect drift. @@ -4080,8 +4064,8 @@ def detect_stack_drift(params = {}, options = {}) # 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][1]. + # [Detect unmanaged configuration changes to stacks and resources with + # drift detection][1]. # # Use `DetectStackResourceDrift` to detect drift on individual # resources, or DetectStackDrift to detect drift on all resources in a @@ -4089,12 +4073,12 @@ def detect_stack_drift(params = {}, options = {}) # # 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][2]. + # [Resource type support for imports and drift detection][2]. # # # # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html - # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html + # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html # # @option params [required, String] :stack_name # The name of the stack to which the resource belongs. @@ -4199,7 +4183,7 @@ def detect_stack_resource_drift(params = {}, options = {}) # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html#stackset-ops-options # # @option params [String] :operation_id # *The ID of the stack set operation.* @@ -4269,30 +4253,20 @@ def detect_stack_set_drift(params = {}, options = {}) # # @option params [String] :template_body # 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][1] in the *CloudFormation User Guide*.) + # and a maximum length of 51,200 bytes. # # Conditional: You must pass `TemplateBody` or `TemplateURL`. If both # are passed, only `TemplateBody` is used. # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html - # # @option params [String] :template_url # 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][1] in the - # *CloudFormation User Guide*. The location for an Amazon S3 bucket must - # start with `https://`. + # 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. # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html - # # @option params [Array] :parameters # A list of `Parameter` structures that specify input parameters. # @@ -4595,32 +4569,20 @@ def get_template(params = {}, options = {}) # # @option params [String] :template_body # 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][1] in the *CloudFormation User - # Guide*. + # and a maximum length of 51,200 bytes. # # Conditional: You must specify only one of the following parameters: # `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`. # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html - # # @option params [String] :template_url # 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][1] in the *CloudFormation User - # Guide*. The location for an Amazon S3 bucket must start with - # `https://`. + # 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`. # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html - # # @option params [String] :stack_name # The name or the stack ID that's associated with the stack, which # aren't always interchangeable. For running stacks, you can specify @@ -4760,7 +4722,7 @@ def get_template_summary(params = {}, options = {}) # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html#stackset-ops-options # # @option params [String] :operation_id # A unique, user defined, identifier for the stack set operation. @@ -4871,8 +4833,8 @@ def list_change_sets(params = {}, options = {}) # values that you can import into other stacks. To import values, use # the [ Fn::ImportValue][1] function. # - # For more information, see [ CloudFormation export stack output - # values][2]. + # For more information, see [Get exported outputs from a deployed + # CloudFormation stack][2]. # # # @@ -6360,7 +6322,8 @@ def list_types(params = {}, options = {}) # 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][1] in the *CloudFormation CLI User Guide*. + # public use][1] 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][2]. @@ -6519,8 +6482,9 @@ def record_handler_progress(params = {}, options = {}) # all Amazon Web Services Regions. # # For information about requirements for registering as a public - # extension publisher, see [Registering your account to publish - # CloudFormation extensions][1] in the *CloudFormation CLI User Guide*. + # extension publisher, see [Prerequisite: Registering your account to + # publish CloudFormation extensions][1] in the *CloudFormation Command + # Line Interface (CLI) User Guide*. # # # @@ -6545,8 +6509,9 @@ def record_handler_progress(params = {}, options = {}) # verification, the Amazon Resource Name (ARN) for your connection to # that account. # - # For more information, see [Registering your account to publish - # CloudFormation extensions][1] in the *CloudFormation CLI User Guide*. + # For more information, see [Prerequisite: Registering your account to + # publish CloudFormation extensions][1] in the *CloudFormation Command + # Line Interface (CLI) User Guide*. # # # @@ -6588,8 +6553,9 @@ def register_publisher(params = {}, options = {}) # * 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][1] in the - # *CloudFormation CLI User Guide*. + # for registration, see [Creating resource types using the + # CloudFormation CLI][1] 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 @@ -6602,16 +6568,16 @@ def register_publisher(params = {}, options = {}) # # Once you have registered a private extension in your account and # Region, use [SetTypeConfiguration][3] to specify configuration - # properties for the extension. For more information, see [Configuring - # extensions at the account level][4] in the *CloudFormation User - # Guide*. + # properties for the extension. For more information, see [Edit + # configuration data for extensions in your account][4] in the + # *CloudFormation User Guide*. # # # # [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeregisterType.html # [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html - # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-private.html#registry-set-configuration + # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html # # @option params [String] :type # The kind of extension. @@ -6621,11 +6587,11 @@ def register_publisher(params = {}, options = {}) # # We suggest that extension names adhere to the following patterns: # - # * For resource types, *company\_or\_organization*::*service*::*type*. + # * For resource types, `company_or_organization::service::type`. # - # * For modules, *company\_or\_organization*::*service*::*type*::MODULE. + # * For modules, `company_or_organization::service::type::MODULE`. # - # * For hooks, *MyCompany*::*Testing*::*MyTestHook*. + # * For hooks, `MyCompany::Testing::MyTestHook`. # # The following organization namespaces are reserved and can't be used # in your extension names: @@ -6650,7 +6616,7 @@ def register_publisher(params = {}, options = {}) # # For information about generating a schema handler package for the # extension you want to register, see [submit][1] in the *CloudFormation - # CLI User Guide*. + # 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][2] @@ -6757,8 +6723,8 @@ def register_type(params = {}, options = {}) # The name that's associated with the stack. # # @option params [String] :role_arn - # The Amazon Resource Name (ARN) of an Identity and Access Management - # role that CloudFormation assumes to rollback the stack. + # The Amazon Resource Name (ARN) of an IAM role that CloudFormation + # assumes to rollback the stack. # # @option params [String] :client_request_token # A unique identifier for this `RollbackStack` request. @@ -6802,9 +6768,9 @@ def rollback_stack(params = {}, options = {}) # The name or unique stack ID that you want to associate a policy with. # # @option params [String] :stack_policy_body - # Structure containing the stack policy body. For more information, go - # to [ Prevent updates to stack resources][1] in the *CloudFormation - # User Guide*. You can specify either the `StackPolicyBody` or the + # Structure containing the stack policy body. For more information, see + # [Prevent updates to stack resources][1] in the *CloudFormation User + # Guide*. You can specify either the `StackPolicyBody` or the # `StackPolicyURL` parameter, but not both. # # @@ -6842,19 +6808,20 @@ def set_stack_policy(params = {}, options = {}) # # To view the current configuration data for an extension, refer to the # `ConfigurationSchema` element of [DescribeType][1]. For more - # information, see [Configuring extensions at the account level][2] in - # the *CloudFormation User Guide*. + # information, see [Edit configuration data for extensions in your + # account][2] 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][3] in the *CloudFormation User Guide*. + # For more details on dynamic references, see [Specify values stored in + # other services using dynamic references][3] in the *CloudFormation + # User Guide*. # # # # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html - # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-private.html#registry-set-configuration - # [3]: https://docs.aws.amazon.com/ + # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html + # [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html # # @option params [String] :type_arn # The Amazon Resource Name (ARN) for the extension, in this account and @@ -6879,9 +6846,9 @@ def set_stack_policy(params = {}, options = {}) # # The configuration data must be formatted as JSON, and validate against # the schema returned in the `ConfigurationSchema` response element of - # [DescribeType][1]. For more information, see [Defining account-level - # configuration data for an extension][2] in the *CloudFormation CLI - # User Guide*. + # [DescribeType][1]. For more information, see [Defining the + # account-level configuration of an extension][2] in the *CloudFormation + # Command Line Interface (CLI) User Guide*. # # # @@ -7130,8 +7097,9 @@ def stop_stack_set_operation(params = {}, options = {}) # * 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][1] in the *CloudFormation CLI User Guide*. + # For more information, see [Testing your public extension before + # publishing][1] 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. @@ -7147,8 +7115,8 @@ def stop_stack_set_operation(params = {}, options = {}) # # 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][4] in the *CloudFormation CLI User - # Guide*. + # them available for public use][4] in the *CloudFormation Command Line + # Interface (CLI) User Guide*. # # # @@ -7198,8 +7166,7 @@ def stop_stack_set_operation(params = {}, options = {}) # * `PutObject` # # For more information, see [Actions, Resources, and Condition Keys for - # Amazon S3][1] in the *Amazon Web Services Identity and Access - # Management User Guide*. + # Amazon S3][1] in the *Identity and Access Management User Guide*. # # # @@ -7367,45 +7334,36 @@ def update_generated_template(params = {}, options = {}) # 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][1]. + # 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][1] in the *CloudFormation + # User Guide*. # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html # # @option params [required, String] :stack_name # The name or unique stack ID of the stack to update. # # @option params [String] :template_body # 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][1] in the *CloudFormation User Guide*.) + # 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`. # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html - # # @option params [String] :template_url # 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][1] in the - # *CloudFormation User Guide*. The location for an Amazon S3 bucket must - # start with `https://`. + # 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`. # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html - # # @option params [Boolean] :use_previous_template # Reuse the existing template that is associated with the stack that you # are updating. @@ -7453,10 +7411,9 @@ def update_generated_template(params = {}, options = {}) # * `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. + # 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. @@ -7487,8 +7444,8 @@ def update_generated_template(params = {}, options = {}) # # * [AWS::IAM::UserToGroupAddition][7] # - # For more information, see [Acknowledging IAM Resources in - # CloudFormation Templates][8]. + # For more information, see [Acknowledging IAM resources in + # CloudFormation templates][8]. # # * `CAPABILITY_AUTO_EXPAND` # @@ -7517,8 +7474,8 @@ def update_generated_template(params = {}, options = {}) # can update the function operation without CloudFormation being # notified. # - # For more information, see [Using CloudFormation Macros to Perform - # Custom Processing on Templates][11]. + # For more information, see [Perform custom processing on + # CloudFormation templates with template macros][11]. # # Only one of the `Capabilities` and `ResourceType` parameters can be # specified. @@ -7527,14 +7484,14 @@ def update_generated_template(params = {}, options = {}) # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html - # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html + # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html # [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html - # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html + # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html # [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html - # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html - # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html - # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities + # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html + # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html + # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities # [9]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html # [10]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html # [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html @@ -7546,10 +7503,10 @@ def update_generated_template(params = {}, options = {}) # # 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][1]. + # 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][1]. # # Only one of the `Capabilities` and `ResourceType` parameters can be # specified. @@ -7561,13 +7518,13 @@ def update_generated_template(params = {}, options = {}) # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html # # @option params [String] :role_arn - # 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. + # 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, @@ -7910,30 +7867,19 @@ def update_stack_instances(params = {}, options = {}) # # @option params [String] :template_body # 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][1] in the *CloudFormation User Guide*. + # 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. # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html - # # @option params [String] :template_url # 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][1] in the *CloudFormation User - # Guide*. + # 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. # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html - # # @option params [Boolean] :use_previous_template # Use the existing template that's associated with the stack set that # you're updating. @@ -7952,10 +7898,9 @@ def update_stack_instances(params = {}, options = {}) # * `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. + # 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. @@ -7986,8 +7931,8 @@ def update_stack_instances(params = {}, options = {}) # # * [AWS::IAM::UserToGroupAddition][7] # - # For more information, see [Acknowledging IAM Resources in - # CloudFormation Templates][8]. + # For more information, see [Acknowledging IAM resources in + # CloudFormation templates][8]. # # * `CAPABILITY_AUTO_EXPAND` # @@ -8009,14 +7954,14 @@ def update_stack_instances(params = {}, options = {}) # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html - # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html + # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html # [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html - # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html + # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html # [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html - # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html - # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html - # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities + # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html + # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html + # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities # [9]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html # [10]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html # [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html @@ -8288,8 +8233,8 @@ def update_stack_set(params = {}, options = {}) # 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][1] in the *CloudFormation - # User Guide*. + # see [Protect a CloudFormation stack from being deleted][1] in the + # *CloudFormation User Guide*. # # For [nested stacks][2], termination protection is set on the root # stack and can't be changed directly on the nested stack. @@ -8337,30 +8282,20 @@ def update_termination_protection(params = {}, options = {}) # # @option params [String] :template_body # 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][1] in the *CloudFormation User Guide*. + # and a maximum length of 51,200 bytes. # # Conditional: You must pass `TemplateURL` or `TemplateBody`. If both # are passed, only `TemplateBody` is used. # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html - # # @option params [String] :template_url # 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][1] in the *CloudFormation User Guide*. The location - # for an Amazon S3 bucket must start with `https://`. + # 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. # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html - # # @return [Types::ValidateTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ValidateTemplateOutput#parameters #parameters} => Array<Types::TemplateParameter> @@ -8417,7 +8352,7 @@ def build_request(operation_name, params = {}) tracer: tracer ) context[:gem_name] = 'aws-sdk-cloudformation' - context[:gem_version] = '1.120.0' + context[:gem_version] = '1.121.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/event.rb b/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/event.rb index 47fdb5769d2..d0e43145612 100644 --- a/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/event.rb +++ b/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/event.rb @@ -60,8 +60,9 @@ def physical_resource_id data[:physical_resource_id] end - # Type of resource. (For more information, go to [Amazon Web Services - # Resource Types Reference][1] in the *CloudFormation User Guide*.) + # Type of resource. For more information, see [Amazon Web Services + # resource and property types reference][1] in the *CloudFormation User + # Guide*. # # # @@ -155,8 +156,9 @@ def hook_failure_mode # the stack event. # # * `CONFIGURATION_COMPLETE` - all of the resources in the stack have - # reached that event. For more information, see [CloudFormation stack - # deployment][1] in the *CloudFormation User Guide*. + # reached that event. For more information, see [Understand + # CloudFormation stack creation events][1] in the *CloudFormation User + # Guide*. # # ^ # ^ diff --git a/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/resource.rb b/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/resource.rb index 8e29e975fda..c0474a95e55 100644 --- a/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/resource.rb +++ b/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/resource.rb @@ -89,28 +89,18 @@ def client # # @option options [String] :template_body # 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][1] in the *CloudFormation User Guide*. + # and a maximum length of 51,200 bytes. # # Conditional: You must specify either the `TemplateBody` or the # `TemplateURL` parameter, but not both. - # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html # @option options [String] :template_url # 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][1] in the *CloudFormation User Guide*. The location - # for an Amazon S3 bucket must start with `https://`. + # 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. - # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html # @option options [Array] :parameters # A list of `Parameter` structures that specify input parameters for the # stack. For more information, see the [Parameter][1] data type. @@ -133,9 +123,9 @@ def client # `CREATE_FAILED`; if `DisableRollback` is not set or is set to `false`, # the stack will be rolled back. # @option options [Array] :notification_arns - # 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). + # 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). # @option options [Array] :capabilities # In some cases, you must explicitly acknowledge that your stack # template contains certain capabilities in order for CloudFormation to @@ -145,9 +135,8 @@ def client # # 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. + # 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. @@ -178,8 +167,8 @@ def client # # * [AWS::IAM::UserToGroupAddition][7] # - # For more information, see [Acknowledging IAM Resources in - # CloudFormation Templates][8]. + # For more information, see [Acknowledging IAM resources in + # CloudFormation templates][8]. # # * `CAPABILITY_AUTO_EXPAND` # @@ -208,8 +197,8 @@ def client # can update the function operation without CloudFormation being # notified. # - # For more information, see [Using CloudFormation macros to perform - # custom processing on templates][11]. + # For more information, see [Perform custom processing on + # CloudFormation templates with template macros][11]. # # Only one of the `Capabilities` and `ResourceType` parameters can be # specified. @@ -218,14 +207,14 @@ def client # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html - # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html + # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html # [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html - # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html + # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html # [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html - # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html - # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html - # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities + # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html + # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html + # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities # [9]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html # [10]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html # [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html @@ -242,10 +231,10 @@ def client # # 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][1]. + # 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][1]. # # Only one of the `Capabilities` and `ResourceType` parameters can be # specified. @@ -256,13 +245,13 @@ def client # # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html # @option options [String] :role_arn - # 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. + # 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, @@ -275,9 +264,9 @@ def client # # Default: `ROLLBACK` # @option options [String] :stack_policy_body - # Structure containing the stack policy body. For more information, go - # to [ Prevent Updates to Stack Resources][1] in the *CloudFormation - # User Guide*. You can specify either the `StackPolicyBody` or the + # Structure containing the stack policy body. For more information, see + # [Prevent updates to stack resources][1] in the *CloudFormation User + # Guide*. You can specify either the `StackPolicyBody` or the # `StackPolicyURL` parameter, but not both. # # @@ -317,9 +306,9 @@ def client # 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][1] in the - # *CloudFormation User Guide*. Termination protection is deactivated on - # stacks by default. + # information, see [Protect CloudFormation stacks from being deleted][1] + # in the *CloudFormation User Guide*. Termination protection is + # deactivated on stacks by default. # # For [nested stacks][2], termination protection is set on the root # stack and can't be changed directly on the nested stack. diff --git a/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb b/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb index 1de8519f60a..3fcc6b3a17d 100644 --- a/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb +++ b/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack.rb @@ -133,10 +133,9 @@ def outputs data[:outputs] end - # 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. + # 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. # @return [String] def role_arn data[:role_arn] @@ -152,8 +151,8 @@ def tags # # For [nested stacks][1], 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][2] in the - # *CloudFormation User Guide*. + # information, see [Protect a CloudFormation stack from being + # deleted][2] in the *CloudFormation User Guide*. # # # @@ -168,8 +167,8 @@ def enable_termination_protection # 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][1] in the - # *CloudFormation User Guide*. + # For more information, see [Embed stacks within other stacks using + # nested stacks][1] in the *CloudFormation User Guide*. # # # @@ -183,8 +182,8 @@ def parent_id # stack ID of the top-level stack to which the nested stack ultimately # belongs. # - # For more information, see [Working with Nested Stacks][1] in the - # *CloudFormation User Guide*. + # For more information, see [Embed stacks within other stacks using + # nested stacks][1] in the *CloudFormation User Guide*. # # # @@ -197,8 +196,8 @@ def root_id # 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][1]. + # more information, see [Detect unmanaged configuration changes to + # stacks and resources with drift detection][1]. # # # @@ -235,8 +234,8 @@ def deletion_mode # 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][1] in the - # *CloudFormation User Guide*. + # information, see [Understand CloudFormation stack creation events][1] + # in the *CloudFormation User Guide*. # # # @@ -482,28 +481,18 @@ def cancel_update(options = {}) # @param [Hash] options ({}) # @option options [String] :template_body # 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][1] in the *CloudFormation User Guide*. + # and a maximum length of 51,200 bytes. # # Conditional: You must specify either the `TemplateBody` or the # `TemplateURL` parameter, but not both. - # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html # @option options [String] :template_url # 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][1] in the *CloudFormation User Guide*. The location - # for an Amazon S3 bucket must start with `https://`. + # 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. - # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html # @option options [Array] :parameters # A list of `Parameter` structures that specify input parameters for the # stack. For more information, see the [Parameter][1] data type. @@ -526,9 +515,9 @@ def cancel_update(options = {}) # `CREATE_FAILED`; if `DisableRollback` is not set or is set to `false`, # the stack will be rolled back. # @option options [Array] :notification_arns - # 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). + # 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). # @option options [Array] :capabilities # In some cases, you must explicitly acknowledge that your stack # template contains certain capabilities in order for CloudFormation to @@ -538,9 +527,8 @@ def cancel_update(options = {}) # # 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. + # 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. @@ -571,8 +559,8 @@ def cancel_update(options = {}) # # * [AWS::IAM::UserToGroupAddition][7] # - # For more information, see [Acknowledging IAM Resources in - # CloudFormation Templates][8]. + # For more information, see [Acknowledging IAM resources in + # CloudFormation templates][8]. # # * `CAPABILITY_AUTO_EXPAND` # @@ -601,8 +589,8 @@ def cancel_update(options = {}) # can update the function operation without CloudFormation being # notified. # - # For more information, see [Using CloudFormation macros to perform - # custom processing on templates][11]. + # For more information, see [Perform custom processing on + # CloudFormation templates with template macros][11]. # # Only one of the `Capabilities` and `ResourceType` parameters can be # specified. @@ -611,14 +599,14 @@ def cancel_update(options = {}) # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html - # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html + # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html # [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html - # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html + # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html # [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html - # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html - # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html - # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities + # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html + # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html + # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities # [9]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html # [10]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html # [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html @@ -635,10 +623,10 @@ def cancel_update(options = {}) # # 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][1]. + # 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][1]. # # Only one of the `Capabilities` and `ResourceType` parameters can be # specified. @@ -649,13 +637,13 @@ def cancel_update(options = {}) # # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html # @option options [String] :role_arn - # 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. + # 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, @@ -668,9 +656,9 @@ def cancel_update(options = {}) # # Default: `ROLLBACK` # @option options [String] :stack_policy_body - # Structure containing the stack policy body. For more information, go - # to [ Prevent Updates to Stack Resources][1] in the *CloudFormation - # User Guide*. You can specify either the `StackPolicyBody` or the + # Structure containing the stack policy body. For more information, see + # [Prevent updates to stack resources][1] in the *CloudFormation User + # Guide*. You can specify either the `StackPolicyBody` or the # `StackPolicyURL` parameter, but not both. # # @@ -710,9 +698,9 @@ def cancel_update(options = {}) # 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][1] in the - # *CloudFormation User Guide*. Termination protection is deactivated on - # stacks by default. + # information, see [Protect CloudFormation stacks from being deleted][1] + # in the *CloudFormation User Guide*. Termination protection is + # deactivated on stacks by default. # # For [nested stacks][2], termination protection is set on the root # stack and can't be changed directly on the nested stack. @@ -754,10 +742,9 @@ def create(options = {}) # Retaining resources is useful when you can't delete a resource, such # as a non-empty S3 bucket, but you want to delete the stack. # @option options [String] :role_arn - # 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. + # 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, @@ -844,30 +831,20 @@ def delete(options = {}) # @param [Hash] options ({}) # @option options [String] :template_body # 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][1] in the *CloudFormation User Guide*.) + # 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`. - # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html # @option options [String] :template_url # 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][1] in the - # *CloudFormation User Guide*. The location for an Amazon S3 bucket must - # start with `https://`. + # 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`. - # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html # @option options [Boolean] :use_previous_template # Reuse the existing template that is associated with the stack that you # are updating. @@ -911,10 +888,9 @@ def delete(options = {}) # * `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. + # 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. @@ -945,8 +921,8 @@ def delete(options = {}) # # * [AWS::IAM::UserToGroupAddition][7] # - # For more information, see [Acknowledging IAM Resources in - # CloudFormation Templates][8]. + # For more information, see [Acknowledging IAM resources in + # CloudFormation templates][8]. # # * `CAPABILITY_AUTO_EXPAND` # @@ -975,8 +951,8 @@ def delete(options = {}) # can update the function operation without CloudFormation being # notified. # - # For more information, see [Using CloudFormation Macros to Perform - # Custom Processing on Templates][11]. + # For more information, see [Perform custom processing on + # CloudFormation templates with template macros][11]. # # Only one of the `Capabilities` and `ResourceType` parameters can be # specified. @@ -985,14 +961,14 @@ def delete(options = {}) # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html - # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html + # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html # [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html - # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html + # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html # [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html - # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html - # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html - # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities + # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html + # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html + # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities # [9]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html # [10]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html # [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html @@ -1003,10 +979,10 @@ def delete(options = {}) # # 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][1]. + # 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][1]. # # Only one of the `Capabilities` and `ResourceType` parameters can be # specified. @@ -1017,13 +993,13 @@ def delete(options = {}) # # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html # @option options [String] :role_arn - # 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. + # 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, diff --git a/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource.rb b/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource.rb index 5fecd7faf3e..0ec8d868d8a 100644 --- a/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource.rb +++ b/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource.rb @@ -56,8 +56,9 @@ def physical_resource_id data[:physical_resource_id] end - # Type of resource. For more information, go to [Amazon Web Services - # Resource Types Reference][1] in the *CloudFormation User Guide*. + # Type of resource. For more information, see [Amazon Web Services + # resource and property types reference][1] in the *CloudFormation User + # Guide*. # # # @@ -92,7 +93,7 @@ def description end # The content of the `Metadata` attribute declared for the resource. For - # more information, see [Metadata Attribute][1] in the *CloudFormation + # more information, see [Metadata attribute][1] in the *CloudFormation # User Guide*. # # @@ -106,8 +107,8 @@ def metadata # 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][1]. + # For more information, see [Detect unmanaged configuration changes to + # stacks and resources with drift detection][1]. # # # diff --git a/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource_summary.rb b/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource_summary.rb index cb43969a447..ad390abaa4a 100644 --- a/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource_summary.rb +++ b/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/stack_resource_summary.rb @@ -50,8 +50,9 @@ def physical_resource_id data[:physical_resource_id] end - # Type of resource. (For more information, go to [Amazon Web Services - # Resource Types Reference][1] in the *CloudFormation User Guide*.) + # Type of resource. (For more information, see [Amazon Web Services + # resource and property types reference][1] in the *CloudFormation User + # Guide*.) # # # @@ -82,8 +83,8 @@ def resource_status_reason # 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][1]. + # For more information, see [Detect unmanaged configuration changes to + # stacks and resources with drift detection][1]. # # # diff --git a/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb b/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb index c8ebe2de579..f07145f610c 100644 --- a/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb +++ b/gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb @@ -86,8 +86,8 @@ class AccountGateResult < Struct.new( # * Number of stack outputs # # For more information about these account limits, and other - # CloudFormation limits, see [CloudFormation quotas][1] in the - # *CloudFormation User Guide*. + # CloudFormation limits, see [Understand CloudFormation quotas][1] in + # the *CloudFormation User Guide*. # # # @@ -330,7 +330,7 @@ class BatchDescribeTypeConfigurationsOutput < Struct.new( # An error occurred during a CloudFormation registry operation. # # @!attribute [rw] message - # An message with details about the error that occurred. + # A message with details about the error that occurred. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CFNRegistryException AWS API Documentation @@ -631,14 +631,13 @@ class ConcurrentResourcesLimitExceededException < Aws::EmptyStructure; end # @return [String] # # @!attribute [rw] role_arn - # 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. + # 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, @@ -680,8 +679,8 @@ class ConcurrentResourcesLimitExceededException < Aws::EmptyStructure; end # # 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][2]. + # rollback operation with nested stacks, see [Continue rolling back + # from failed nested stack updates][2]. # # # @@ -765,9 +764,8 @@ class ContinueUpdateRollbackOutput < Aws::EmptyStructure; end # # 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. + # 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. @@ -826,8 +824,8 @@ class ContinueUpdateRollbackOutput < Aws::EmptyStructure; end # # # - # For more information about macros, see [Using CloudFormation - # macros to perform custom processing on templates][11]. + # For more information about macros, see [Perform custom processing + # on CloudFormation templates with template macros][11]. # # Only one of the `Capabilities` and `ResourceType` parameters can be # specified. @@ -836,14 +834,14 @@ class ContinueUpdateRollbackOutput < Aws::EmptyStructure; end # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html - # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html + # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html # [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html - # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html + # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html # [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html - # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html - # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html - # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities + # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html + # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html + # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities # [9]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html # [10]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html # [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html @@ -856,11 +854,10 @@ class ContinueUpdateRollbackOutput < Aws::EmptyStructure; end # # 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][1] in the - # *CloudFormation User Guide*. + # 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][1] in the *CloudFormation User Guide*. # # Only one of the `Capabilities` and `ResourceType` parameters can be # specified. @@ -873,13 +870,13 @@ class ContinueUpdateRollbackOutput < Aws::EmptyStructure; end # @return [Array] # # @!attribute [rw] role_arn - # 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. + # 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, @@ -894,10 +891,9 @@ class ContinueUpdateRollbackOutput < Aws::EmptyStructure; end # @return [Types::RollbackConfiguration] # # @!attribute [rw] notification_arns - # 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. + # 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. # @return [Array] # # @!attribute [rw] tags @@ -935,16 +931,12 @@ class ContinueUpdateRollbackOutput < Aws::EmptyStructure; end # # 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][1] state until you - # execute the change set. + # 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. - # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html#d0e11995 # @return [String] # # @!attribute [rw] resources_to_import @@ -993,8 +985,9 @@ class ContinueUpdateRollbackOutput < Aws::EmptyStructure; end # templates. For more information, see [name type][1] 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][2] in the *CloudFormation User Guide*. + # instead. For more information, see [Import Amazon Web Services + # resources into a CloudFormation stack with a resource import][2] in + # the *CloudFormation User Guide*. # # # @@ -1110,30 +1103,20 @@ class CreateGeneratedTemplateOutput < Struct.new( # # @!attribute [rw] template_body # 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][1] in the *CloudFormation User Guide*. + # byte and a maximum length of 51,200 bytes. # # Conditional: You must specify either the `TemplateBody` or the # `TemplateURL` parameter, but not both. - # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html # @return [String] # # @!attribute [rw] template_url # 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][1] in the *CloudFormation User Guide*. The - # location for an Amazon S3 bucket must start with `https://`. + # 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. - # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html # @return [String] # # @!attribute [rw] parameters @@ -1166,10 +1149,9 @@ class CreateGeneratedTemplateOutput < Struct.new( # @return [Integer] # # @!attribute [rw] notification_arns - # 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). + # 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). # @return [Array] # # @!attribute [rw] capabilities @@ -1181,9 +1163,8 @@ class CreateGeneratedTemplateOutput < Struct.new( # # 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. + # 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. @@ -1214,8 +1195,8 @@ class CreateGeneratedTemplateOutput < Struct.new( # # * [AWS::IAM::UserToGroupAddition][7] # - # For more information, see [Acknowledging IAM Resources in - # CloudFormation Templates][8]. + # For more information, see [Acknowledging IAM resources in + # CloudFormation templates][8]. # # * `CAPABILITY_AUTO_EXPAND` # @@ -1244,8 +1225,8 @@ class CreateGeneratedTemplateOutput < Struct.new( # owner can update the function operation without CloudFormation # being notified. # - # For more information, see [Using CloudFormation macros to perform - # custom processing on templates][11]. + # For more information, see [Perform custom processing on + # CloudFormation templates with template macros][11]. # # Only one of the `Capabilities` and `ResourceType` parameters can be # specified. @@ -1254,14 +1235,14 @@ class CreateGeneratedTemplateOutput < Struct.new( # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html - # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html + # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html # [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html - # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html + # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html # [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html - # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html - # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html - # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities + # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html + # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html + # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities # [9]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html # [10]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html # [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html @@ -1280,11 +1261,10 @@ class CreateGeneratedTemplateOutput < Struct.new( # # 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][1]. + # 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][1]. # # Only one of the `Capabilities` and `ResourceType` parameters can be # specified. @@ -1297,14 +1277,13 @@ class CreateGeneratedTemplateOutput < Struct.new( # @return [Array] # # @!attribute [rw] role_arn - # 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. + # 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, @@ -1321,8 +1300,8 @@ class CreateGeneratedTemplateOutput < Struct.new( # @return [String] # # @!attribute [rw] stack_policy_body - # Structure containing the stack policy body. For more information, go - # to [ Prevent Updates to Stack Resources][1] in the *CloudFormation + # Structure containing the stack policy body. For more information, + # see [Prevent updates to stack resources][1] in the *CloudFormation # User Guide*. You can specify either the `StackPolicyBody` or the # `StackPolicyURL` parameter, but not both. # @@ -1371,9 +1350,9 @@ class CreateGeneratedTemplateOutput < Struct.new( # 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][1] in - # the *CloudFormation User Guide*. Termination protection is - # deactivated on stacks by default. + # more information, see [Protect CloudFormation stacks from being + # deleted][1] in the *CloudFormation User Guide*. Termination + # protection is deactivated on stacks by default. # # For [nested stacks][2], termination protection is set on the root # stack and can't be changed directly on the nested stack. @@ -1586,31 +1565,19 @@ class CreateStackOutput < Struct.new( # # @!attribute [rw] template_body # 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][1] in the *CloudFormation User - # Guide*. + # 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. - # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html # @return [String] # # @!attribute [rw] template_url # 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][1] in the *CloudFormation - # User Guide*. + # 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. - # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html # @return [String] # # @!attribute [rw] stack_id @@ -1631,9 +1598,8 @@ class CreateStackOutput < Struct.new( # # 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. + # 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. @@ -1664,8 +1630,8 @@ class CreateStackOutput < Struct.new( # # * [AWS::IAM::UserToGroupAddition][7] # - # For more information, see [Acknowledging IAM Resources in - # CloudFormation Templates][8]. + # For more information, see [Acknowledging IAM resources in + # CloudFormation templates][8]. # # * `CAPABILITY_AUTO_EXPAND` # @@ -1687,14 +1653,14 @@ class CreateStackOutput < Struct.new( # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html - # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html + # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html # [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html - # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html + # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html # [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html - # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html - # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html - # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities + # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html + # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html + # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities # [9]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html # [10]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html # [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html @@ -1957,10 +1923,9 @@ class DeleteGeneratedTemplateInput < Struct.new( # @return [Array] # # @!attribute [rw] role_arn - # 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. + # 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, @@ -2050,7 +2015,7 @@ class DeleteStackInput < Struct.new( # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html#stackset-ops-options # @return [Boolean] # # @!attribute [rw] operation_id @@ -2466,9 +2431,8 @@ class DescribeChangeSetInput < Struct.new( # @return [String] # # @!attribute [rw] notification_arns - # The ARNs of the Amazon Simple Notification Service (Amazon SNS) - # topics that will be associated with the stack if you execute the - # change set. + # The ARNs of the Amazon SNS topics that will be associated with the + # stack if you execute the change set. # @return [Array] # # @!attribute [rw] rollback_configuration @@ -3121,11 +3085,11 @@ class DescribeStackResourceDriftsInput < Struct.new( # 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][1]. + # [Resource type support for imports and drift detection][1]. # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html # @return [Array] # # @!attribute [rw] next_token @@ -3538,7 +3502,7 @@ class DescribeTypeInput < Struct.new( # 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][1] in the *CloudFormation - # Command Line Interface User Guide*. + # Command Line Interface (CLI) User Guide*. # # * `FAILED`: The extension has failed one or more contract tests. # @@ -3570,8 +3534,9 @@ class DescribeTypeInput < Struct.new( # @!attribute [rw] schema # The schema that defines the extension. # - # For more information about extension schemas, see [Resource Provider - # Schema][1] in the *CloudFormation CLI User Guide*. + # For more information about extension schemas, see [Resource type + # schema][1] in the *CloudFormation Command Line Interface (CLI) User + # Guide*. # # # @@ -3705,14 +3670,14 @@ class DescribeTypeInput < Struct.new( # extension in this account and Region. # # To set the configuration data for an extension, use - # [SetTypeConfiguration][1]. For more information, see [Configuring - # extensions at the account level][2] in the *CloudFormation User - # Guide*. + # [SetTypeConfiguration][1]. For more information, see [Edit + # configuration data for extensions in your account][2] in the + # *CloudFormation User Guide*. # # # # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html - # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-private.html#registry-set-configuration + # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html # @return [String] # # @!attribute [rw] publisher_id @@ -3730,9 +3695,8 @@ class DescribeTypeInput < Struct.new( # 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][1] in the *CloudFormation User - # Guide*. + # name of the public extension. For more information, see [Use aliases + # to refer to extensions][1] in the *CloudFormation User Guide*. # # # @@ -3773,13 +3737,12 @@ class DescribeTypeInput < Struct.new( # 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][1] in the *CloudFormation User - # Guide*. + # be manually updated. For more information, see [Automatically use + # new versions of extensions][1] in the *CloudFormation User Guide*. # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeTypeOutput AWS API Documentation @@ -3945,7 +3908,7 @@ class DetectStackResourceDriftOutput < Struct.new( # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html#stackset-ops-options # @return [Types::StackSetOperationPreferences] # # @!attribute [rw] operation_id @@ -4008,30 +3971,20 @@ class DetectStackSetDriftOutput < Struct.new( # # @!attribute [rw] template_body # 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][1] in the *CloudFormation User Guide*.) + # byte and a maximum length of 51,200 bytes. # # Conditional: You must pass `TemplateBody` or `TemplateURL`. If both # are passed, only `TemplateBody` is used. - # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html # @return [String] # # @!attribute [rw] template_url # 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][1] - # in the *CloudFormation User Guide*. The location for an Amazon S3 - # bucket must start with `https://`. + # 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. - # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html # @return [String] # # @!attribute [rw] parameters @@ -4247,8 +4200,8 @@ class GetStackPolicyInput < Struct.new( # # @!attribute [rw] stack_policy_body # Structure containing the stack policy body. (For more information, - # go to [ Prevent Updates to Stack Resources][1] in the - # *CloudFormation User Guide*.) + # see [Prevent updates to stack resources][1] in the *CloudFormation + # User Guide*.) # # # @@ -4307,15 +4260,10 @@ class GetTemplateInput < Struct.new( # The output for GetTemplate action. # # @!attribute [rw] template_body - # Structure containing the template body. (For more information, go to - # [Template Anatomy][1] in the *CloudFormation User Guide*.) + # Structure containing the template body. # # CloudFormation returns the same template that was used when the # stack was created. - # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html # @return [String] # # @!attribute [rw] stages_available @@ -4339,32 +4287,20 @@ class GetTemplateOutput < Struct.new( # # @!attribute [rw] template_body # 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][1] in the *CloudFormation - # User Guide*. + # byte and a maximum length of 51,200 bytes. # # Conditional: You must specify only one of the following parameters: # `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`. - # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html # @return [String] # # @!attribute [rw] template_url # 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][1] in the *CloudFormation User - # Guide*. The location for an Amazon S3 bucket must start with - # `https://`. + # 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`. - # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html # @return [String] # # @!attribute [rw] stack_name @@ -4444,12 +4380,12 @@ class GetTemplateSummaryInput < Struct.new( # CreateStack or UpdateStack actions with your template; otherwise, # those actions return an `InsufficientCapabilities` error. # - # For more information, see [Acknowledging IAM Resources in - # CloudFormation Templates][1]. + # For more information, see [Acknowledging IAM resources in + # CloudFormation templates][1]. # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities # @return [Array] # # @!attribute [rw] capabilities_reason @@ -4538,7 +4474,7 @@ class GetTemplateSummaryOutput < Struct.new( # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html#stackset-ops-options # @return [Types::StackSetOperationPreferences] # # @!attribute [rw] operation_id @@ -5923,9 +5859,9 @@ class ManagedExecution < Struct.new( # 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][1] in the *CloudFormation User - # Guide*. + # For more information about modules, see [Create reusable resource + # configurations that can be included across templates with + # CloudFormation modules][1] in the *CloudFormation User Guide*. # # # @@ -5953,12 +5889,12 @@ class ManagedExecution < Struct.new( # # `moduleA/moduleB` # - # For more information, see [Referencing resources in a module][1] in - # the *CloudFormation User Guide*. + # For more information, see [Reference module resources in + # CloudFormation templates][1] in the *CloudFormation User Guide*. # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html#module-ref-resources + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/module-ref-resources.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ModuleInfo AWS API Documentation @@ -6073,13 +6009,15 @@ class Output < Struct.new( # @return [Boolean] # # @!attribute [rw] resolved_value - # Read-only. The value that corresponds to a SSM parameter key. This - # field is returned only for [ SSM][1] parameter types in the - # template. + # 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][1] in the *CloudFormation + # User Guide*. # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-supplied-parameter-types.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/Parameter AWS API Documentation @@ -6176,8 +6114,8 @@ class PhysicalResourceIdContextKeyValuePair < Struct.new( # 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][1]. + # information, see [Detect unmanaged configuration changes to stacks and + # resources with drift detection][1]. # # # @@ -6377,9 +6315,9 @@ class RecordHandlerProgressOutput < Aws::EmptyStructure; end # verification, the Amazon Resource Name (ARN) for your connection to # that account. # - # For more information, see [Registering your account to publish - # CloudFormation extensions][1] in the *CloudFormation CLI User - # Guide*. + # For more information, see [Prerequisite: Registering your account to + # publish CloudFormation extensions][1] in the *CloudFormation Command + # Line Interface (CLI) User Guide*. # # # @@ -6417,13 +6355,11 @@ class RegisterPublisherOutput < Struct.new( # # We suggest that extension names adhere to the following patterns: # - # * For resource types, - # *company\_or\_organization*::*service*::*type*. + # * For resource types, `company_or_organization::service::type`. # - # * For modules, - # *company\_or\_organization*::*service*::*type*::MODULE. + # * For modules, `company_or_organization::service::type::MODULE`. # - # * For hooks, *MyCompany*::*Testing*::*MyTestHook*. + # * For hooks, `MyCompany::Testing::MyTestHook`. # # The following organization namespaces are reserved and can't be # used in your extension names: @@ -6449,7 +6385,7 @@ class RegisterPublisherOutput < Struct.new( # # For information about generating a schema handler package for the # extension you want to register, see [submit][1] in the - # *CloudFormation CLI User Guide*. + # *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 @@ -6537,12 +6473,12 @@ class RegisterTypeOutput < Struct.new( # 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][1] in the *CloudFormation User Guide*. + # For more information, see [Requirements for activating third-party + # public modules][1] in the *CloudFormation User Guide*. # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html#module-enabling + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/module-versioning.html#requirements-for-modules # # @!attribute [rw] type_name_alias # An alias assigned to the public extension, in this account and @@ -6558,9 +6494,8 @@ class RegisterTypeOutput < Struct.new( # 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][1] in the *CloudFormation User - # Guide*. + # name of the public extension. For more information, see [Use aliases + # to refer to extensions][1] in the *CloudFormation User Guide*. # # # @@ -6638,12 +6573,12 @@ class RequiredActivatedType < Struct.new( # `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`. + # 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 `Conditionally`, and then `Never`. + # impact, followed by `Conditional`, and then `Never`. # @return [String] # # @!attribute [rw] scope @@ -6784,8 +6719,8 @@ class ResourceChangeDetail < Struct.new( # # @!attribute [rw] resource_type # The type of the resource, such as `AWS::DynamoDB::Table`. For the - # list of supported resources, see [IaC generator supported resource - # types][1] in the *CloudFormation User Guide* + # list of supported resources, see [Resource type support for imports + # and drift detection][1] in the *CloudFormation User Guide* # # # @@ -6805,8 +6740,7 @@ class ResourceChangeDetail < Struct.new( # `AWS::DynamoDB::Table` resource, the primary identifiers is # `TableName` so the key-value pair could be `"TableName": # "MyDDBTable"`. For more information, see [primaryIdentifier][1] in - # the *CloudFormation Command Line Interface User guide for extension - # development*. + # the *CloudFormation Command Line Interface (CLI) User Guide*. # # # @@ -6827,8 +6761,8 @@ class ResourceDefinition < Struct.new( # # @!attribute [rw] resource_type # The type of the resource, such as `AWS::DynamoDB::Table`. For the - # list of supported resources, see [IaC generator supported resource - # types][1] In the *CloudFormation User Guide* + # list of supported resources, see [Resource type support for imports + # and drift detection][1] In the *CloudFormation User Guide* # # # @@ -6848,8 +6782,7 @@ class ResourceDefinition < Struct.new( # `AWS::DynamoDB::Table` resource, the primary identifiers is # `TableName` so the key-value pair could be `"TableName": # "MyDDBTable"`. For more information, see [primaryIdentifier][1] in - # the *CloudFormation Command Line Interface User guide for extension - # development*. + # the *CloudFormation Command Line Interface (CLI) User Guide*. # # # @@ -7033,7 +6966,8 @@ class ResourceScanSummary < Struct.new( # 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][1] in the *CloudFormation User Guide*. + # for that property in the [Amazon Web Services resource and property + # types reference][1] in the *CloudFormation User Guide*. # # # @@ -7084,8 +7018,8 @@ class ResourceTargetDefinition < Struct.new( # @!attribute [rw] resource_type # 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][1] in the *CloudFormation - # User Guide*. + # [Resource type support for imports and drift detection][1] in the + # *CloudFormation User Guide*. # # # @@ -7120,8 +7054,8 @@ class ResourceToImport < Struct.new( # 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][1]. + # of the alarms you've specified. For more information, see [Roll back + # your CloudFormation stack on alarm breach with rollback triggers][1]. # # # @@ -7191,8 +7125,8 @@ class RollbackConfiguration < Struct.new( # @return [String] # # @!attribute [rw] role_arn - # The Amazon Resource Name (ARN) of an Identity and Access Management - # role that CloudFormation assumes to rollback the stack. + # The Amazon Resource Name (ARN) of an IAM role that CloudFormation + # assumes to rollback the stack. # @return [String] # # @!attribute [rw] client_request_token @@ -7250,7 +7184,7 @@ class RollbackStackOutput < Struct.new( # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html # @return [String] # @@ -7268,8 +7202,8 @@ class RollbackTrigger < Struct.new( # # @!attribute [rw] resource_type # The type of the resource, such as `AWS::DynamoDB::Table`. For the - # list of supported resources, see [Resource type support][1] In the - # *CloudFormation User Guide* + # list of supported resources, see [Resource type support for imports + # and drift detection][1] In the *CloudFormation User Guide* # # # @@ -7285,8 +7219,7 @@ class RollbackTrigger < Struct.new( # `AWS::DynamoDB::Table` resource, the primary identifiers is # `TableName` so the key-value pair could be `"TableName": # "MyDDBTable"`. For more information, see [primaryIdentifier][1] in - # the *CloudFormation Command Line Interface User guide for extension - # development*. + # the *CloudFormation Command Line Interface (CLI) User Guide*. # # # @@ -7312,8 +7245,8 @@ class ScannedResource < Struct.new( # # @!attribute [rw] resource_type # The type of the resource, such as `AWS::DynamoDB::Table`. For the - # list of supported resources, see [IaC generator supported resource - # types][1] In the *CloudFormation User Guide*. + # list of supported resources, see [Resource type support for imports + # and drift detection][1] In the *CloudFormation User Guide*. # # # @@ -7329,8 +7262,7 @@ class ScannedResource < Struct.new( # `AWS::DynamoDB::Table` resource, the primary identifiers is # `TableName` so the key-value pair could be `"TableName": # "MyDDBTable"`. For more information, see [primaryIdentifier][1] in - # the *CloudFormation Command Line Interface User guide for extension - # development*. + # the *CloudFormation Command Line Interface (CLI) User Guide*. # # # @@ -7354,8 +7286,8 @@ class ScannedResourceIdentifier < Struct.new( # @return [String] # # @!attribute [rw] stack_policy_body - # Structure containing the stack policy body. For more information, go - # to [ Prevent updates to stack resources][1] in the *CloudFormation + # Structure containing the stack policy body. For more information, + # see [Prevent updates to stack resources][1] in the *CloudFormation # User Guide*. You can specify either the `StackPolicyBody` or the # `StackPolicyURL` parameter, but not both. # @@ -7409,8 +7341,8 @@ class SetStackPolicyInput < Struct.new( # The configuration data must be formatted as JSON, and validate # against the schema returned in the `ConfigurationSchema` response # element of [DescribeType][1]. For more information, see [Defining - # account-level configuration data for an extension][2] in the - # *CloudFormation CLI User Guide*. + # the account-level configuration of an extension][2] in the + # *CloudFormation Command Line Interface (CLI) User Guide*. # # # @@ -7622,10 +7554,9 @@ class SignalResourceInput < Struct.new( # @return [Array] # # @!attribute [rw] role_arn - # 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. + # 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. # @return [String] # # @!attribute [rw] tags @@ -7637,8 +7568,8 @@ class SignalResourceInput < Struct.new( # # For [nested stacks][1], 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][2] in the - # *CloudFormation User Guide*. + # information, see [Protect a CloudFormation stack from being + # deleted][2] in the *CloudFormation User Guide*. # # # @@ -7652,8 +7583,8 @@ class SignalResourceInput < Struct.new( # first level of nested stacks, the root stack is also the parent # stack. # - # For more information, see [Working with Nested Stacks][1] in the - # *CloudFormation User Guide*. + # For more information, see [Embed stacks within other stacks using + # nested stacks][1] in the *CloudFormation User Guide*. # # # @@ -7665,8 +7596,8 @@ class SignalResourceInput < Struct.new( # stack--the stack ID of the top-level stack to which the nested stack # ultimately belongs. # - # For more information, see [Working with Nested Stacks][1] in the - # *CloudFormation User Guide*. + # For more information, see [Embed stacks within other stacks using + # nested stacks][1] in the *CloudFormation User Guide*. # # # @@ -7677,8 +7608,8 @@ class SignalResourceInput < Struct.new( # 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][1]. + # more information, see [Detect unmanaged configuration changes to + # stacks and resources with drift detection][1]. # # # @@ -7709,8 +7640,8 @@ class SignalResourceInput < Struct.new( # 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][1] in the - # *CloudFormation User Guide*. + # more information, see [Understand CloudFormation stack creation + # events][1] in the *CloudFormation User Guide*. # # # @@ -7849,8 +7780,9 @@ class StackDriftInformationSummary < Struct.new( # @return [String] # # @!attribute [rw] resource_type - # Type of resource. (For more information, go to [Amazon Web Services - # Resource Types Reference][1] in the *CloudFormation User Guide*.) + # Type of resource. For more information, see [Amazon Web Services + # resource and property types reference][1] in the *CloudFormation + # User Guide*. # # # @@ -7922,8 +7854,9 @@ class StackDriftInformationSummary < Struct.new( # of the stack event. # # * `CONFIGURATION_COMPLETE` - all of the resources in the stack have - # reached that event. For more information, see [CloudFormation - # stack deployment][1] in the *CloudFormation User Guide*. + # reached that event. For more information, see [Understand + # CloudFormation stack creation events][1] in the *CloudFormation + # User Guide*. # # ^ # ^ @@ -7963,8 +7896,8 @@ class StackEvent < Struct.new( include Aws::Structure end - # 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 + # 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 @@ -8192,8 +8125,9 @@ class StackInstanceNotFoundException < Aws::EmptyStructure; end # @return [Array] # # @!attribute [rw] resource_type - # Type of resource. For more information, go to [Amazon Web Services - # Resource Types Reference][1] in the *CloudFormation User Guide*. + # Type of resource. For more information, see [Amazon Web Services + # resource and property types reference][1] in the *CloudFormation + # User Guide*. # # # @@ -8387,8 +8321,9 @@ class StackNotFoundException < Aws::EmptyStructure; end # @return [String] # # @!attribute [rw] resource_type - # Type of resource. For more information, go to [Amazon Web Services - # Resource Types Reference][1] in the *CloudFormation User Guide*. + # Type of resource. For more information, see [Amazon Web Services + # resource and property types reference][1] in the *CloudFormation + # User Guide*. # # # @@ -8415,8 +8350,9 @@ class StackNotFoundException < Aws::EmptyStructure; end # 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][1]. + # parameters. For more information, see [Detect unmanaged + # configuration changes to stacks and resources with drift + # detection][1]. # # # @@ -8467,8 +8403,9 @@ class StackResource < Struct.new( # @return [String] # # @!attribute [rw] resource_type - # Type of resource. For more information, go to [Amazon Web Services - # Resource Types Reference][1] in the *CloudFormation User Guide*. + # Type of resource. For more information, see [Amazon Web Services + # resource and property types reference][1] in the *CloudFormation + # User Guide*. # # # @@ -8493,7 +8430,7 @@ class StackResource < Struct.new( # # @!attribute [rw] metadata # The content of the `Metadata` attribute declared for the resource. - # For more information, see [Metadata Attribute][1] in the + # For more information, see [Metadata attribute][1] in the # *CloudFormation User Guide*. # # @@ -8505,8 +8442,9 @@ class StackResource < Struct.new( # 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][1]. + # parameters. For more information, see [Detect unmanaged + # configuration changes to stacks and resources with drift + # detection][1]. # # # @@ -8542,12 +8480,12 @@ class StackResourceDetail < Struct.new( # 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][1]. + # drift. For more information, see [Detect unmanaged configuration + # changes to stacks and resources with drift detection][1]. # # 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][2]. + # [Resource type support for imports and drift detection][2]. # # Use DetectStackResourceDrift to detect drift on individual resources, # or DetectStackDrift to detect drift on all resources in a given stack @@ -8556,7 +8494,7 @@ class StackResourceDetail < Struct.new( # # # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html - # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html + # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html # # @!attribute [rw] stack_id # The ID of the stack. @@ -8670,15 +8608,15 @@ class StackResourceDrift < Struct.new( # 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][1]. + # status of `NOT_CHECKED`. For more information, see [Resource type + # support for imports and drift detection][1]. # # * `IN_SYNC`: The resource's actual configuration matches its # expected configuration. # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html # @return [String] # # @!attribute [rw] last_check_timestamp @@ -8712,20 +8650,20 @@ class StackResourceDriftInformation < Struct.new( # 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][1]. If you performed an + # status of `NOT_CHECKED`. For more information, see [Resource type + # support for imports and drift detection][1]. 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][2] in the CloudFormation User Guide. + # during rollback operations, see [Continue rolling back an + # update][2] in the *CloudFormation User Guide*. # # * `IN_SYNC`: The resource's actual configuration matches its # expected configuration. # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html # @return [String] # @@ -8755,8 +8693,9 @@ class StackResourceDriftInformationSummary < Struct.new( # @return [String] # # @!attribute [rw] resource_type - # Type of resource. (For more information, go to [Amazon Web Services - # Resource Types Reference][1] in the *CloudFormation User Guide*.) + # Type of resource. (For more information, see [Amazon Web Services + # resource and property types reference][1] in the *CloudFormation + # User Guide*.) # # # @@ -8779,8 +8718,9 @@ class StackResourceDriftInformationSummary < Struct.new( # 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][1]. + # parameters. For more information, see [Detect unmanaged + # configuration changes to stacks and resources with drift + # detection][1]. # # # @@ -8845,11 +8785,11 @@ class StackResourceSummary < Struct.new( # 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.][1] + # see [Acknowledging IAM resources in CloudFormation templates][1]. # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities # @return [Array] # # @!attribute [rw] tags @@ -9163,7 +9103,7 @@ class StackSetNotFoundException < Aws::EmptyStructure; end # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html#stackset-status-codes # @return [String] # # @!attribute [rw] operation_preferences @@ -9229,8 +9169,8 @@ class StackSetNotFoundException < Aws::EmptyStructure; end # 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][1] in the *CloudFormation User Guide*. + # For more information, see [Detect stack set drift][1] in the + # *CloudFormation User Guide*. # # # @@ -9274,7 +9214,7 @@ class StackSetOperation < Struct.new( # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html#stackset-ops-options # # @!attribute [rw] region_concurrency_type # The concurrency type of deploying StackSets operations in Regions, @@ -9521,7 +9461,7 @@ class StackSetOperationStatusDetails < Struct.new( # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html#stackset-status-codes # @return [String] # # @!attribute [rw] creation_timestamp @@ -9557,7 +9497,7 @@ class StackSetOperationStatusDetails < Struct.new( # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html#stackset-ops-options # @return [Types::StackSetOperationPreferences] # # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackSetOperationSummary AWS API Documentation @@ -9711,8 +9651,8 @@ class StackSetSummary < Struct.new( # first level of nested stacks, the root stack is also the parent # stack. # - # For more information, see [Working with Nested Stacks][1] in the - # *CloudFormation User Guide*. + # For more information, see [Embed stacks within other stacks using + # nested stacks][1] in the *CloudFormation User Guide*. # # # @@ -9724,8 +9664,8 @@ class StackSetSummary < Struct.new( # stack--the stack ID of the top-level stack to which the nested stack # ultimately belongs. # - # For more information, see [Working with Nested Stacks][1] in the - # *CloudFormation User Guide*. + # For more information, see [Embed stacks within other stacks using + # nested stacks][1] in the *CloudFormation User Guide*. # # # @@ -9736,8 +9676,9 @@ class StackSetSummary < Struct.new( # 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][1]. + # parameters. For more information, see [Detect unmanaged + # configuration changes to stacks and resources with drift + # detection][1]. # # # @@ -9851,7 +9792,7 @@ class StopStackSetOperationOutput < Aws::EmptyStructure; end # @!attribute [rw] key # *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:`. + # Services have the reserved prefix: `aws:`. # @return [String] # # @!attribute [rw] value @@ -10102,8 +10043,8 @@ class TemplateSummaryConfig < Struct.new( # * `PutObject` # # For more information, see [Actions, Resources, and Condition Keys - # for Amazon S3][1] in the *Amazon Web Services Identity and Access - # Management User Guide*. + # for Amazon S3][1] in the *Identity and Access Management User + # Guide*. # # # @@ -10143,12 +10084,12 @@ class TokenAlreadyExistsException < Aws::EmptyStructure; end # 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][1] in the *CloudFormation User Guide*. + # For more information, see [Edit configuration data for extensions in + # your account][1] in the *CloudFormation User Guide*. # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-private.html#registry-set-configuration + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html # # @!attribute [rw] arn # The Amazon Resource Name (ARN) for the configuration data, in this @@ -10393,9 +10334,8 @@ class TypeNotFoundException < Aws::EmptyStructure; end # 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][1] in the *CloudFormation User - # Guide*. + # name of the public extension. For more information, see [Use aliases + # to refer to extensions][1] in the *CloudFormation User Guide*. # # # @@ -10410,8 +10350,8 @@ class TypeNotFoundException < Aws::EmptyStructure; end # 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][1] in the *CloudFormation User Guide*. + # information, see [Automatically use new versions of extensions][1] + # in the *CloudFormation User Guide*. # # # @@ -10421,14 +10361,14 @@ class TypeNotFoundException < Aws::EmptyStructure; end # @!attribute [rw] latest_public_version # 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 + # 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 [Setting CloudFormation to automatically use new - # versions of extensions][1] in the *CloudFormation User Guide*. + # information, see [Automatically use new versions of extensions][1] + # in the *CloudFormation User Guide*. # # # @@ -10438,9 +10378,9 @@ class TypeNotFoundException < Aws::EmptyStructure; end # @!attribute [rw] publisher_identity # The service used to verify the publisher identity. # - # For more information, see [Registering your account to publish - # CloudFormation extensions][1] in the CFN-CLI User Guide for - # Extension Development. + # For more information, see [Publishing extensions to make them + # available for public use][1] in the *CloudFormation Command Line + # Interface (CLI) User Guide*. # # # @@ -10521,14 +10461,14 @@ class TypeSummary < Struct.new( # 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, + # 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 [Setting CloudFormation to automatically use new - # versions of extensions][1] in the *CloudFormation User Guide*. + # information, see [Automatically use new versions of extensions][1] + # in the *CloudFormation User Guide*. # # # @@ -10618,32 +10558,22 @@ class UpdateGeneratedTemplateOutput < Struct.new( # # @!attribute [rw] template_body # 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][1] in the *CloudFormation User Guide*.) + # 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`. - # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html # @return [String] # # @!attribute [rw] template_url # 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][1] - # in the *CloudFormation User Guide*. The location for an Amazon S3 - # bucket must start with `https://`. + # 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`. - # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html # @return [String] # # @!attribute [rw] use_previous_template @@ -10697,10 +10627,9 @@ class UpdateGeneratedTemplateOutput < Struct.new( # * `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. + # 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. @@ -10731,8 +10660,8 @@ class UpdateGeneratedTemplateOutput < Struct.new( # # * [AWS::IAM::UserToGroupAddition][7] # - # For more information, see [Acknowledging IAM Resources in - # CloudFormation Templates][8]. + # For more information, see [Acknowledging IAM resources in + # CloudFormation templates][8]. # # * `CAPABILITY_AUTO_EXPAND` # @@ -10761,8 +10690,8 @@ class UpdateGeneratedTemplateOutput < Struct.new( # owner can update the function operation without CloudFormation # being notified. # - # For more information, see [Using CloudFormation Macros to Perform - # Custom Processing on Templates][11]. + # For more information, see [Perform custom processing on + # CloudFormation templates with template macros][11]. # # Only one of the `Capabilities` and `ResourceType` parameters can be # specified. @@ -10771,14 +10700,14 @@ class UpdateGeneratedTemplateOutput < Struct.new( # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html - # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html + # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html # [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html - # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html + # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html # [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html - # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html - # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html - # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities + # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html + # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html + # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities # [9]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html # [10]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html # [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html @@ -10791,10 +10720,10 @@ class UpdateGeneratedTemplateOutput < Struct.new( # # 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][1]. + # 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][1]. # # Only one of the `Capabilities` and `ResourceType` parameters can be # specified. @@ -10807,14 +10736,13 @@ class UpdateGeneratedTemplateOutput < Struct.new( # @return [Array] # # @!attribute [rw] role_arn - # 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. + # 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, @@ -11100,33 +11028,21 @@ class UpdateStackOutput < Struct.new( # # @!attribute [rw] template_body # 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][1] in the *CloudFormation User - # Guide*. + # 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. - # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html # @return [String] # # @!attribute [rw] template_url # 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][1] in the *CloudFormation - # User Guide*. + # 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. - # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html # @return [String] # # @!attribute [rw] use_previous_template @@ -11150,10 +11066,9 @@ class UpdateStackOutput < Struct.new( # * `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. + # 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. @@ -11184,8 +11099,8 @@ class UpdateStackOutput < Struct.new( # # * [AWS::IAM::UserToGroupAddition][7] # - # For more information, see [Acknowledging IAM Resources in - # CloudFormation Templates][8]. + # For more information, see [Acknowledging IAM resources in + # CloudFormation templates][8]. # # * `CAPABILITY_AUTO_EXPAND` # @@ -11207,14 +11122,14 @@ class UpdateStackOutput < Struct.new( # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html - # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html + # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html # [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html - # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html + # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html # [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html - # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html - # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html - # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities + # [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html + # [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html + # [8]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities # [9]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html # [10]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html # [11]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html @@ -11503,30 +11418,20 @@ class UpdateTerminationProtectionOutput < Struct.new( # # @!attribute [rw] template_body # 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][1] in the *CloudFormation User Guide*. + # byte and a maximum length of 51,200 bytes. # # Conditional: You must pass `TemplateURL` or `TemplateBody`. If both # are passed, only `TemplateBody` is used. - # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html # @return [String] # # @!attribute [rw] template_url # 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][1] in the *CloudFormation User Guide*. The - # location for an Amazon S3 bucket must start with `https://`. + # 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. - # - # - # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ValidateTemplateInput AWS API Documentation @@ -11555,12 +11460,12 @@ class ValidateTemplateInput < Struct.new( # CreateStack or UpdateStack actions with your template; otherwise, # those actions return an InsufficientCapabilities error. # - # For more information, see [Acknowledging IAM Resources in - # CloudFormation Templates][1]. + # For more information, see [Acknowledging IAM resources in + # CloudFormation templates][1]. # # # - # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities + # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities # @return [Array] # # @!attribute [rw] capabilities_reason @@ -11588,8 +11493,8 @@ class ValidateTemplateOutput < Struct.new( # template. # # @!attribute [rw] type - # The type of this warning. For more information, see [IaC generator - # and write-only properties][1] in the *CloudFormation User Guide*. + # The type of this warning. For more information, see [Resolve + # write-only properties][1] in the *CloudFormation User Guide*. # # * `MUTUALLY_EXCLUSIVE_PROPERTIES` - The resource requires # mutually-exclusive write-only properties. The IaC generator diff --git a/gems/aws-sdk-codebuild/CHANGELOG.md b/gems/aws-sdk-codebuild/CHANGELOG.md index c1d82a950ba..afc0d1ee5da 100644 --- a/gems/aws-sdk-codebuild/CHANGELOG.md +++ b/gems/aws-sdk-codebuild/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.133.0 (2024-10-15) +------------------ + +* Feature - Enable proxy for reserved capacity fleet. + 1.132.0 (2024-09-24) ------------------ diff --git a/gems/aws-sdk-codebuild/VERSION b/gems/aws-sdk-codebuild/VERSION index 82c65d83bbc..445cade7793 100644 --- a/gems/aws-sdk-codebuild/VERSION +++ b/gems/aws-sdk-codebuild/VERSION @@ -1 +1 @@ -1.132.0 +1.133.0 diff --git a/gems/aws-sdk-codebuild/lib/aws-sdk-codebuild.rb b/gems/aws-sdk-codebuild/lib/aws-sdk-codebuild.rb index bdfd04829ab..edeb4b8c8b5 100644 --- a/gems/aws-sdk-codebuild/lib/aws-sdk-codebuild.rb +++ b/gems/aws-sdk-codebuild/lib/aws-sdk-codebuild.rb @@ -54,7 +54,7 @@ module Plugins autoload :EndpointProvider, 'aws-sdk-codebuild/endpoint_provider' autoload :Endpoints, 'aws-sdk-codebuild/endpoints' - GEM_VERSION = '1.132.0' + GEM_VERSION = '1.133.0' end diff --git a/gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb b/gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb index 229fee713bd..1da35f2bd57 100644 --- a/gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb +++ b/gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client.rb @@ -847,6 +847,12 @@ def batch_get_builds(params = {}, options = {}) # resp.fleets[0].vpc_config.subnets[0] #=> String # resp.fleets[0].vpc_config.security_group_ids #=> Array # resp.fleets[0].vpc_config.security_group_ids[0] #=> String + # resp.fleets[0].proxy_configuration.default_behavior #=> String, one of "ALLOW_ALL", "DENY_ALL" + # resp.fleets[0].proxy_configuration.ordered_proxy_rules #=> Array + # resp.fleets[0].proxy_configuration.ordered_proxy_rules[0].type #=> String, one of "DOMAIN", "IP" + # resp.fleets[0].proxy_configuration.ordered_proxy_rules[0].effect #=> String, one of "ALLOW", "DENY" + # resp.fleets[0].proxy_configuration.ordered_proxy_rules[0].entities #=> Array + # resp.fleets[0].proxy_configuration.ordered_proxy_rules[0].entities[0] #=> String # resp.fleets[0].image_id #=> String # resp.fleets[0].fleet_service_role #=> String # resp.fleets[0].tags #=> Array @@ -970,7 +976,7 @@ def batch_get_fleets(params = {}, options = {}) # resp.projects[0].webhook.branch_filter #=> String # resp.projects[0].webhook.filter_groups #=> Array # resp.projects[0].webhook.filter_groups[0] #=> Array - # resp.projects[0].webhook.filter_groups[0][0].type #=> String, one of "EVENT", "BASE_REF", "HEAD_REF", "ACTOR_ACCOUNT_ID", "FILE_PATH", "COMMIT_MESSAGE", "WORKFLOW_NAME", "TAG_NAME", "RELEASE_NAME" + # resp.projects[0].webhook.filter_groups[0][0].type #=> String, one of "EVENT", "BASE_REF", "HEAD_REF", "ACTOR_ACCOUNT_ID", "FILE_PATH", "COMMIT_MESSAGE", "WORKFLOW_NAME", "TAG_NAME", "RELEASE_NAME", "REPOSITORY_NAME" # resp.projects[0].webhook.filter_groups[0][0].pattern #=> String # resp.projects[0].webhook.filter_groups[0][0].exclude_matched_pattern #=> Boolean # resp.projects[0].webhook.build_type #=> String, one of "BUILD", "BUILD_BATCH" @@ -1259,6 +1265,9 @@ def batch_get_reports(params = {}, options = {}) # @option params [Types::VpcConfig] :vpc_config # Information about the VPC configuration that CodeBuild accesses. # + # @option params [Types::ProxyConfiguration] :proxy_configuration + # The proxy configuration of the compute fleet. + # # @option params [String] :image_id # The Amazon Machine Image (AMI) of the compute fleet. # @@ -1304,6 +1313,16 @@ def batch_get_reports(params = {}, options = {}) # subnets: ["NonEmptyString"], # security_group_ids: ["NonEmptyString"], # }, + # proxy_configuration: { + # default_behavior: "ALLOW_ALL", # accepts ALLOW_ALL, DENY_ALL + # ordered_proxy_rules: [ + # { + # type: "DOMAIN", # required, accepts DOMAIN, IP + # effect: "ALLOW", # required, accepts ALLOW, DENY + # entities: ["String"], # required + # }, + # ], + # }, # image_id: "NonEmptyString", # fleet_service_role: "NonEmptyString", # tags: [ @@ -1339,6 +1358,12 @@ def batch_get_reports(params = {}, options = {}) # resp.fleet.vpc_config.subnets[0] #=> String # resp.fleet.vpc_config.security_group_ids #=> Array # resp.fleet.vpc_config.security_group_ids[0] #=> String + # resp.fleet.proxy_configuration.default_behavior #=> String, one of "ALLOW_ALL", "DENY_ALL" + # resp.fleet.proxy_configuration.ordered_proxy_rules #=> Array + # resp.fleet.proxy_configuration.ordered_proxy_rules[0].type #=> String, one of "DOMAIN", "IP" + # resp.fleet.proxy_configuration.ordered_proxy_rules[0].effect #=> String, one of "ALLOW", "DENY" + # resp.fleet.proxy_configuration.ordered_proxy_rules[0].entities #=> Array + # resp.fleet.proxy_configuration.ordered_proxy_rules[0].entities[0] #=> String # resp.fleet.image_id #=> String # resp.fleet.fleet_service_role #=> String # resp.fleet.tags #=> Array @@ -1737,7 +1762,7 @@ def create_fleet(params = {}, options = {}) # resp.project.webhook.branch_filter #=> String # resp.project.webhook.filter_groups #=> Array # resp.project.webhook.filter_groups[0] #=> Array - # resp.project.webhook.filter_groups[0][0].type #=> String, one of "EVENT", "BASE_REF", "HEAD_REF", "ACTOR_ACCOUNT_ID", "FILE_PATH", "COMMIT_MESSAGE", "WORKFLOW_NAME", "TAG_NAME", "RELEASE_NAME" + # resp.project.webhook.filter_groups[0][0].type #=> String, one of "EVENT", "BASE_REF", "HEAD_REF", "ACTOR_ACCOUNT_ID", "FILE_PATH", "COMMIT_MESSAGE", "WORKFLOW_NAME", "TAG_NAME", "RELEASE_NAME", "REPOSITORY_NAME" # resp.project.webhook.filter_groups[0][0].pattern #=> String # resp.project.webhook.filter_groups[0][0].exclude_matched_pattern #=> Boolean # resp.project.webhook.build_type #=> String, one of "BUILD", "BUILD_BATCH" @@ -1936,7 +1961,7 @@ def create_report_group(params = {}, options = {}) # filter_groups: [ # [ # { - # type: "EVENT", # required, accepts EVENT, BASE_REF, HEAD_REF, ACTOR_ACCOUNT_ID, FILE_PATH, COMMIT_MESSAGE, WORKFLOW_NAME, TAG_NAME, RELEASE_NAME + # type: "EVENT", # required, accepts EVENT, BASE_REF, HEAD_REF, ACTOR_ACCOUNT_ID, FILE_PATH, COMMIT_MESSAGE, WORKFLOW_NAME, TAG_NAME, RELEASE_NAME, REPOSITORY_NAME # pattern: "String", # required # exclude_matched_pattern: false, # }, @@ -1959,7 +1984,7 @@ def create_report_group(params = {}, options = {}) # resp.webhook.branch_filter #=> String # resp.webhook.filter_groups #=> Array # resp.webhook.filter_groups[0] #=> Array - # resp.webhook.filter_groups[0][0].type #=> String, one of "EVENT", "BASE_REF", "HEAD_REF", "ACTOR_ACCOUNT_ID", "FILE_PATH", "COMMIT_MESSAGE", "WORKFLOW_NAME", "TAG_NAME", "RELEASE_NAME" + # resp.webhook.filter_groups[0][0].type #=> String, one of "EVENT", "BASE_REF", "HEAD_REF", "ACTOR_ACCOUNT_ID", "FILE_PATH", "COMMIT_MESSAGE", "WORKFLOW_NAME", "TAG_NAME", "RELEASE_NAME", "REPOSITORY_NAME" # resp.webhook.filter_groups[0][0].pattern #=> String # resp.webhook.filter_groups[0][0].exclude_matched_pattern #=> Boolean # resp.webhook.build_type #=> String, one of "BUILD", "BUILD_BATCH" @@ -5080,6 +5105,9 @@ def stop_build_batch(params = {}, options = {}) # @option params [Types::VpcConfig] :vpc_config # Information about the VPC configuration that CodeBuild accesses. # + # @option params [Types::ProxyConfiguration] :proxy_configuration + # The proxy configuration of the compute fleet. + # # @option params [String] :image_id # The Amazon Machine Image (AMI) of the compute fleet. # @@ -5125,6 +5153,16 @@ def stop_build_batch(params = {}, options = {}) # subnets: ["NonEmptyString"], # security_group_ids: ["NonEmptyString"], # }, + # proxy_configuration: { + # default_behavior: "ALLOW_ALL", # accepts ALLOW_ALL, DENY_ALL + # ordered_proxy_rules: [ + # { + # type: "DOMAIN", # required, accepts DOMAIN, IP + # effect: "ALLOW", # required, accepts ALLOW, DENY + # entities: ["String"], # required + # }, + # ], + # }, # image_id: "NonEmptyString", # fleet_service_role: "NonEmptyString", # tags: [ @@ -5160,6 +5198,12 @@ def stop_build_batch(params = {}, options = {}) # resp.fleet.vpc_config.subnets[0] #=> String # resp.fleet.vpc_config.security_group_ids #=> Array # resp.fleet.vpc_config.security_group_ids[0] #=> String + # resp.fleet.proxy_configuration.default_behavior #=> String, one of "ALLOW_ALL", "DENY_ALL" + # resp.fleet.proxy_configuration.ordered_proxy_rules #=> Array + # resp.fleet.proxy_configuration.ordered_proxy_rules[0].type #=> String, one of "DOMAIN", "IP" + # resp.fleet.proxy_configuration.ordered_proxy_rules[0].effect #=> String, one of "ALLOW", "DENY" + # resp.fleet.proxy_configuration.ordered_proxy_rules[0].entities #=> Array + # resp.fleet.proxy_configuration.ordered_proxy_rules[0].entities[0] #=> String # resp.fleet.image_id #=> String # resp.fleet.fleet_service_role #=> String # resp.fleet.tags #=> Array @@ -5561,7 +5605,7 @@ def update_fleet(params = {}, options = {}) # resp.project.webhook.branch_filter #=> String # resp.project.webhook.filter_groups #=> Array # resp.project.webhook.filter_groups[0] #=> Array - # resp.project.webhook.filter_groups[0][0].type #=> String, one of "EVENT", "BASE_REF", "HEAD_REF", "ACTOR_ACCOUNT_ID", "FILE_PATH", "COMMIT_MESSAGE", "WORKFLOW_NAME", "TAG_NAME", "RELEASE_NAME" + # resp.project.webhook.filter_groups[0][0].type #=> String, one of "EVENT", "BASE_REF", "HEAD_REF", "ACTOR_ACCOUNT_ID", "FILE_PATH", "COMMIT_MESSAGE", "WORKFLOW_NAME", "TAG_NAME", "RELEASE_NAME", "REPOSITORY_NAME" # resp.project.webhook.filter_groups[0][0].pattern #=> String # resp.project.webhook.filter_groups[0][0].exclude_matched_pattern #=> Boolean # resp.project.webhook.build_type #=> String, one of "BUILD", "BUILD_BATCH" @@ -5816,7 +5860,7 @@ def update_report_group(params = {}, options = {}) # filter_groups: [ # [ # { - # type: "EVENT", # required, accepts EVENT, BASE_REF, HEAD_REF, ACTOR_ACCOUNT_ID, FILE_PATH, COMMIT_MESSAGE, WORKFLOW_NAME, TAG_NAME, RELEASE_NAME + # type: "EVENT", # required, accepts EVENT, BASE_REF, HEAD_REF, ACTOR_ACCOUNT_ID, FILE_PATH, COMMIT_MESSAGE, WORKFLOW_NAME, TAG_NAME, RELEASE_NAME, REPOSITORY_NAME # pattern: "String", # required # exclude_matched_pattern: false, # }, @@ -5833,7 +5877,7 @@ def update_report_group(params = {}, options = {}) # resp.webhook.branch_filter #=> String # resp.webhook.filter_groups #=> Array # resp.webhook.filter_groups[0] #=> Array - # resp.webhook.filter_groups[0][0].type #=> String, one of "EVENT", "BASE_REF", "HEAD_REF", "ACTOR_ACCOUNT_ID", "FILE_PATH", "COMMIT_MESSAGE", "WORKFLOW_NAME", "TAG_NAME", "RELEASE_NAME" + # resp.webhook.filter_groups[0][0].type #=> String, one of "EVENT", "BASE_REF", "HEAD_REF", "ACTOR_ACCOUNT_ID", "FILE_PATH", "COMMIT_MESSAGE", "WORKFLOW_NAME", "TAG_NAME", "RELEASE_NAME", "REPOSITORY_NAME" # resp.webhook.filter_groups[0][0].pattern #=> String # resp.webhook.filter_groups[0][0].exclude_matched_pattern #=> Boolean # resp.webhook.build_type #=> String, one of "BUILD", "BUILD_BATCH" @@ -5870,7 +5914,7 @@ def build_request(operation_name, params = {}) tracer: tracer ) context[:gem_name] = 'aws-sdk-codebuild' - context[:gem_version] = '1.132.0' + context[:gem_version] = '1.133.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client_api.rb b/gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client_api.rb index be2ef99b138..aa0a9156ab7 100644 --- a/gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client_api.rb +++ b/gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/client_api.rb @@ -121,6 +121,12 @@ module ClientApi FleetName = Shapes::StringShape.new(name: 'FleetName') FleetNames = Shapes::ListShape.new(name: 'FleetNames') FleetOverflowBehavior = Shapes::StringShape.new(name: 'FleetOverflowBehavior') + FleetProxyRule = Shapes::StructureShape.new(name: 'FleetProxyRule') + FleetProxyRuleBehavior = Shapes::StringShape.new(name: 'FleetProxyRuleBehavior') + FleetProxyRuleEffectType = Shapes::StringShape.new(name: 'FleetProxyRuleEffectType') + FleetProxyRuleEntities = Shapes::ListShape.new(name: 'FleetProxyRuleEntities') + FleetProxyRuleType = Shapes::StringShape.new(name: 'FleetProxyRuleType') + FleetProxyRules = Shapes::ListShape.new(name: 'FleetProxyRules') FleetScalingMetricType = Shapes::StringShape.new(name: 'FleetScalingMetricType') FleetScalingType = Shapes::StringShape.new(name: 'FleetScalingType') FleetSortByType = Shapes::StringShape.new(name: 'FleetSortByType') @@ -203,6 +209,7 @@ module ClientApi ProjectSources = Shapes::ListShape.new(name: 'ProjectSources') ProjectVisibilityType = Shapes::StringShape.new(name: 'ProjectVisibilityType') Projects = Shapes::ListShape.new(name: 'Projects') + ProxyConfiguration = Shapes::StructureShape.new(name: 'ProxyConfiguration') PutResourcePolicyInput = Shapes::StructureShape.new(name: 'PutResourcePolicyInput') PutResourcePolicyOutput = Shapes::StructureShape.new(name: 'PutResourcePolicyOutput') RegistryCredential = Shapes::StructureShape.new(name: 'RegistryCredential') @@ -524,6 +531,7 @@ module ClientApi CreateFleetInput.add_member(:scaling_configuration, Shapes::ShapeRef.new(shape: ScalingConfigurationInput, location_name: "scalingConfiguration")) CreateFleetInput.add_member(:overflow_behavior, Shapes::ShapeRef.new(shape: FleetOverflowBehavior, location_name: "overflowBehavior")) CreateFleetInput.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "vpcConfig")) + CreateFleetInput.add_member(:proxy_configuration, Shapes::ShapeRef.new(shape: ProxyConfiguration, location_name: "proxyConfiguration")) CreateFleetInput.add_member(:image_id, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "imageId")) CreateFleetInput.add_member(:fleet_service_role, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "fleetServiceRole")) CreateFleetInput.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "tags")) @@ -698,6 +706,7 @@ module ClientApi Fleet.add_member(:scaling_configuration, Shapes::ShapeRef.new(shape: ScalingConfigurationOutput, location_name: "scalingConfiguration")) Fleet.add_member(:overflow_behavior, Shapes::ShapeRef.new(shape: FleetOverflowBehavior, location_name: "overflowBehavior")) Fleet.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "vpcConfig")) + Fleet.add_member(:proxy_configuration, Shapes::ShapeRef.new(shape: ProxyConfiguration, location_name: "proxyConfiguration")) Fleet.add_member(:image_id, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "imageId")) Fleet.add_member(:fleet_service_role, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "fleetServiceRole")) Fleet.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "tags")) @@ -707,6 +716,15 @@ module ClientApi FleetNames.member = Shapes::ShapeRef.new(shape: NonEmptyString) + FleetProxyRule.add_member(:type, Shapes::ShapeRef.new(shape: FleetProxyRuleType, required: true, location_name: "type")) + FleetProxyRule.add_member(:effect, Shapes::ShapeRef.new(shape: FleetProxyRuleEffectType, required: true, location_name: "effect")) + FleetProxyRule.add_member(:entities, Shapes::ShapeRef.new(shape: FleetProxyRuleEntities, required: true, location_name: "entities")) + FleetProxyRule.struct_class = Types::FleetProxyRule + + FleetProxyRuleEntities.member = Shapes::ShapeRef.new(shape: String) + + FleetProxyRules.member = Shapes::ShapeRef.new(shape: FleetProxyRule) + FleetStatus.add_member(:status_code, Shapes::ShapeRef.new(shape: FleetStatusCode, location_name: "statusCode")) FleetStatus.add_member(:context, Shapes::ShapeRef.new(shape: FleetContextCode, location_name: "context")) FleetStatus.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "message")) @@ -1008,6 +1026,10 @@ module ClientApi Projects.member = Shapes::ShapeRef.new(shape: Project) + ProxyConfiguration.add_member(:default_behavior, Shapes::ShapeRef.new(shape: FleetProxyRuleBehavior, location_name: "defaultBehavior")) + ProxyConfiguration.add_member(:ordered_proxy_rules, Shapes::ShapeRef.new(shape: FleetProxyRules, location_name: "orderedProxyRules")) + ProxyConfiguration.struct_class = Types::ProxyConfiguration + PutResourcePolicyInput.add_member(:policy, Shapes::ShapeRef.new(shape: NonEmptyString, required: true, location_name: "policy")) PutResourcePolicyInput.add_member(:resource_arn, Shapes::ShapeRef.new(shape: NonEmptyString, required: true, location_name: "resourceArn")) PutResourcePolicyInput.struct_class = Types::PutResourcePolicyInput @@ -1269,6 +1291,7 @@ module ClientApi UpdateFleetInput.add_member(:scaling_configuration, Shapes::ShapeRef.new(shape: ScalingConfigurationInput, location_name: "scalingConfiguration")) UpdateFleetInput.add_member(:overflow_behavior, Shapes::ShapeRef.new(shape: FleetOverflowBehavior, location_name: "overflowBehavior")) UpdateFleetInput.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "vpcConfig")) + UpdateFleetInput.add_member(:proxy_configuration, Shapes::ShapeRef.new(shape: ProxyConfiguration, location_name: "proxyConfiguration")) UpdateFleetInput.add_member(:image_id, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "imageId")) UpdateFleetInput.add_member(:fleet_service_role, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "fleetServiceRole")) UpdateFleetInput.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "tags")) diff --git a/gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb b/gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb index 97813d85443..9467e537393 100644 --- a/gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb +++ b/gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb @@ -1534,6 +1534,10 @@ class CodeCoverageReportSummary < Struct.new( # Information about the VPC configuration that CodeBuild accesses. # @return [Types::VpcConfig] # + # @!attribute [rw] proxy_configuration + # The proxy configuration of the compute fleet. + # @return [Types::ProxyConfiguration] + # # @!attribute [rw] image_id # The Amazon Machine Image (AMI) of the compute fleet. # @return [String] @@ -1566,6 +1570,7 @@ class CreateFleetInput < Struct.new( :scaling_configuration, :overflow_behavior, :vpc_config, + :proxy_configuration, :image_id, :fleet_service_role, :tags) @@ -2546,6 +2551,10 @@ class ExportedEnvironmentVariable < Struct.new( # Information about the VPC configuration that CodeBuild accesses. # @return [Types::VpcConfig] # + # @!attribute [rw] proxy_configuration + # The proxy configuration of the compute fleet. + # @return [Types::ProxyConfiguration] + # # @!attribute [rw] image_id # The Amazon Machine Image (AMI) of the compute fleet. # @return [String] @@ -2583,6 +2592,7 @@ class Fleet < Struct.new( :scaling_configuration, :overflow_behavior, :vpc_config, + :proxy_configuration, :image_id, :fleet_service_role, :tags) @@ -2590,6 +2600,30 @@ class Fleet < Struct.new( include Aws::Structure end + # Information about the proxy rule for your reserved capacity instances. + # + # @!attribute [rw] type + # The type of proxy rule. + # @return [String] + # + # @!attribute [rw] effect + # The behavior of the proxy rule. + # @return [String] + # + # @!attribute [rw] entities + # The destination of the proxy rule. + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/FleetProxyRule AWS API Documentation + # + class FleetProxyRule < Struct.new( + :type, + :effect, + :entities) + SENSITIVE = [] + include Aws::Structure + end + # The status of the compute fleet. # # @!attribute [rw] status_code @@ -4864,6 +4898,28 @@ class ProjectSourceVersion < Struct.new( include Aws::Structure end + # Information about the proxy configurations that apply network access + # control to your reserved capacity instances. + # + # @!attribute [rw] default_behavior + # The default behavior of outgoing traffic. + # @return [String] + # + # @!attribute [rw] ordered_proxy_rules + # An array of `FleetProxyRule` objects that represent the specified + # destination domains or IPs to allow or deny network access control + # to. + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/ProxyConfiguration AWS API Documentation + # + class ProxyConfiguration < Struct.new( + :default_behavior, + :ordered_proxy_rules) + SENSITIVE = [] + include Aws::Structure + end + # @!attribute [rw] policy # A JSON-formatted resource policy. For more information, see [Sharing # a Project][1] and [Sharing a Report Group][2] in the *CodeBuild User @@ -6537,6 +6593,10 @@ class TestReportSummary < Struct.new( # Information about the VPC configuration that CodeBuild accesses. # @return [Types::VpcConfig] # + # @!attribute [rw] proxy_configuration + # The proxy configuration of the compute fleet. + # @return [Types::ProxyConfiguration] + # # @!attribute [rw] image_id # The Amazon Machine Image (AMI) of the compute fleet. # @return [String] @@ -6569,6 +6629,7 @@ class UpdateFleetInput < Struct.new( :scaling_configuration, :overflow_behavior, :vpc_config, + :proxy_configuration, :image_id, :fleet_service_role, :tags) diff --git a/gems/aws-sdk-codebuild/sig/client.rbs b/gems/aws-sdk-codebuild/sig/client.rbs index 4647539208c..88eb6bdf88e 100644 --- a/gems/aws-sdk-codebuild/sig/client.rbs +++ b/gems/aws-sdk-codebuild/sig/client.rbs @@ -179,6 +179,16 @@ module Aws subnets: Array[::String]?, security_group_ids: Array[::String]? }, + ?proxy_configuration: { + default_behavior: ("ALLOW_ALL" | "DENY_ALL")?, + ordered_proxy_rules: Array[ + { + type: ("DOMAIN" | "IP"), + effect: ("ALLOW" | "DENY"), + entities: Array[::String] + }, + ]? + }, ?image_id: ::String, ?fleet_service_role: ::String, ?tags: Array[ @@ -391,7 +401,7 @@ module Aws ?filter_groups: Array[ Array[ { - type: ("EVENT" | "BASE_REF" | "HEAD_REF" | "ACTOR_ACCOUNT_ID" | "FILE_PATH" | "COMMIT_MESSAGE" | "WORKFLOW_NAME" | "TAG_NAME" | "RELEASE_NAME"), + type: ("EVENT" | "BASE_REF" | "HEAD_REF" | "ACTOR_ACCOUNT_ID" | "FILE_PATH" | "COMMIT_MESSAGE" | "WORKFLOW_NAME" | "TAG_NAME" | "RELEASE_NAME" | "REPOSITORY_NAME"), pattern: ::String, exclude_matched_pattern: bool? }, @@ -1077,6 +1087,16 @@ module Aws subnets: Array[::String]?, security_group_ids: Array[::String]? }, + ?proxy_configuration: { + default_behavior: ("ALLOW_ALL" | "DENY_ALL")?, + ordered_proxy_rules: Array[ + { + type: ("DOMAIN" | "IP"), + effect: ("ALLOW" | "DENY"), + entities: Array[::String] + }, + ]? + }, ?image_id: ::String, ?fleet_service_role: ::String, ?tags: Array[ @@ -1303,7 +1323,7 @@ module Aws ?filter_groups: Array[ Array[ { - type: ("EVENT" | "BASE_REF" | "HEAD_REF" | "ACTOR_ACCOUNT_ID" | "FILE_PATH" | "COMMIT_MESSAGE" | "WORKFLOW_NAME" | "TAG_NAME" | "RELEASE_NAME"), + type: ("EVENT" | "BASE_REF" | "HEAD_REF" | "ACTOR_ACCOUNT_ID" | "FILE_PATH" | "COMMIT_MESSAGE" | "WORKFLOW_NAME" | "TAG_NAME" | "RELEASE_NAME" | "REPOSITORY_NAME"), pattern: ::String, exclude_matched_pattern: bool? }, diff --git a/gems/aws-sdk-codebuild/sig/types.rbs b/gems/aws-sdk-codebuild/sig/types.rbs index acde93bf268..50e7227202b 100644 --- a/gems/aws-sdk-codebuild/sig/types.rbs +++ b/gems/aws-sdk-codebuild/sig/types.rbs @@ -269,6 +269,7 @@ module Aws::CodeBuild attr_accessor scaling_configuration: Types::ScalingConfigurationInput attr_accessor overflow_behavior: ("QUEUE" | "ON_DEMAND") attr_accessor vpc_config: Types::VpcConfig + attr_accessor proxy_configuration: Types::ProxyConfiguration attr_accessor image_id: ::String attr_accessor fleet_service_role: ::String attr_accessor tags: ::Array[Types::Tag] @@ -491,12 +492,20 @@ module Aws::CodeBuild attr_accessor scaling_configuration: Types::ScalingConfigurationOutput attr_accessor overflow_behavior: ("QUEUE" | "ON_DEMAND") attr_accessor vpc_config: Types::VpcConfig + attr_accessor proxy_configuration: Types::ProxyConfiguration attr_accessor image_id: ::String attr_accessor fleet_service_role: ::String attr_accessor tags: ::Array[Types::Tag] SENSITIVE: [] end + class FleetProxyRule + attr_accessor type: ("DOMAIN" | "IP") + attr_accessor effect: ("ALLOW" | "DENY") + attr_accessor entities: ::Array[::String] + SENSITIVE: [] + end + class FleetStatus attr_accessor status_code: ("CREATING" | "UPDATING" | "ROTATING" | "PENDING_DELETION" | "DELETING" | "CREATE_FAILED" | "UPDATE_ROLLBACK_FAILED" | "ACTIVE") attr_accessor context: ("CREATE_FAILED" | "UPDATE_FAILED" | "ACTION_REQUIRED" | "PENDING_DELETION" | "INSUFFICIENT_CAPACITY") @@ -873,6 +882,12 @@ module Aws::CodeBuild SENSITIVE: [] end + class ProxyConfiguration + attr_accessor default_behavior: ("ALLOW_ALL" | "DENY_ALL") + attr_accessor ordered_proxy_rules: ::Array[Types::FleetProxyRule] + SENSITIVE: [] + end + class PutResourcePolicyInput attr_accessor policy: ::String attr_accessor resource_arn: ::String @@ -1178,6 +1193,7 @@ module Aws::CodeBuild attr_accessor scaling_configuration: Types::ScalingConfigurationInput attr_accessor overflow_behavior: ("QUEUE" | "ON_DEMAND") attr_accessor vpc_config: Types::VpcConfig + attr_accessor proxy_configuration: Types::ProxyConfiguration attr_accessor image_id: ::String attr_accessor fleet_service_role: ::String attr_accessor tags: ::Array[Types::Tag] @@ -1280,7 +1296,7 @@ module Aws::CodeBuild end class WebhookFilter - attr_accessor type: ("EVENT" | "BASE_REF" | "HEAD_REF" | "ACTOR_ACCOUNT_ID" | "FILE_PATH" | "COMMIT_MESSAGE" | "WORKFLOW_NAME" | "TAG_NAME" | "RELEASE_NAME") + attr_accessor type: ("EVENT" | "BASE_REF" | "HEAD_REF" | "ACTOR_ACCOUNT_ID" | "FILE_PATH" | "COMMIT_MESSAGE" | "WORKFLOW_NAME" | "TAG_NAME" | "RELEASE_NAME" | "REPOSITORY_NAME") attr_accessor pattern: ::String attr_accessor exclude_matched_pattern: bool SENSITIVE: [] diff --git a/gems/aws-sdk-ivs/CHANGELOG.md b/gems/aws-sdk-ivs/CHANGELOG.md index 9f6b6571c27..c2d1399d379 100644 --- a/gems/aws-sdk-ivs/CHANGELOG.md +++ b/gems/aws-sdk-ivs/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.62.0 (2024-10-15) +------------------ + +* Feature - On a channel that you own, you can now replace an ongoing stream with a new stream by streaming up with the priority parameter appended to the stream key. + 1.61.0 (2024-09-24) ------------------ diff --git a/gems/aws-sdk-ivs/VERSION b/gems/aws-sdk-ivs/VERSION index 91951fd8ad7..76d05362056 100644 --- a/gems/aws-sdk-ivs/VERSION +++ b/gems/aws-sdk-ivs/VERSION @@ -1 +1 @@ -1.61.0 +1.62.0 diff --git a/gems/aws-sdk-ivs/lib/aws-sdk-ivs.rb b/gems/aws-sdk-ivs/lib/aws-sdk-ivs.rb index 77f208b6a9d..94fac42c049 100644 --- a/gems/aws-sdk-ivs/lib/aws-sdk-ivs.rb +++ b/gems/aws-sdk-ivs/lib/aws-sdk-ivs.rb @@ -54,7 +54,7 @@ module Plugins autoload :EndpointProvider, 'aws-sdk-ivs/endpoint_provider' autoload :Endpoints, 'aws-sdk-ivs/endpoints' - GEM_VERSION = '1.61.0' + GEM_VERSION = '1.62.0' end diff --git a/gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb b/gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb index 4501e141b82..b120e21977c 100644 --- a/gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb +++ b/gems/aws-sdk-ivs/lib/aws-sdk-ivs/client.rb @@ -467,20 +467,20 @@ def initialize(*args) # # resp.channels #=> Array # resp.channels[0].arn #=> String - # resp.channels[0].name #=> String - # resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW" - # resp.channels[0].type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD" - # resp.channels[0].recording_configuration_arn #=> String - # resp.channels[0].ingest_endpoint #=> String - # resp.channels[0].playback_url #=> String # resp.channels[0].authorized #=> Boolean - # resp.channels[0].tags #=> Hash - # resp.channels[0].tags["TagKey"] #=> String + # resp.channels[0].ingest_endpoint #=> String # resp.channels[0].insecure_ingest #=> Boolean + # resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW" + # resp.channels[0].name #=> String + # resp.channels[0].playback_restriction_policy_arn #=> String + # resp.channels[0].playback_url #=> String # resp.channels[0].preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY" + # resp.channels[0].recording_configuration_arn #=> String # resp.channels[0].srt.endpoint #=> String # resp.channels[0].srt.passphrase #=> String - # resp.channels[0].playback_restriction_policy_arn #=> String + # resp.channels[0].tags #=> Hash + # resp.channels[0].tags["TagKey"] #=> String + # resp.channels[0].type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD" # resp.errors #=> Array # resp.errors[0].arn #=> String # resp.errors[0].code #=> String @@ -502,8 +502,8 @@ def batch_get_channel(params = {}, options = {}) # # @return [Types::BatchGetStreamKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::BatchGetStreamKeyResponse#stream_keys #stream_keys} => Array<Types::StreamKey> # * {Types::BatchGetStreamKeyResponse#errors #errors} => Array<Types::BatchError> + # * {Types::BatchGetStreamKeyResponse#stream_keys #stream_keys} => Array<Types::StreamKey> # # @example Request syntax with placeholder values # @@ -513,16 +513,16 @@ def batch_get_channel(params = {}, options = {}) # # @example Response structure # + # resp.errors #=> Array + # resp.errors[0].arn #=> String + # resp.errors[0].code #=> String + # resp.errors[0].message #=> String # resp.stream_keys #=> Array # resp.stream_keys[0].arn #=> String - # resp.stream_keys[0].value #=> String # resp.stream_keys[0].channel_arn #=> String # resp.stream_keys[0].tags #=> Hash # resp.stream_keys[0].tags["TagKey"] #=> String - # resp.errors #=> Array - # resp.errors[0].arn #=> String - # resp.errors[0].code #=> String - # resp.errors[0].message #=> String + # resp.stream_keys[0].value #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchGetStreamKey AWS API Documentation # @@ -559,9 +559,9 @@ def batch_get_stream_key(params = {}, options = {}) # # resp.errors #=> Array # resp.errors[0].channel_arn #=> String - # resp.errors[0].viewer_id #=> String # resp.errors[0].code #=> String # resp.errors[0].message #=> String + # resp.errors[0].viewer_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchStartViewerSessionRevocation AWS API Documentation # @@ -574,27 +574,33 @@ def batch_start_viewer_session_revocation(params = {}, options = {}) # Creates a new channel and an associated stream key to start streaming. # - # @option params [String] :name - # Channel name. + # @option params [Boolean] :authorized + # Whether the channel is private (enabled for playback authorization). + # Default: `false`. + # + # @option params [Boolean] :insecure_ingest + # Whether the channel allows insecure RTMP and SRT ingest. Default: + # `false`. # # @option params [String] :latency_mode # 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`. # - # @option params [String] :type - # 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][1]. - # - # + # @option params [String] :name + # Channel name. # - # [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html + # @option params [String] :playback_restriction_policy_arn + # 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). # - # @option params [Boolean] :authorized - # Whether the channel is private (enabled for playback authorization). - # Default: `false`. + # @option params [String] :preset + # 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 + # (`""`). # # @option params [String] :recording_configuration_arn # Recording-configuration ARN. A valid ARN value here both specifies the @@ -612,21 +618,15 @@ def batch_start_viewer_session_revocation(params = {}, options = {}) # # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html # - # @option params [Boolean] :insecure_ingest - # Whether the channel allows insecure RTMP and SRT ingest. Default: - # `false`. + # @option params [String] :type + # 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][1]. # - # @option params [String] :preset - # 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 - # (`""`). # - # @option params [String] :playback_restriction_policy_arn - # 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). + # + # [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html # # @return [Types::CreateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -636,41 +636,41 @@ def batch_start_viewer_session_revocation(params = {}, options = {}) # @example Request syntax with placeholder values # # resp = client.create_channel({ - # name: "ChannelName", - # latency_mode: "NORMAL", # accepts NORMAL, LOW - # type: "BASIC", # accepts BASIC, STANDARD, ADVANCED_SD, ADVANCED_HD # authorized: false, + # insecure_ingest: false, + # latency_mode: "NORMAL", # accepts NORMAL, LOW + # name: "ChannelName", + # playback_restriction_policy_arn: "ChannelPlaybackRestrictionPolicyArn", + # preset: "HIGHER_BANDWIDTH_DELIVERY", # accepts HIGHER_BANDWIDTH_DELIVERY, CONSTRAINED_BANDWIDTH_DELIVERY # recording_configuration_arn: "ChannelRecordingConfigurationArn", # tags: { # "TagKey" => "TagValue", # }, - # insecure_ingest: false, - # preset: "HIGHER_BANDWIDTH_DELIVERY", # accepts HIGHER_BANDWIDTH_DELIVERY, CONSTRAINED_BANDWIDTH_DELIVERY - # playback_restriction_policy_arn: "ChannelPlaybackRestrictionPolicyArn", + # type: "BASIC", # accepts BASIC, STANDARD, ADVANCED_SD, ADVANCED_HD # }) # # @example Response structure # # resp.channel.arn #=> String - # resp.channel.name #=> String - # resp.channel.latency_mode #=> String, one of "NORMAL", "LOW" - # resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD" - # resp.channel.recording_configuration_arn #=> String - # resp.channel.ingest_endpoint #=> String - # resp.channel.playback_url #=> String # resp.channel.authorized #=> Boolean - # resp.channel.tags #=> Hash - # resp.channel.tags["TagKey"] #=> String + # resp.channel.ingest_endpoint #=> String # resp.channel.insecure_ingest #=> Boolean + # resp.channel.latency_mode #=> String, one of "NORMAL", "LOW" + # resp.channel.name #=> String + # resp.channel.playback_restriction_policy_arn #=> String + # resp.channel.playback_url #=> String # resp.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY" + # resp.channel.recording_configuration_arn #=> String # resp.channel.srt.endpoint #=> String # resp.channel.srt.passphrase #=> String - # resp.channel.playback_restriction_policy_arn #=> String + # resp.channel.tags #=> Hash + # resp.channel.tags["TagKey"] #=> String + # resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD" # resp.stream_key.arn #=> String - # resp.stream_key.value #=> String # resp.stream_key.channel_arn #=> String # resp.stream_key.tags #=> Hash # resp.stream_key.tags["TagKey"] #=> String + # resp.stream_key.value #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateChannel AWS API Documentation # @@ -740,11 +740,11 @@ def create_channel(params = {}, options = {}) # # @example Response structure # - # resp.playback_restriction_policy.arn #=> String # resp.playback_restriction_policy.allowed_countries #=> Array # resp.playback_restriction_policy.allowed_countries[0] #=> String # resp.playback_restriction_policy.allowed_origins #=> Array # resp.playback_restriction_policy.allowed_origins[0] #=> String + # resp.playback_restriction_policy.arn #=> String # resp.playback_restriction_policy.enable_strict_origin_enforcement #=> Boolean # resp.playback_restriction_policy.name #=> String # resp.playback_restriction_policy.tags #=> Hash @@ -775,13 +775,22 @@ def create_playback_restriction_policy(params = {}, options = {}) # configuration and create a new one with an S3 bucket from the correct # region. # - # @option params [String] :name - # Recording-configuration name. The value does not need to be unique. - # # @option params [required, Types::DestinationConfiguration] :destination_configuration # A complex type that contains a destination configuration for where # recorded video will be stored. # + # @option params [String] :name + # Recording-configuration name. The value does not need to be unique. + # + # @option params [Integer] :recording_reconnect_window_seconds + # 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. + # + # @option params [Types::RenditionConfiguration] :rendition_configuration + # Object that describes which renditions should be recorded for a + # stream. + # # @option params [Hash] :tags # Array of 1-50 maps, each of the form `string:string (key:value)`. See # [Best practices and strategies][1] in *Tagging Amazon Web Services @@ -798,15 +807,6 @@ def create_playback_restriction_policy(params = {}, options = {}) # thumbnails for a live session and modify the interval at which # thumbnails are generated for the live session. # - # @option params [Integer] :recording_reconnect_window_seconds - # 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. - # - # @option params [Types::RenditionConfiguration] :rendition_configuration - # Object that describes which renditions should be recorded for a - # stream. - # # @return [Types::CreateRecordingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateRecordingConfigurationResponse#recording_configuration #recording_configuration} => Types::RecordingConfiguration @@ -814,45 +814,45 @@ def create_playback_restriction_policy(params = {}, options = {}) # @example Request syntax with placeholder values # # resp = client.create_recording_configuration({ - # name: "RecordingConfigurationName", # destination_configuration: { # required # s3: { # bucket_name: "S3DestinationBucketName", # required # }, # }, + # name: "RecordingConfigurationName", + # recording_reconnect_window_seconds: 1, + # rendition_configuration: { + # rendition_selection: "ALL", # accepts ALL, NONE, CUSTOM + # renditions: ["SD"], # accepts SD, HD, FULL_HD, LOWEST_RESOLUTION + # }, # tags: { # "TagKey" => "TagValue", # }, # thumbnail_configuration: { # recording_mode: "DISABLED", # accepts DISABLED, INTERVAL - # target_interval_seconds: 1, # resolution: "SD", # accepts SD, HD, FULL_HD, LOWEST_RESOLUTION # storage: ["SEQUENTIAL"], # accepts SEQUENTIAL, LATEST - # }, - # recording_reconnect_window_seconds: 1, - # rendition_configuration: { - # rendition_selection: "ALL", # accepts ALL, NONE, CUSTOM - # renditions: ["SD"], # accepts SD, HD, FULL_HD, LOWEST_RESOLUTION + # target_interval_seconds: 1, # }, # }) # # @example Response structure # # resp.recording_configuration.arn #=> String - # resp.recording_configuration.name #=> String # resp.recording_configuration.destination_configuration.s3.bucket_name #=> String + # resp.recording_configuration.name #=> String + # resp.recording_configuration.recording_reconnect_window_seconds #=> Integer + # resp.recording_configuration.rendition_configuration.rendition_selection #=> String, one of "ALL", "NONE", "CUSTOM" + # resp.recording_configuration.rendition_configuration.renditions #=> Array + # resp.recording_configuration.rendition_configuration.renditions[0] #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION" # resp.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE" # resp.recording_configuration.tags #=> Hash # resp.recording_configuration.tags["TagKey"] #=> String # resp.recording_configuration.thumbnail_configuration.recording_mode #=> String, one of "DISABLED", "INTERVAL" - # resp.recording_configuration.thumbnail_configuration.target_interval_seconds #=> Integer # resp.recording_configuration.thumbnail_configuration.resolution #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION" # resp.recording_configuration.thumbnail_configuration.storage #=> Array # resp.recording_configuration.thumbnail_configuration.storage[0] #=> String, one of "SEQUENTIAL", "LATEST" - # resp.recording_configuration.recording_reconnect_window_seconds #=> Integer - # resp.recording_configuration.rendition_configuration.rendition_selection #=> String, one of "ALL", "NONE", "CUSTOM" - # resp.recording_configuration.rendition_configuration.renditions #=> Array - # resp.recording_configuration.rendition_configuration.renditions[0] #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION" + # resp.recording_configuration.thumbnail_configuration.target_interval_seconds #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateRecordingConfiguration AWS API Documentation # @@ -902,10 +902,10 @@ def create_recording_configuration(params = {}, options = {}) # @example Response structure # # resp.stream_key.arn #=> String - # resp.stream_key.value #=> String # resp.stream_key.channel_arn #=> String # resp.stream_key.tags #=> Hash # resp.stream_key.tags["TagKey"] #=> String + # resp.stream_key.value #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateStreamKey AWS API Documentation # @@ -1069,20 +1069,20 @@ def delete_stream_key(params = {}, options = {}) # @example Response structure # # resp.channel.arn #=> String - # resp.channel.name #=> String - # resp.channel.latency_mode #=> String, one of "NORMAL", "LOW" - # resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD" - # resp.channel.recording_configuration_arn #=> String - # resp.channel.ingest_endpoint #=> String - # resp.channel.playback_url #=> String # resp.channel.authorized #=> Boolean - # resp.channel.tags #=> Hash - # resp.channel.tags["TagKey"] #=> String + # resp.channel.ingest_endpoint #=> String # resp.channel.insecure_ingest #=> Boolean + # resp.channel.latency_mode #=> String, one of "NORMAL", "LOW" + # resp.channel.name #=> String + # resp.channel.playback_restriction_policy_arn #=> String + # resp.channel.playback_url #=> String # resp.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY" + # resp.channel.recording_configuration_arn #=> String # resp.channel.srt.endpoint #=> String # resp.channel.srt.passphrase #=> String - # resp.channel.playback_restriction_policy_arn #=> String + # resp.channel.tags #=> Hash + # resp.channel.tags["TagKey"] #=> String + # resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD" # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetChannel AWS API Documentation # @@ -1119,8 +1119,8 @@ def get_channel(params = {}, options = {}) # @example Response structure # # resp.key_pair.arn #=> String - # resp.key_pair.name #=> String # resp.key_pair.fingerprint #=> String + # resp.key_pair.name #=> String # resp.key_pair.tags #=> Hash # resp.key_pair.tags["TagKey"] #=> String # @@ -1150,11 +1150,11 @@ def get_playback_key_pair(params = {}, options = {}) # # @example Response structure # - # resp.playback_restriction_policy.arn #=> String # resp.playback_restriction_policy.allowed_countries #=> Array # resp.playback_restriction_policy.allowed_countries[0] #=> String # resp.playback_restriction_policy.allowed_origins #=> Array # resp.playback_restriction_policy.allowed_origins[0] #=> String + # resp.playback_restriction_policy.arn #=> String # resp.playback_restriction_policy.enable_strict_origin_enforcement #=> Boolean # resp.playback_restriction_policy.name #=> String # resp.playback_restriction_policy.tags #=> Hash @@ -1187,20 +1187,20 @@ def get_playback_restriction_policy(params = {}, options = {}) # @example Response structure # # resp.recording_configuration.arn #=> String - # resp.recording_configuration.name #=> String # resp.recording_configuration.destination_configuration.s3.bucket_name #=> String + # resp.recording_configuration.name #=> String + # resp.recording_configuration.recording_reconnect_window_seconds #=> Integer + # resp.recording_configuration.rendition_configuration.rendition_selection #=> String, one of "ALL", "NONE", "CUSTOM" + # resp.recording_configuration.rendition_configuration.renditions #=> Array + # resp.recording_configuration.rendition_configuration.renditions[0] #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION" # resp.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE" # resp.recording_configuration.tags #=> Hash # resp.recording_configuration.tags["TagKey"] #=> String # resp.recording_configuration.thumbnail_configuration.recording_mode #=> String, one of "DISABLED", "INTERVAL" - # resp.recording_configuration.thumbnail_configuration.target_interval_seconds #=> Integer # resp.recording_configuration.thumbnail_configuration.resolution #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION" # resp.recording_configuration.thumbnail_configuration.storage #=> Array # resp.recording_configuration.thumbnail_configuration.storage[0] #=> String, one of "SEQUENTIAL", "LATEST" - # resp.recording_configuration.recording_reconnect_window_seconds #=> Integer - # resp.recording_configuration.rendition_configuration.rendition_selection #=> String, one of "ALL", "NONE", "CUSTOM" - # resp.recording_configuration.rendition_configuration.renditions #=> Array - # resp.recording_configuration.rendition_configuration.renditions[0] #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION" + # resp.recording_configuration.thumbnail_configuration.target_interval_seconds #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetRecordingConfiguration AWS API Documentation # @@ -1230,11 +1230,11 @@ def get_recording_configuration(params = {}, options = {}) # @example Response structure # # resp.stream.channel_arn #=> String - # resp.stream.stream_id #=> String + # resp.stream.health #=> String, one of "HEALTHY", "STARVING", "UNKNOWN" # resp.stream.playback_url #=> String # resp.stream.start_time #=> Time # resp.stream.state #=> String, one of "LIVE", "OFFLINE" - # resp.stream.health #=> String, one of "HEALTHY", "STARVING", "UNKNOWN" + # resp.stream.stream_id #=> String # resp.stream.viewer_count #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStream AWS API Documentation @@ -1264,10 +1264,10 @@ def get_stream(params = {}, options = {}) # @example Response structure # # resp.stream_key.arn #=> String - # resp.stream_key.value #=> String # resp.stream_key.channel_arn #=> String # resp.stream_key.tags #=> Hash # resp.stream_key.tags["TagKey"] #=> String + # resp.stream_key.value #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamKey AWS API Documentation # @@ -1301,55 +1301,56 @@ def get_stream_key(params = {}, options = {}) # # @example Response structure # - # resp.stream_session.stream_id #=> String - # resp.stream_session.start_time #=> Time - # resp.stream_session.end_time #=> Time # resp.stream_session.channel.arn #=> String - # resp.stream_session.channel.name #=> String - # resp.stream_session.channel.latency_mode #=> String, one of "NORMAL", "LOW" - # resp.stream_session.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD" - # resp.stream_session.channel.recording_configuration_arn #=> String - # resp.stream_session.channel.ingest_endpoint #=> String - # resp.stream_session.channel.playback_url #=> String # resp.stream_session.channel.authorized #=> Boolean - # resp.stream_session.channel.tags #=> Hash - # resp.stream_session.channel.tags["TagKey"] #=> String + # resp.stream_session.channel.ingest_endpoint #=> String # resp.stream_session.channel.insecure_ingest #=> Boolean + # resp.stream_session.channel.latency_mode #=> String, one of "NORMAL", "LOW" + # resp.stream_session.channel.name #=> String + # resp.stream_session.channel.playback_restriction_policy_arn #=> String + # resp.stream_session.channel.playback_url #=> String # resp.stream_session.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY" + # resp.stream_session.channel.recording_configuration_arn #=> String # resp.stream_session.channel.srt.endpoint #=> String # resp.stream_session.channel.srt.passphrase #=> String - # resp.stream_session.channel.playback_restriction_policy_arn #=> String - # resp.stream_session.ingest_configuration.video.avc_profile #=> String + # resp.stream_session.channel.tags #=> Hash + # resp.stream_session.channel.tags["TagKey"] #=> String + # resp.stream_session.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD" + # resp.stream_session.end_time #=> Time + # resp.stream_session.ingest_configuration.audio.channels #=> Integer + # resp.stream_session.ingest_configuration.audio.codec #=> String + # resp.stream_session.ingest_configuration.audio.sample_rate #=> Integer + # resp.stream_session.ingest_configuration.audio.target_bitrate #=> Integer # resp.stream_session.ingest_configuration.video.avc_level #=> String + # resp.stream_session.ingest_configuration.video.avc_profile #=> String # resp.stream_session.ingest_configuration.video.codec #=> String # resp.stream_session.ingest_configuration.video.encoder #=> String # resp.stream_session.ingest_configuration.video.target_bitrate #=> Integer # resp.stream_session.ingest_configuration.video.target_framerate #=> Integer # resp.stream_session.ingest_configuration.video.video_height #=> Integer # resp.stream_session.ingest_configuration.video.video_width #=> Integer - # resp.stream_session.ingest_configuration.audio.codec #=> String - # resp.stream_session.ingest_configuration.audio.target_bitrate #=> Integer - # resp.stream_session.ingest_configuration.audio.sample_rate #=> Integer - # resp.stream_session.ingest_configuration.audio.channels #=> Integer # resp.stream_session.recording_configuration.arn #=> String - # resp.stream_session.recording_configuration.name #=> String # resp.stream_session.recording_configuration.destination_configuration.s3.bucket_name #=> String + # resp.stream_session.recording_configuration.name #=> String + # resp.stream_session.recording_configuration.recording_reconnect_window_seconds #=> Integer + # resp.stream_session.recording_configuration.rendition_configuration.rendition_selection #=> String, one of "ALL", "NONE", "CUSTOM" + # resp.stream_session.recording_configuration.rendition_configuration.renditions #=> Array + # resp.stream_session.recording_configuration.rendition_configuration.renditions[0] #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION" # resp.stream_session.recording_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE" # resp.stream_session.recording_configuration.tags #=> Hash # resp.stream_session.recording_configuration.tags["TagKey"] #=> String # resp.stream_session.recording_configuration.thumbnail_configuration.recording_mode #=> String, one of "DISABLED", "INTERVAL" - # resp.stream_session.recording_configuration.thumbnail_configuration.target_interval_seconds #=> Integer # resp.stream_session.recording_configuration.thumbnail_configuration.resolution #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION" # resp.stream_session.recording_configuration.thumbnail_configuration.storage #=> Array # resp.stream_session.recording_configuration.thumbnail_configuration.storage[0] #=> String, one of "SEQUENTIAL", "LATEST" - # resp.stream_session.recording_configuration.recording_reconnect_window_seconds #=> Integer - # resp.stream_session.recording_configuration.rendition_configuration.rendition_selection #=> String, one of "ALL", "NONE", "CUSTOM" - # resp.stream_session.recording_configuration.rendition_configuration.renditions #=> Array - # resp.stream_session.recording_configuration.rendition_configuration.renditions[0] #=> String, one of "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION" + # resp.stream_session.recording_configuration.thumbnail_configuration.target_interval_seconds #=> Integer + # resp.stream_session.start_time #=> Time + # resp.stream_session.stream_id #=> String # resp.stream_session.truncated_events #=> Array + # resp.stream_session.truncated_events[0].code #=> String + # resp.stream_session.truncated_events[0].event_time #=> Time # resp.stream_session.truncated_events[0].name #=> String # resp.stream_session.truncated_events[0].type #=> String - # resp.stream_session.truncated_events[0].event_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamSession AWS API Documentation # @@ -1370,12 +1371,12 @@ def get_stream_session(params = {}, options = {}) # # [1]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html # - # @option params [required, String] :public_key_material - # The public portion of a customer-generated key pair. - # # @option params [String] :name # Playback-key-pair name. The value does not need to be unique. # + # @option params [required, String] :public_key_material + # The public portion of a customer-generated key pair. + # # @option params [Hash] :tags # Any tags provided with the request are added to the playback key pair # tags. See [Best practices and strategies][1] in *Tagging Amazon Web @@ -1395,8 +1396,8 @@ def get_stream_session(params = {}, options = {}) # @example Request syntax with placeholder values # # resp = client.import_playback_key_pair({ - # public_key_material: "PlaybackPublicKeyMaterial", # required # name: "PlaybackKeyPairName", + # public_key_material: "PlaybackPublicKeyMaterial", # required # tags: { # "TagKey" => "TagValue", # }, @@ -1405,8 +1406,8 @@ def get_stream_session(params = {}, options = {}) # @example Response structure # # resp.key_pair.arn #=> String - # resp.key_pair.name #=> String # resp.key_pair.fingerprint #=> String + # resp.key_pair.name #=> String # resp.key_pair.tags #=> Hash # resp.key_pair.tags["TagKey"] #=> String # @@ -1429,20 +1430,20 @@ def import_playback_key_pair(params = {}, options = {}) # @option params [String] :filter_by_name # Filters the channel list to match the specified name. # + # @option params [String] :filter_by_playback_restriction_policy_arn + # Filters the channel list to match the specified policy. + # # @option params [String] :filter_by_recording_configuration_arn # Filters the channel list to match the specified # recording-configuration ARN. # - # @option params [String] :filter_by_playback_restriction_policy_arn - # Filters the channel list to match the specified policy. + # @option params [Integer] :max_results + # Maximum number of channels to return. Default: 100. # # @option params [String] :next_token # The first channel to retrieve. This is used for pagination; see the # `nextToken` response field. # - # @option params [Integer] :max_results - # Maximum number of channels to return. Default: 100. - # # @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListChannelsResponse#channels #channels} => Array<Types::ChannelSummary> @@ -1454,26 +1455,26 @@ def import_playback_key_pair(params = {}, options = {}) # # resp = client.list_channels({ # filter_by_name: "ChannelName", - # filter_by_recording_configuration_arn: "ChannelRecordingConfigurationArn", # filter_by_playback_restriction_policy_arn: "ChannelPlaybackRestrictionPolicyArn", - # next_token: "PaginationToken", + # filter_by_recording_configuration_arn: "ChannelRecordingConfigurationArn", # max_results: 1, + # next_token: "PaginationToken", # }) # # @example Response structure # # resp.channels #=> Array # resp.channels[0].arn #=> String - # resp.channels[0].name #=> String - # resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW" # resp.channels[0].authorized #=> Boolean + # resp.channels[0].insecure_ingest #=> Boolean + # resp.channels[0].latency_mode #=> String, one of "NORMAL", "LOW" + # resp.channels[0].name #=> String + # resp.channels[0].playback_restriction_policy_arn #=> String + # resp.channels[0].preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY" # resp.channels[0].recording_configuration_arn #=> String # resp.channels[0].tags #=> Hash # resp.channels[0].tags["TagKey"] #=> String - # resp.channels[0].insecure_ingest #=> Boolean # resp.channels[0].type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD" - # resp.channels[0].preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY" - # resp.channels[0].playback_restriction_policy_arn #=> String # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListChannels AWS API Documentation @@ -1493,14 +1494,14 @@ def list_channels(params = {}, options = {}) # # [1]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html # - # @option params [String] :next_token - # The first key pair to retrieve. This is used for pagination; see the - # `nextToken` response field. - # # @option params [Integer] :max_results # Maximum number of key pairs to return. Default: your service quota or # 100, whichever is smaller. # + # @option params [String] :next_token + # The first key pair to retrieve. This is used for pagination; see the + # `nextToken` response field. + # # @return [Types::ListPlaybackKeyPairsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListPlaybackKeyPairsResponse#key_pairs #key_pairs} => Array<Types::PlaybackKeyPairSummary> @@ -1511,8 +1512,8 @@ def list_channels(params = {}, options = {}) # @example Request syntax with placeholder values # # resp = client.list_playback_key_pairs({ - # next_token: "PaginationToken", # max_results: 1, + # next_token: "PaginationToken", # }) # # @example Response structure @@ -1535,40 +1536,40 @@ def list_playback_key_pairs(params = {}, options = {}) # Gets summary information about playback restriction policies. # + # @option params [Integer] :max_results + # Maximum number of policies to return. Default: 1. + # # @option params [String] :next_token # The first policy to retrieve. This is used for pagination; see the # `nextToken` response field. # - # @option params [Integer] :max_results - # Maximum number of policies to return. Default: 1. - # # @return [Types::ListPlaybackRestrictionPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::ListPlaybackRestrictionPoliciesResponse#playback_restriction_policies #playback_restriction_policies} => Array<Types::PlaybackRestrictionPolicySummary> # * {Types::ListPlaybackRestrictionPoliciesResponse#next_token #next_token} => String + # * {Types::ListPlaybackRestrictionPoliciesResponse#playback_restriction_policies #playback_restriction_policies} => Array<Types::PlaybackRestrictionPolicySummary> # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_playback_restriction_policies({ - # next_token: "PaginationToken", # max_results: 1, + # next_token: "PaginationToken", # }) # # @example Response structure # + # resp.next_token #=> String # resp.playback_restriction_policies #=> Array - # resp.playback_restriction_policies[0].arn #=> String # resp.playback_restriction_policies[0].allowed_countries #=> Array # resp.playback_restriction_policies[0].allowed_countries[0] #=> String # resp.playback_restriction_policies[0].allowed_origins #=> Array # resp.playback_restriction_policies[0].allowed_origins[0] #=> String + # resp.playback_restriction_policies[0].arn #=> String # resp.playback_restriction_policies[0].enable_strict_origin_enforcement #=> Boolean # resp.playback_restriction_policies[0].name #=> String # resp.playback_restriction_policies[0].tags #=> Hash # resp.playback_restriction_policies[0].tags["TagKey"] #=> String - # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListPlaybackRestrictionPolicies AWS API Documentation # @@ -1583,38 +1584,38 @@ def list_playback_restriction_policies(params = {}, options = {}) # account, in the Amazon Web Services region where the API request is # processed. # - # @option params [String] :next_token - # The first recording configuration to retrieve. This is used for - # pagination; see the `nextToken` response field. - # # @option params [Integer] :max_results # Maximum number of recording configurations to return. Default: your # service quota or 100, whichever is smaller. # + # @option params [String] :next_token + # The first recording configuration to retrieve. This is used for + # pagination; see the `nextToken` response field. + # # @return [Types::ListRecordingConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::ListRecordingConfigurationsResponse#recording_configurations #recording_configurations} => Array<Types::RecordingConfigurationSummary> # * {Types::ListRecordingConfigurationsResponse#next_token #next_token} => String + # * {Types::ListRecordingConfigurationsResponse#recording_configurations #recording_configurations} => Array<Types::RecordingConfigurationSummary> # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_recording_configurations({ - # next_token: "PaginationToken", # max_results: 1, + # next_token: "PaginationToken", # }) # # @example Response structure # + # resp.next_token #=> String # resp.recording_configurations #=> Array # resp.recording_configurations[0].arn #=> String - # resp.recording_configurations[0].name #=> String # resp.recording_configurations[0].destination_configuration.s3.bucket_name #=> String + # resp.recording_configurations[0].name #=> String # resp.recording_configurations[0].state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE" # resp.recording_configurations[0].tags #=> Hash # resp.recording_configurations[0].tags["TagKey"] #=> String - # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListRecordingConfigurations AWS API Documentation # @@ -1630,17 +1631,17 @@ def list_recording_configurations(params = {}, options = {}) # @option params [required, String] :channel_arn # Channel ARN used to filter the list. # + # @option params [Integer] :max_results + # Maximum number of streamKeys to return. Default: 1. + # # @option params [String] :next_token # The first stream key to retrieve. This is used for pagination; see the # `nextToken` response field. # - # @option params [Integer] :max_results - # Maximum number of streamKeys to return. Default: 1. - # # @return [Types::ListStreamKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::ListStreamKeysResponse#stream_keys #stream_keys} => Array<Types::StreamKeySummary> # * {Types::ListStreamKeysResponse#next_token #next_token} => String + # * {Types::ListStreamKeysResponse#stream_keys #stream_keys} => Array<Types::StreamKeySummary> # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # @@ -1648,18 +1649,18 @@ def list_recording_configurations(params = {}, options = {}) # # resp = client.list_stream_keys({ # channel_arn: "ChannelArn", # required - # next_token: "PaginationToken", # max_results: 1, + # next_token: "PaginationToken", # }) # # @example Response structure # + # resp.next_token #=> String # resp.stream_keys #=> Array # resp.stream_keys[0].arn #=> String # resp.stream_keys[0].channel_arn #=> String # resp.stream_keys[0].tags #=> Hash # resp.stream_keys[0].tags["TagKey"] #=> String - # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeys AWS API Documentation # @@ -1676,17 +1677,17 @@ def list_stream_keys(params = {}, options = {}) # @option params [required, String] :channel_arn # Channel ARN used to filter the list. # + # @option params [Integer] :max_results + # Maximum number of streams to return. Default: 100. + # # @option params [String] :next_token # The first stream to retrieve. This is used for pagination; see the # `nextToken` response field. # - # @option params [Integer] :max_results - # Maximum number of streams to return. Default: 100. - # # @return [Types::ListStreamSessionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::ListStreamSessionsResponse#stream_sessions #stream_sessions} => Array<Types::StreamSessionSummary> # * {Types::ListStreamSessionsResponse#next_token #next_token} => String + # * {Types::ListStreamSessionsResponse#stream_sessions #stream_sessions} => Array<Types::StreamSessionSummary> # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # @@ -1694,18 +1695,18 @@ def list_stream_keys(params = {}, options = {}) # # resp = client.list_stream_sessions({ # channel_arn: "ChannelArn", # required - # next_token: "PaginationToken", # max_results: 1, + # next_token: "PaginationToken", # }) # # @example Response structure # + # resp.next_token #=> String # resp.stream_sessions #=> Array - # resp.stream_sessions[0].stream_id #=> String - # resp.stream_sessions[0].start_time #=> Time # resp.stream_sessions[0].end_time #=> Time # resp.stream_sessions[0].has_error_event #=> Boolean - # resp.next_token #=> String + # resp.stream_sessions[0].start_time #=> Time + # resp.stream_sessions[0].stream_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamSessions AWS API Documentation # @@ -1722,17 +1723,17 @@ def list_stream_sessions(params = {}, options = {}) # @option params [Types::StreamFilters] :filter_by # Filters the stream list to match the specified criterion. # + # @option params [Integer] :max_results + # Maximum number of streams to return. Default: 100. + # # @option params [String] :next_token # The first stream to retrieve. This is used for pagination; see the # `nextToken` response field. # - # @option params [Integer] :max_results - # Maximum number of streams to return. Default: 100. - # # @return [Types::ListStreamsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::ListStreamsResponse#streams #streams} => Array<Types::StreamSummary> # * {Types::ListStreamsResponse#next_token #next_token} => String + # * {Types::ListStreamsResponse#streams #streams} => Array<Types::StreamSummary> # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # @@ -1742,20 +1743,20 @@ def list_stream_sessions(params = {}, options = {}) # filter_by: { # health: "HEALTHY", # accepts HEALTHY, STARVING, UNKNOWN # }, - # next_token: "PaginationToken", # max_results: 1, + # next_token: "PaginationToken", # }) # # @example Response structure # + # resp.next_token #=> String # resp.streams #=> Array # resp.streams[0].channel_arn #=> String - # resp.streams[0].stream_id #=> String - # resp.streams[0].state #=> String, one of "LIVE", "OFFLINE" # resp.streams[0].health #=> String, one of "HEALTHY", "STARVING", "UNKNOWN" - # resp.streams[0].viewer_count #=> Integer # resp.streams[0].start_time #=> Time - # resp.next_token #=> String + # resp.streams[0].state #=> String, one of "LIVE", "OFFLINE" + # resp.streams[0].stream_id #=> String + # resp.streams[0].viewer_count #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreams AWS API Documentation # @@ -1985,46 +1986,46 @@ def untag_resource(params = {}, options = {}) # @option params [required, String] :arn # ARN of the channel to be updated. # - # @option params [String] :name - # Channel name. + # @option params [Boolean] :authorized + # Whether the channel is private (enabled for playback authorization). + # + # @option params [Boolean] :insecure_ingest + # Whether the channel allows insecure RTMP and SRT ingest. Default: + # `false`. # # @option params [String] :latency_mode # Channel latency mode. Use `NORMAL` to broadcast and deliver live video # up to Full HD. Use `LOW` for near-real-time interaction with viewers. # - # @option params [String] :type - # 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][1]. - # - # + # @option params [String] :name + # Channel name. # - # [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html + # @option params [String] :playback_restriction_policy_arn + # 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. # - # @option params [Boolean] :authorized - # Whether the channel is private (enabled for playback authorization). + # @option params [String] :preset + # 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 + # (`""`). # # @option params [String] :recording_configuration_arn # 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. # - # @option params [Boolean] :insecure_ingest - # Whether the channel allows insecure RTMP and SRT ingest. Default: - # `false`. + # @option params [String] :type + # 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][1]. # - # @option params [String] :preset - # 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 - # (`""`). # - # @option params [String] :playback_restriction_policy_arn - # 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. + # + # [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html # # @return [Types::UpdateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -2034,33 +2035,33 @@ def untag_resource(params = {}, options = {}) # # resp = client.update_channel({ # arn: "ChannelArn", # required - # name: "ChannelName", - # latency_mode: "NORMAL", # accepts NORMAL, LOW - # type: "BASIC", # accepts BASIC, STANDARD, ADVANCED_SD, ADVANCED_HD # authorized: false, - # recording_configuration_arn: "ChannelRecordingConfigurationArn", # insecure_ingest: false, - # preset: "HIGHER_BANDWIDTH_DELIVERY", # accepts HIGHER_BANDWIDTH_DELIVERY, CONSTRAINED_BANDWIDTH_DELIVERY + # latency_mode: "NORMAL", # accepts NORMAL, LOW + # name: "ChannelName", # playback_restriction_policy_arn: "ChannelPlaybackRestrictionPolicyArn", + # preset: "HIGHER_BANDWIDTH_DELIVERY", # accepts HIGHER_BANDWIDTH_DELIVERY, CONSTRAINED_BANDWIDTH_DELIVERY + # recording_configuration_arn: "ChannelRecordingConfigurationArn", + # type: "BASIC", # accepts BASIC, STANDARD, ADVANCED_SD, ADVANCED_HD # }) # # @example Response structure # # resp.channel.arn #=> String - # resp.channel.name #=> String - # resp.channel.latency_mode #=> String, one of "NORMAL", "LOW" - # resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD" - # resp.channel.recording_configuration_arn #=> String - # resp.channel.ingest_endpoint #=> String - # resp.channel.playback_url #=> String # resp.channel.authorized #=> Boolean - # resp.channel.tags #=> Hash - # resp.channel.tags["TagKey"] #=> String + # resp.channel.ingest_endpoint #=> String # resp.channel.insecure_ingest #=> Boolean + # resp.channel.latency_mode #=> String, one of "NORMAL", "LOW" + # resp.channel.name #=> String + # resp.channel.playback_restriction_policy_arn #=> String + # resp.channel.playback_url #=> String # resp.channel.preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY" + # resp.channel.recording_configuration_arn #=> String # resp.channel.srt.endpoint #=> String # resp.channel.srt.passphrase #=> String - # resp.channel.playback_restriction_policy_arn #=> String + # resp.channel.tags #=> Hash + # resp.channel.tags["TagKey"] #=> String + # resp.channel.type #=> String, one of "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD" # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateChannel AWS API Documentation # @@ -2073,9 +2074,6 @@ def update_channel(params = {}, options = {}) # Updates a specified playback restriction policy. # - # @option params [required, String] :arn - # ARN of the playback-restriction-policy to be updated. - # # @option params [Array] :allowed_countries # A list of country codes that control geoblocking restriction. Allowed # values are the officially assigned [ISO 3166-1 alpha-2][1] codes. @@ -2095,6 +2093,9 @@ def update_channel(params = {}, options = {}) # # [1]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin # + # @option params [required, String] :arn + # ARN of the playback-restriction-policy to be updated. + # # @option params [Boolean] :enable_strict_origin_enforcement # Whether channel playback is constrained by origin site. Default: # `false`. @@ -2110,20 +2111,20 @@ def update_channel(params = {}, options = {}) # @example Request syntax with placeholder values # # resp = client.update_playback_restriction_policy({ - # arn: "PlaybackRestrictionPolicyArn", # required # allowed_countries: ["PlaybackRestrictionPolicyAllowedCountry"], # allowed_origins: ["PlaybackRestrictionPolicyAllowedOrigin"], + # arn: "PlaybackRestrictionPolicyArn", # required # enable_strict_origin_enforcement: false, # name: "PlaybackRestrictionPolicyName", # }) # # @example Response structure # - # resp.playback_restriction_policy.arn #=> String # resp.playback_restriction_policy.allowed_countries #=> Array # resp.playback_restriction_policy.allowed_countries[0] #=> String # resp.playback_restriction_policy.allowed_origins #=> Array # resp.playback_restriction_policy.allowed_origins[0] #=> String + # resp.playback_restriction_policy.arn #=> String # resp.playback_restriction_policy.enable_strict_origin_enforcement #=> Boolean # resp.playback_restriction_policy.name #=> String # resp.playback_restriction_policy.tags #=> Hash @@ -2156,7 +2157,7 @@ def build_request(operation_name, params = {}) tracer: tracer ) context[:gem_name] = 'aws-sdk-ivs' - context[:gem_version] = '1.61.0' + context[:gem_version] = '1.62.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-ivs/lib/aws-sdk-ivs/client_api.rb b/gems/aws-sdk-ivs/lib/aws-sdk-ivs/client_api.rb index 522ed51d136..7184451dc9d 100644 --- a/gems/aws-sdk-ivs/lib/aws-sdk-ivs/client_api.rb +++ b/gems/aws-sdk-ivs/lib/aws-sdk-ivs/client_api.rb @@ -200,10 +200,10 @@ module ClientApi AccessDeniedException.add_member(:exception_message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "exceptionMessage")) AccessDeniedException.struct_class = Types::AccessDeniedException + AudioConfiguration.add_member(:channels, Shapes::ShapeRef.new(shape: Integer, location_name: "channels")) AudioConfiguration.add_member(:codec, Shapes::ShapeRef.new(shape: String, location_name: "codec")) - AudioConfiguration.add_member(:target_bitrate, Shapes::ShapeRef.new(shape: Integer, location_name: "targetBitrate")) AudioConfiguration.add_member(:sample_rate, Shapes::ShapeRef.new(shape: Integer, location_name: "sampleRate")) - AudioConfiguration.add_member(:channels, Shapes::ShapeRef.new(shape: Integer, location_name: "channels")) + AudioConfiguration.add_member(:target_bitrate, Shapes::ShapeRef.new(shape: Integer, location_name: "targetBitrate")) AudioConfiguration.struct_class = Types::AudioConfiguration BatchError.add_member(:arn, Shapes::ShapeRef.new(shape: ResourceArn, location_name: "arn")) @@ -223,14 +223,14 @@ module ClientApi BatchGetStreamKeyRequest.add_member(:arns, Shapes::ShapeRef.new(shape: StreamKeyArnList, required: true, location_name: "arns")) BatchGetStreamKeyRequest.struct_class = Types::BatchGetStreamKeyRequest - BatchGetStreamKeyResponse.add_member(:stream_keys, Shapes::ShapeRef.new(shape: StreamKeys, location_name: "streamKeys")) BatchGetStreamKeyResponse.add_member(:errors, Shapes::ShapeRef.new(shape: BatchErrors, location_name: "errors")) + BatchGetStreamKeyResponse.add_member(:stream_keys, Shapes::ShapeRef.new(shape: StreamKeys, location_name: "streamKeys")) BatchGetStreamKeyResponse.struct_class = Types::BatchGetStreamKeyResponse BatchStartViewerSessionRevocationError.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChannelArn, required: true, location_name: "channelArn")) - BatchStartViewerSessionRevocationError.add_member(:viewer_id, Shapes::ShapeRef.new(shape: ViewerId, required: true, location_name: "viewerId")) BatchStartViewerSessionRevocationError.add_member(:code, Shapes::ShapeRef.new(shape: errorCode, location_name: "code")) BatchStartViewerSessionRevocationError.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message")) + BatchStartViewerSessionRevocationError.add_member(:viewer_id, Shapes::ShapeRef.new(shape: ViewerId, required: true, location_name: "viewerId")) BatchStartViewerSessionRevocationError.struct_class = Types::BatchStartViewerSessionRevocationError BatchStartViewerSessionRevocationErrors.member = Shapes::ShapeRef.new(shape: BatchStartViewerSessionRevocationError) @@ -249,18 +249,18 @@ module ClientApi BatchStartViewerSessionRevocationViewerSessionList.member = Shapes::ShapeRef.new(shape: BatchStartViewerSessionRevocationViewerSession) Channel.add_member(:arn, Shapes::ShapeRef.new(shape: ChannelArn, location_name: "arn")) - Channel.add_member(:name, Shapes::ShapeRef.new(shape: ChannelName, location_name: "name")) - Channel.add_member(:latency_mode, Shapes::ShapeRef.new(shape: ChannelLatencyMode, location_name: "latencyMode")) - Channel.add_member(:type, Shapes::ShapeRef.new(shape: ChannelType, location_name: "type")) - Channel.add_member(:recording_configuration_arn, Shapes::ShapeRef.new(shape: ChannelRecordingConfigurationArn, location_name: "recordingConfigurationArn")) - Channel.add_member(:ingest_endpoint, Shapes::ShapeRef.new(shape: IngestEndpoint, location_name: "ingestEndpoint")) - Channel.add_member(:playback_url, Shapes::ShapeRef.new(shape: PlaybackURL, location_name: "playbackUrl")) Channel.add_member(:authorized, Shapes::ShapeRef.new(shape: IsAuthorized, location_name: "authorized")) - Channel.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags")) + Channel.add_member(:ingest_endpoint, Shapes::ShapeRef.new(shape: IngestEndpoint, location_name: "ingestEndpoint")) Channel.add_member(:insecure_ingest, Shapes::ShapeRef.new(shape: InsecureIngest, location_name: "insecureIngest")) + Channel.add_member(:latency_mode, Shapes::ShapeRef.new(shape: ChannelLatencyMode, location_name: "latencyMode")) + Channel.add_member(:name, Shapes::ShapeRef.new(shape: ChannelName, location_name: "name")) + Channel.add_member(:playback_restriction_policy_arn, Shapes::ShapeRef.new(shape: ChannelPlaybackRestrictionPolicyArn, location_name: "playbackRestrictionPolicyArn")) + Channel.add_member(:playback_url, Shapes::ShapeRef.new(shape: PlaybackURL, location_name: "playbackUrl")) Channel.add_member(:preset, Shapes::ShapeRef.new(shape: TranscodePreset, location_name: "preset")) + Channel.add_member(:recording_configuration_arn, Shapes::ShapeRef.new(shape: ChannelRecordingConfigurationArn, location_name: "recordingConfigurationArn")) Channel.add_member(:srt, Shapes::ShapeRef.new(shape: Srt, location_name: "srt")) - Channel.add_member(:playback_restriction_policy_arn, Shapes::ShapeRef.new(shape: ChannelPlaybackRestrictionPolicyArn, location_name: "playbackRestrictionPolicyArn")) + Channel.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags")) + Channel.add_member(:type, Shapes::ShapeRef.new(shape: ChannelType, location_name: "type")) Channel.struct_class = Types::Channel ChannelArnList.member = Shapes::ShapeRef.new(shape: ChannelArn) @@ -271,15 +271,15 @@ module ClientApi ChannelNotBroadcasting.struct_class = Types::ChannelNotBroadcasting ChannelSummary.add_member(:arn, Shapes::ShapeRef.new(shape: ChannelArn, location_name: "arn")) - ChannelSummary.add_member(:name, Shapes::ShapeRef.new(shape: ChannelName, location_name: "name")) - ChannelSummary.add_member(:latency_mode, Shapes::ShapeRef.new(shape: ChannelLatencyMode, location_name: "latencyMode")) ChannelSummary.add_member(:authorized, Shapes::ShapeRef.new(shape: IsAuthorized, location_name: "authorized")) + ChannelSummary.add_member(:insecure_ingest, Shapes::ShapeRef.new(shape: InsecureIngest, location_name: "insecureIngest")) + ChannelSummary.add_member(:latency_mode, Shapes::ShapeRef.new(shape: ChannelLatencyMode, location_name: "latencyMode")) + ChannelSummary.add_member(:name, Shapes::ShapeRef.new(shape: ChannelName, location_name: "name")) + ChannelSummary.add_member(:playback_restriction_policy_arn, Shapes::ShapeRef.new(shape: ChannelPlaybackRestrictionPolicyArn, location_name: "playbackRestrictionPolicyArn")) + ChannelSummary.add_member(:preset, Shapes::ShapeRef.new(shape: TranscodePreset, location_name: "preset")) ChannelSummary.add_member(:recording_configuration_arn, Shapes::ShapeRef.new(shape: ChannelRecordingConfigurationArn, location_name: "recordingConfigurationArn")) ChannelSummary.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags")) - ChannelSummary.add_member(:insecure_ingest, Shapes::ShapeRef.new(shape: InsecureIngest, location_name: "insecureIngest")) ChannelSummary.add_member(:type, Shapes::ShapeRef.new(shape: ChannelType, location_name: "type")) - ChannelSummary.add_member(:preset, Shapes::ShapeRef.new(shape: TranscodePreset, location_name: "preset")) - ChannelSummary.add_member(:playback_restriction_policy_arn, Shapes::ShapeRef.new(shape: ChannelPlaybackRestrictionPolicyArn, location_name: "playbackRestrictionPolicyArn")) ChannelSummary.struct_class = Types::ChannelSummary Channels.member = Shapes::ShapeRef.new(shape: Channel) @@ -287,15 +287,15 @@ module ClientApi ConflictException.add_member(:exception_message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "exceptionMessage")) ConflictException.struct_class = Types::ConflictException - CreateChannelRequest.add_member(:name, Shapes::ShapeRef.new(shape: ChannelName, location_name: "name")) - CreateChannelRequest.add_member(:latency_mode, Shapes::ShapeRef.new(shape: ChannelLatencyMode, location_name: "latencyMode")) - CreateChannelRequest.add_member(:type, Shapes::ShapeRef.new(shape: ChannelType, location_name: "type")) CreateChannelRequest.add_member(:authorized, Shapes::ShapeRef.new(shape: Boolean, location_name: "authorized")) - CreateChannelRequest.add_member(:recording_configuration_arn, Shapes::ShapeRef.new(shape: ChannelRecordingConfigurationArn, location_name: "recordingConfigurationArn")) - CreateChannelRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags")) CreateChannelRequest.add_member(:insecure_ingest, Shapes::ShapeRef.new(shape: Boolean, location_name: "insecureIngest")) - CreateChannelRequest.add_member(:preset, Shapes::ShapeRef.new(shape: TranscodePreset, location_name: "preset")) + CreateChannelRequest.add_member(:latency_mode, Shapes::ShapeRef.new(shape: ChannelLatencyMode, location_name: "latencyMode")) + CreateChannelRequest.add_member(:name, Shapes::ShapeRef.new(shape: ChannelName, location_name: "name")) CreateChannelRequest.add_member(:playback_restriction_policy_arn, Shapes::ShapeRef.new(shape: ChannelPlaybackRestrictionPolicyArn, location_name: "playbackRestrictionPolicyArn")) + CreateChannelRequest.add_member(:preset, Shapes::ShapeRef.new(shape: TranscodePreset, location_name: "preset")) + CreateChannelRequest.add_member(:recording_configuration_arn, Shapes::ShapeRef.new(shape: ChannelRecordingConfigurationArn, location_name: "recordingConfigurationArn")) + CreateChannelRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags")) + CreateChannelRequest.add_member(:type, Shapes::ShapeRef.new(shape: ChannelType, location_name: "type")) CreateChannelRequest.struct_class = Types::CreateChannelRequest CreateChannelResponse.add_member(:channel, Shapes::ShapeRef.new(shape: Channel, location_name: "channel")) @@ -312,12 +312,12 @@ module ClientApi CreatePlaybackRestrictionPolicyResponse.add_member(:playback_restriction_policy, Shapes::ShapeRef.new(shape: PlaybackRestrictionPolicy, location_name: "playbackRestrictionPolicy")) CreatePlaybackRestrictionPolicyResponse.struct_class = Types::CreatePlaybackRestrictionPolicyResponse - CreateRecordingConfigurationRequest.add_member(:name, Shapes::ShapeRef.new(shape: RecordingConfigurationName, location_name: "name")) CreateRecordingConfigurationRequest.add_member(:destination_configuration, Shapes::ShapeRef.new(shape: DestinationConfiguration, required: true, location_name: "destinationConfiguration")) - CreateRecordingConfigurationRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags")) - CreateRecordingConfigurationRequest.add_member(:thumbnail_configuration, Shapes::ShapeRef.new(shape: ThumbnailConfiguration, location_name: "thumbnailConfiguration")) + CreateRecordingConfigurationRequest.add_member(:name, Shapes::ShapeRef.new(shape: RecordingConfigurationName, location_name: "name")) CreateRecordingConfigurationRequest.add_member(:recording_reconnect_window_seconds, Shapes::ShapeRef.new(shape: RecordingReconnectWindowSeconds, location_name: "recordingReconnectWindowSeconds")) CreateRecordingConfigurationRequest.add_member(:rendition_configuration, Shapes::ShapeRef.new(shape: RenditionConfiguration, location_name: "renditionConfiguration")) + CreateRecordingConfigurationRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags")) + CreateRecordingConfigurationRequest.add_member(:thumbnail_configuration, Shapes::ShapeRef.new(shape: ThumbnailConfiguration, location_name: "thumbnailConfiguration")) CreateRecordingConfigurationRequest.struct_class = Types::CreateRecordingConfigurationRequest CreateRecordingConfigurationResponse.add_member(:recording_configuration, Shapes::ShapeRef.new(shape: RecordingConfiguration, location_name: "recordingConfiguration")) @@ -393,81 +393,81 @@ module ClientApi GetStreamSessionResponse.add_member(:stream_session, Shapes::ShapeRef.new(shape: StreamSession, location_name: "streamSession")) GetStreamSessionResponse.struct_class = Types::GetStreamSessionResponse - ImportPlaybackKeyPairRequest.add_member(:public_key_material, Shapes::ShapeRef.new(shape: PlaybackPublicKeyMaterial, required: true, location_name: "publicKeyMaterial")) ImportPlaybackKeyPairRequest.add_member(:name, Shapes::ShapeRef.new(shape: PlaybackKeyPairName, location_name: "name")) + ImportPlaybackKeyPairRequest.add_member(:public_key_material, Shapes::ShapeRef.new(shape: PlaybackPublicKeyMaterial, required: true, location_name: "publicKeyMaterial")) ImportPlaybackKeyPairRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags")) ImportPlaybackKeyPairRequest.struct_class = Types::ImportPlaybackKeyPairRequest ImportPlaybackKeyPairResponse.add_member(:key_pair, Shapes::ShapeRef.new(shape: PlaybackKeyPair, location_name: "keyPair")) ImportPlaybackKeyPairResponse.struct_class = Types::ImportPlaybackKeyPairResponse - IngestConfiguration.add_member(:video, Shapes::ShapeRef.new(shape: VideoConfiguration, location_name: "video")) IngestConfiguration.add_member(:audio, Shapes::ShapeRef.new(shape: AudioConfiguration, location_name: "audio")) + IngestConfiguration.add_member(:video, Shapes::ShapeRef.new(shape: VideoConfiguration, location_name: "video")) IngestConfiguration.struct_class = Types::IngestConfiguration InternalServerException.add_member(:exception_message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "exceptionMessage")) InternalServerException.struct_class = Types::InternalServerException ListChannelsRequest.add_member(:filter_by_name, Shapes::ShapeRef.new(shape: ChannelName, location_name: "filterByName")) - ListChannelsRequest.add_member(:filter_by_recording_configuration_arn, Shapes::ShapeRef.new(shape: ChannelRecordingConfigurationArn, location_name: "filterByRecordingConfigurationArn")) ListChannelsRequest.add_member(:filter_by_playback_restriction_policy_arn, Shapes::ShapeRef.new(shape: ChannelPlaybackRestrictionPolicyArn, location_name: "filterByPlaybackRestrictionPolicyArn")) - ListChannelsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) + ListChannelsRequest.add_member(:filter_by_recording_configuration_arn, Shapes::ShapeRef.new(shape: ChannelRecordingConfigurationArn, location_name: "filterByRecordingConfigurationArn")) ListChannelsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxChannelResults, location_name: "maxResults")) + ListChannelsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) ListChannelsRequest.struct_class = Types::ListChannelsRequest ListChannelsResponse.add_member(:channels, Shapes::ShapeRef.new(shape: ChannelList, required: true, location_name: "channels")) ListChannelsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) ListChannelsResponse.struct_class = Types::ListChannelsResponse - ListPlaybackKeyPairsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) ListPlaybackKeyPairsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxPlaybackKeyPairResults, location_name: "maxResults")) + ListPlaybackKeyPairsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) ListPlaybackKeyPairsRequest.struct_class = Types::ListPlaybackKeyPairsRequest ListPlaybackKeyPairsResponse.add_member(:key_pairs, Shapes::ShapeRef.new(shape: PlaybackKeyPairList, required: true, location_name: "keyPairs")) ListPlaybackKeyPairsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) ListPlaybackKeyPairsResponse.struct_class = Types::ListPlaybackKeyPairsResponse - ListPlaybackRestrictionPoliciesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) ListPlaybackRestrictionPoliciesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxPlaybackRestrictionPolicyResults, location_name: "maxResults")) + ListPlaybackRestrictionPoliciesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) ListPlaybackRestrictionPoliciesRequest.struct_class = Types::ListPlaybackRestrictionPoliciesRequest - ListPlaybackRestrictionPoliciesResponse.add_member(:playback_restriction_policies, Shapes::ShapeRef.new(shape: PlaybackRestrictionPolicyList, required: true, location_name: "playbackRestrictionPolicies")) ListPlaybackRestrictionPoliciesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) + ListPlaybackRestrictionPoliciesResponse.add_member(:playback_restriction_policies, Shapes::ShapeRef.new(shape: PlaybackRestrictionPolicyList, required: true, location_name: "playbackRestrictionPolicies")) ListPlaybackRestrictionPoliciesResponse.struct_class = Types::ListPlaybackRestrictionPoliciesResponse - ListRecordingConfigurationsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) ListRecordingConfigurationsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxRecordingConfigurationResults, location_name: "maxResults")) + ListRecordingConfigurationsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) ListRecordingConfigurationsRequest.struct_class = Types::ListRecordingConfigurationsRequest - ListRecordingConfigurationsResponse.add_member(:recording_configurations, Shapes::ShapeRef.new(shape: RecordingConfigurationList, required: true, location_name: "recordingConfigurations")) ListRecordingConfigurationsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) + ListRecordingConfigurationsResponse.add_member(:recording_configurations, Shapes::ShapeRef.new(shape: RecordingConfigurationList, required: true, location_name: "recordingConfigurations")) ListRecordingConfigurationsResponse.struct_class = Types::ListRecordingConfigurationsResponse ListStreamKeysRequest.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChannelArn, required: true, location_name: "channelArn")) - ListStreamKeysRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) ListStreamKeysRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxStreamKeyResults, location_name: "maxResults")) + ListStreamKeysRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) ListStreamKeysRequest.struct_class = Types::ListStreamKeysRequest - ListStreamKeysResponse.add_member(:stream_keys, Shapes::ShapeRef.new(shape: StreamKeyList, required: true, location_name: "streamKeys")) ListStreamKeysResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) + ListStreamKeysResponse.add_member(:stream_keys, Shapes::ShapeRef.new(shape: StreamKeyList, required: true, location_name: "streamKeys")) ListStreamKeysResponse.struct_class = Types::ListStreamKeysResponse ListStreamSessionsRequest.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChannelArn, required: true, location_name: "channelArn")) - ListStreamSessionsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) ListStreamSessionsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxStreamResults, location_name: "maxResults")) + ListStreamSessionsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) ListStreamSessionsRequest.struct_class = Types::ListStreamSessionsRequest - ListStreamSessionsResponse.add_member(:stream_sessions, Shapes::ShapeRef.new(shape: StreamSessionList, required: true, location_name: "streamSessions")) ListStreamSessionsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) + ListStreamSessionsResponse.add_member(:stream_sessions, Shapes::ShapeRef.new(shape: StreamSessionList, required: true, location_name: "streamSessions")) ListStreamSessionsResponse.struct_class = Types::ListStreamSessionsResponse ListStreamsRequest.add_member(:filter_by, Shapes::ShapeRef.new(shape: StreamFilters, location_name: "filterBy")) - ListStreamsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) ListStreamsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxStreamResults, location_name: "maxResults")) + ListStreamsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) ListStreamsRequest.struct_class = Types::ListStreamsRequest - ListStreamsResponse.add_member(:streams, Shapes::ShapeRef.new(shape: StreamList, required: true, location_name: "streams")) ListStreamsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) + ListStreamsResponse.add_member(:streams, Shapes::ShapeRef.new(shape: StreamList, required: true, location_name: "streams")) ListStreamsResponse.struct_class = Types::ListStreamsResponse ListTagsForResourceRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: ResourceArn, required: true, location: "uri", location_name: "resourceArn")) @@ -480,8 +480,8 @@ module ClientApi PendingVerification.struct_class = Types::PendingVerification PlaybackKeyPair.add_member(:arn, Shapes::ShapeRef.new(shape: PlaybackKeyPairArn, location_name: "arn")) - PlaybackKeyPair.add_member(:name, Shapes::ShapeRef.new(shape: PlaybackKeyPairName, location_name: "name")) PlaybackKeyPair.add_member(:fingerprint, Shapes::ShapeRef.new(shape: PlaybackKeyPairFingerprint, location_name: "fingerprint")) + PlaybackKeyPair.add_member(:name, Shapes::ShapeRef.new(shape: PlaybackKeyPairName, location_name: "name")) PlaybackKeyPair.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags")) PlaybackKeyPair.struct_class = Types::PlaybackKeyPair @@ -492,9 +492,9 @@ module ClientApi PlaybackKeyPairSummary.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags")) PlaybackKeyPairSummary.struct_class = Types::PlaybackKeyPairSummary - PlaybackRestrictionPolicy.add_member(:arn, Shapes::ShapeRef.new(shape: PlaybackRestrictionPolicyArn, required: true, location_name: "arn")) PlaybackRestrictionPolicy.add_member(:allowed_countries, Shapes::ShapeRef.new(shape: PlaybackRestrictionPolicyAllowedCountryList, required: true, location_name: "allowedCountries")) PlaybackRestrictionPolicy.add_member(:allowed_origins, Shapes::ShapeRef.new(shape: PlaybackRestrictionPolicyAllowedOriginList, required: true, location_name: "allowedOrigins")) + PlaybackRestrictionPolicy.add_member(:arn, Shapes::ShapeRef.new(shape: PlaybackRestrictionPolicyArn, required: true, location_name: "arn")) PlaybackRestrictionPolicy.add_member(:enable_strict_origin_enforcement, Shapes::ShapeRef.new(shape: PlaybackRestrictionPolicyEnableStrictOriginEnforcement, location_name: "enableStrictOriginEnforcement")) PlaybackRestrictionPolicy.add_member(:name, Shapes::ShapeRef.new(shape: PlaybackRestrictionPolicyName, location_name: "name")) PlaybackRestrictionPolicy.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags")) @@ -506,9 +506,9 @@ module ClientApi PlaybackRestrictionPolicyList.member = Shapes::ShapeRef.new(shape: PlaybackRestrictionPolicySummary) - PlaybackRestrictionPolicySummary.add_member(:arn, Shapes::ShapeRef.new(shape: PlaybackRestrictionPolicyArn, required: true, location_name: "arn")) PlaybackRestrictionPolicySummary.add_member(:allowed_countries, Shapes::ShapeRef.new(shape: PlaybackRestrictionPolicyAllowedCountryList, required: true, location_name: "allowedCountries")) PlaybackRestrictionPolicySummary.add_member(:allowed_origins, Shapes::ShapeRef.new(shape: PlaybackRestrictionPolicyAllowedOriginList, required: true, location_name: "allowedOrigins")) + PlaybackRestrictionPolicySummary.add_member(:arn, Shapes::ShapeRef.new(shape: PlaybackRestrictionPolicyArn, required: true, location_name: "arn")) PlaybackRestrictionPolicySummary.add_member(:enable_strict_origin_enforcement, Shapes::ShapeRef.new(shape: PlaybackRestrictionPolicyEnableStrictOriginEnforcement, location_name: "enableStrictOriginEnforcement")) PlaybackRestrictionPolicySummary.add_member(:name, Shapes::ShapeRef.new(shape: PlaybackRestrictionPolicyName, location_name: "name")) PlaybackRestrictionPolicySummary.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags")) @@ -519,20 +519,20 @@ module ClientApi PutMetadataRequest.struct_class = Types::PutMetadataRequest RecordingConfiguration.add_member(:arn, Shapes::ShapeRef.new(shape: RecordingConfigurationArn, required: true, location_name: "arn")) - RecordingConfiguration.add_member(:name, Shapes::ShapeRef.new(shape: RecordingConfigurationName, location_name: "name")) RecordingConfiguration.add_member(:destination_configuration, Shapes::ShapeRef.new(shape: DestinationConfiguration, required: true, location_name: "destinationConfiguration")) + RecordingConfiguration.add_member(:name, Shapes::ShapeRef.new(shape: RecordingConfigurationName, location_name: "name")) + RecordingConfiguration.add_member(:recording_reconnect_window_seconds, Shapes::ShapeRef.new(shape: RecordingReconnectWindowSeconds, location_name: "recordingReconnectWindowSeconds")) + RecordingConfiguration.add_member(:rendition_configuration, Shapes::ShapeRef.new(shape: RenditionConfiguration, location_name: "renditionConfiguration")) RecordingConfiguration.add_member(:state, Shapes::ShapeRef.new(shape: RecordingConfigurationState, required: true, location_name: "state")) RecordingConfiguration.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags")) RecordingConfiguration.add_member(:thumbnail_configuration, Shapes::ShapeRef.new(shape: ThumbnailConfiguration, location_name: "thumbnailConfiguration")) - RecordingConfiguration.add_member(:recording_reconnect_window_seconds, Shapes::ShapeRef.new(shape: RecordingReconnectWindowSeconds, location_name: "recordingReconnectWindowSeconds")) - RecordingConfiguration.add_member(:rendition_configuration, Shapes::ShapeRef.new(shape: RenditionConfiguration, location_name: "renditionConfiguration")) RecordingConfiguration.struct_class = Types::RecordingConfiguration RecordingConfigurationList.member = Shapes::ShapeRef.new(shape: RecordingConfigurationSummary) RecordingConfigurationSummary.add_member(:arn, Shapes::ShapeRef.new(shape: RecordingConfigurationArn, required: true, location_name: "arn")) - RecordingConfigurationSummary.add_member(:name, Shapes::ShapeRef.new(shape: RecordingConfigurationName, location_name: "name")) RecordingConfigurationSummary.add_member(:destination_configuration, Shapes::ShapeRef.new(shape: DestinationConfiguration, required: true, location_name: "destinationConfiguration")) + RecordingConfigurationSummary.add_member(:name, Shapes::ShapeRef.new(shape: RecordingConfigurationName, location_name: "name")) RecordingConfigurationSummary.add_member(:state, Shapes::ShapeRef.new(shape: RecordingConfigurationState, required: true, location_name: "state")) RecordingConfigurationSummary.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags")) RecordingConfigurationSummary.struct_class = Types::RecordingConfigurationSummary @@ -569,17 +569,18 @@ module ClientApi StopStreamResponse.struct_class = Types::StopStreamResponse Stream.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChannelArn, location_name: "channelArn")) - Stream.add_member(:stream_id, Shapes::ShapeRef.new(shape: StreamId, location_name: "streamId")) + Stream.add_member(:health, Shapes::ShapeRef.new(shape: StreamHealth, location_name: "health")) Stream.add_member(:playback_url, Shapes::ShapeRef.new(shape: PlaybackURL, location_name: "playbackUrl")) Stream.add_member(:start_time, Shapes::ShapeRef.new(shape: StreamStartTime, location_name: "startTime")) Stream.add_member(:state, Shapes::ShapeRef.new(shape: StreamState, location_name: "state")) - Stream.add_member(:health, Shapes::ShapeRef.new(shape: StreamHealth, location_name: "health")) + Stream.add_member(:stream_id, Shapes::ShapeRef.new(shape: StreamId, location_name: "streamId")) Stream.add_member(:viewer_count, Shapes::ShapeRef.new(shape: StreamViewerCount, location_name: "viewerCount")) Stream.struct_class = Types::Stream + StreamEvent.add_member(:code, Shapes::ShapeRef.new(shape: String, location_name: "code")) + StreamEvent.add_member(:event_time, Shapes::ShapeRef.new(shape: Time, location_name: "eventTime")) StreamEvent.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "name")) StreamEvent.add_member(:type, Shapes::ShapeRef.new(shape: String, location_name: "type")) - StreamEvent.add_member(:event_time, Shapes::ShapeRef.new(shape: Time, location_name: "eventTime")) StreamEvent.struct_class = Types::StreamEvent StreamEvents.member = Shapes::ShapeRef.new(shape: StreamEvent) @@ -588,9 +589,9 @@ module ClientApi StreamFilters.struct_class = Types::StreamFilters StreamKey.add_member(:arn, Shapes::ShapeRef.new(shape: StreamKeyArn, location_name: "arn")) - StreamKey.add_member(:value, Shapes::ShapeRef.new(shape: StreamKeyValue, location_name: "value")) StreamKey.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChannelArn, location_name: "channelArn")) StreamKey.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags")) + StreamKey.add_member(:value, Shapes::ShapeRef.new(shape: StreamKeyValue, location_name: "value")) StreamKey.struct_class = Types::StreamKey StreamKeyArnList.member = Shapes::ShapeRef.new(shape: StreamKeyArn) @@ -606,29 +607,29 @@ module ClientApi StreamList.member = Shapes::ShapeRef.new(shape: StreamSummary) - StreamSession.add_member(:stream_id, Shapes::ShapeRef.new(shape: StreamId, location_name: "streamId")) - StreamSession.add_member(:start_time, Shapes::ShapeRef.new(shape: Time, location_name: "startTime")) - StreamSession.add_member(:end_time, Shapes::ShapeRef.new(shape: Time, location_name: "endTime")) StreamSession.add_member(:channel, Shapes::ShapeRef.new(shape: Channel, location_name: "channel")) + StreamSession.add_member(:end_time, Shapes::ShapeRef.new(shape: Time, location_name: "endTime")) StreamSession.add_member(:ingest_configuration, Shapes::ShapeRef.new(shape: IngestConfiguration, location_name: "ingestConfiguration")) StreamSession.add_member(:recording_configuration, Shapes::ShapeRef.new(shape: RecordingConfiguration, location_name: "recordingConfiguration")) + StreamSession.add_member(:start_time, Shapes::ShapeRef.new(shape: Time, location_name: "startTime")) + StreamSession.add_member(:stream_id, Shapes::ShapeRef.new(shape: StreamId, location_name: "streamId")) StreamSession.add_member(:truncated_events, Shapes::ShapeRef.new(shape: StreamEvents, location_name: "truncatedEvents")) StreamSession.struct_class = Types::StreamSession StreamSessionList.member = Shapes::ShapeRef.new(shape: StreamSessionSummary) - StreamSessionSummary.add_member(:stream_id, Shapes::ShapeRef.new(shape: StreamId, location_name: "streamId")) - StreamSessionSummary.add_member(:start_time, Shapes::ShapeRef.new(shape: Time, location_name: "startTime")) StreamSessionSummary.add_member(:end_time, Shapes::ShapeRef.new(shape: Time, location_name: "endTime")) StreamSessionSummary.add_member(:has_error_event, Shapes::ShapeRef.new(shape: Boolean, location_name: "hasErrorEvent")) + StreamSessionSummary.add_member(:start_time, Shapes::ShapeRef.new(shape: Time, location_name: "startTime")) + StreamSessionSummary.add_member(:stream_id, Shapes::ShapeRef.new(shape: StreamId, location_name: "streamId")) StreamSessionSummary.struct_class = Types::StreamSessionSummary StreamSummary.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChannelArn, location_name: "channelArn")) - StreamSummary.add_member(:stream_id, Shapes::ShapeRef.new(shape: StreamId, location_name: "streamId")) - StreamSummary.add_member(:state, Shapes::ShapeRef.new(shape: StreamState, location_name: "state")) StreamSummary.add_member(:health, Shapes::ShapeRef.new(shape: StreamHealth, location_name: "health")) - StreamSummary.add_member(:viewer_count, Shapes::ShapeRef.new(shape: StreamViewerCount, location_name: "viewerCount")) StreamSummary.add_member(:start_time, Shapes::ShapeRef.new(shape: StreamStartTime, location_name: "startTime")) + StreamSummary.add_member(:state, Shapes::ShapeRef.new(shape: StreamState, location_name: "state")) + StreamSummary.add_member(:stream_id, Shapes::ShapeRef.new(shape: StreamId, location_name: "streamId")) + StreamSummary.add_member(:viewer_count, Shapes::ShapeRef.new(shape: StreamViewerCount, location_name: "viewerCount")) StreamSummary.struct_class = Types::StreamSummary StreamUnavailable.add_member(:exception_message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "exceptionMessage")) @@ -649,9 +650,9 @@ module ClientApi ThrottlingException.struct_class = Types::ThrottlingException ThumbnailConfiguration.add_member(:recording_mode, Shapes::ShapeRef.new(shape: RecordingMode, location_name: "recordingMode")) - ThumbnailConfiguration.add_member(:target_interval_seconds, Shapes::ShapeRef.new(shape: TargetIntervalSeconds, location_name: "targetIntervalSeconds")) ThumbnailConfiguration.add_member(:resolution, Shapes::ShapeRef.new(shape: ThumbnailConfigurationResolution, location_name: "resolution")) ThumbnailConfiguration.add_member(:storage, Shapes::ShapeRef.new(shape: ThumbnailConfigurationStorageList, location_name: "storage")) + ThumbnailConfiguration.add_member(:target_interval_seconds, Shapes::ShapeRef.new(shape: TargetIntervalSeconds, location_name: "targetIntervalSeconds")) ThumbnailConfiguration.struct_class = Types::ThumbnailConfiguration ThumbnailConfigurationStorageList.member = Shapes::ShapeRef.new(shape: ThumbnailConfigurationStorage) @@ -663,22 +664,22 @@ module ClientApi UntagResourceResponse.struct_class = Types::UntagResourceResponse UpdateChannelRequest.add_member(:arn, Shapes::ShapeRef.new(shape: ChannelArn, required: true, location_name: "arn")) - UpdateChannelRequest.add_member(:name, Shapes::ShapeRef.new(shape: ChannelName, location_name: "name")) - UpdateChannelRequest.add_member(:latency_mode, Shapes::ShapeRef.new(shape: ChannelLatencyMode, location_name: "latencyMode")) - UpdateChannelRequest.add_member(:type, Shapes::ShapeRef.new(shape: ChannelType, location_name: "type")) UpdateChannelRequest.add_member(:authorized, Shapes::ShapeRef.new(shape: Boolean, location_name: "authorized")) - UpdateChannelRequest.add_member(:recording_configuration_arn, Shapes::ShapeRef.new(shape: ChannelRecordingConfigurationArn, location_name: "recordingConfigurationArn")) UpdateChannelRequest.add_member(:insecure_ingest, Shapes::ShapeRef.new(shape: Boolean, location_name: "insecureIngest")) - UpdateChannelRequest.add_member(:preset, Shapes::ShapeRef.new(shape: TranscodePreset, location_name: "preset")) + UpdateChannelRequest.add_member(:latency_mode, Shapes::ShapeRef.new(shape: ChannelLatencyMode, location_name: "latencyMode")) + UpdateChannelRequest.add_member(:name, Shapes::ShapeRef.new(shape: ChannelName, location_name: "name")) UpdateChannelRequest.add_member(:playback_restriction_policy_arn, Shapes::ShapeRef.new(shape: ChannelPlaybackRestrictionPolicyArn, location_name: "playbackRestrictionPolicyArn")) + UpdateChannelRequest.add_member(:preset, Shapes::ShapeRef.new(shape: TranscodePreset, location_name: "preset")) + UpdateChannelRequest.add_member(:recording_configuration_arn, Shapes::ShapeRef.new(shape: ChannelRecordingConfigurationArn, location_name: "recordingConfigurationArn")) + UpdateChannelRequest.add_member(:type, Shapes::ShapeRef.new(shape: ChannelType, location_name: "type")) UpdateChannelRequest.struct_class = Types::UpdateChannelRequest UpdateChannelResponse.add_member(:channel, Shapes::ShapeRef.new(shape: Channel, location_name: "channel")) UpdateChannelResponse.struct_class = Types::UpdateChannelResponse - UpdatePlaybackRestrictionPolicyRequest.add_member(:arn, Shapes::ShapeRef.new(shape: PlaybackRestrictionPolicyArn, required: true, location_name: "arn")) UpdatePlaybackRestrictionPolicyRequest.add_member(:allowed_countries, Shapes::ShapeRef.new(shape: PlaybackRestrictionPolicyAllowedCountryList, location_name: "allowedCountries")) UpdatePlaybackRestrictionPolicyRequest.add_member(:allowed_origins, Shapes::ShapeRef.new(shape: PlaybackRestrictionPolicyAllowedOriginList, location_name: "allowedOrigins")) + UpdatePlaybackRestrictionPolicyRequest.add_member(:arn, Shapes::ShapeRef.new(shape: PlaybackRestrictionPolicyArn, required: true, location_name: "arn")) UpdatePlaybackRestrictionPolicyRequest.add_member(:enable_strict_origin_enforcement, Shapes::ShapeRef.new(shape: PlaybackRestrictionPolicyEnableStrictOriginEnforcement, location_name: "enableStrictOriginEnforcement")) UpdatePlaybackRestrictionPolicyRequest.add_member(:name, Shapes::ShapeRef.new(shape: PlaybackRestrictionPolicyName, location_name: "name")) UpdatePlaybackRestrictionPolicyRequest.struct_class = Types::UpdatePlaybackRestrictionPolicyRequest @@ -689,8 +690,8 @@ module ClientApi ValidationException.add_member(:exception_message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "exceptionMessage")) ValidationException.struct_class = Types::ValidationException - VideoConfiguration.add_member(:avc_profile, Shapes::ShapeRef.new(shape: String, location_name: "avcProfile")) VideoConfiguration.add_member(:avc_level, Shapes::ShapeRef.new(shape: String, location_name: "avcLevel")) + VideoConfiguration.add_member(:avc_profile, Shapes::ShapeRef.new(shape: String, location_name: "avcProfile")) VideoConfiguration.add_member(:codec, Shapes::ShapeRef.new(shape: String, location_name: "codec")) VideoConfiguration.add_member(:encoder, Shapes::ShapeRef.new(shape: String, location_name: "encoder")) VideoConfiguration.add_member(:target_bitrate, Shapes::ShapeRef.new(shape: Integer, location_name: "targetBitrate")) @@ -709,6 +710,7 @@ module ClientApi "apiVersion" => "2020-07-14", "auth" => ["aws.auth#sigv4"], "endpointPrefix" => "ivs", + "jsonVersion" => "1.1", "protocol" => "rest-json", "protocols" => ["rest-json"], "serviceAbbreviation" => "Amazon IVS", diff --git a/gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb b/gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb index 742a6b18653..a1000a03218 100644 --- a/gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb +++ b/gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb @@ -26,30 +26,30 @@ class AccessDeniedException < Struct.new( # broadcaster (usually in an encoder). This is part of the # IngestConfiguration object and used for monitoring stream health. # + # @!attribute [rw] channels + # Number of audio channels. + # @return [Integer] + # # @!attribute [rw] codec # Codec used for the audio encoding. # @return [String] # - # @!attribute [rw] target_bitrate - # The expected ingest bitrate (bits per second). This is configured in - # the encoder. - # @return [Integer] - # # @!attribute [rw] sample_rate # Number of audio samples recorded per second. # @return [Integer] # - # @!attribute [rw] channels - # Number of audio channels. + # @!attribute [rw] target_bitrate + # The expected ingest bitrate (bits per second). This is configured in + # the encoder. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/AudioConfiguration AWS API Documentation # class AudioConfiguration < Struct.new( + :channels, :codec, - :target_bitrate, :sample_rate, - :channels) + :target_bitrate) SENSITIVE = [] include Aws::Structure end @@ -118,17 +118,17 @@ class BatchGetStreamKeyRequest < Struct.new( include Aws::Structure end - # @!attribute [rw] stream_keys - # @return [Array] - # # @!attribute [rw] errors # @return [Array] # + # @!attribute [rw] stream_keys + # @return [Array] + # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchGetStreamKeyResponse AWS API Documentation # class BatchGetStreamKeyResponse < Struct.new( - :stream_keys, - :errors) + :errors, + :stream_keys) SENSITIVE = [] include Aws::Structure end @@ -141,10 +141,6 @@ class BatchGetStreamKeyResponse < Struct.new( # Channel ARN. # @return [String] # - # @!attribute [rw] viewer_id - # The ID of the viewer session to revoke. - # @return [String] - # # @!attribute [rw] code # Error code. # @return [String] @@ -153,13 +149,17 @@ class BatchGetStreamKeyResponse < Struct.new( # Error message, determined by the application. # @return [String] # + # @!attribute [rw] viewer_id + # The ID of the viewer session to revoke. + # @return [String] + # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchStartViewerSessionRevocationError AWS API Documentation # class BatchStartViewerSessionRevocationError < Struct.new( :channel_arn, - :viewer_id, :code, - :message) + :message, + :viewer_id) SENSITIVE = [] include Aws::Structure end @@ -224,25 +224,46 @@ class BatchStartViewerSessionRevocationViewerSession < Struct.new( # Channel ARN. # @return [String] # - # @!attribute [rw] name - # Channel name. + # @!attribute [rw] authorized + # Whether the channel is private (enabled for playback authorization). + # Default: `false`. + # @return [Boolean] + # + # @!attribute [rw] ingest_endpoint + # Channel ingest endpoint, part of the definition of an ingest server, + # used when you set up streaming software. # @return [String] # + # @!attribute [rw] insecure_ingest + # Whether the channel allows insecure RTMP ingest. Default: `false`. + # @return [Boolean] + # # @!attribute [rw] latency_mode # 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`. # @return [String] # - # @!attribute [rw] type - # 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][1]. + # @!attribute [rw] name + # Channel name. + # @return [String] # + # @!attribute [rw] playback_restriction_policy_arn + # 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). + # @return [String] # + # @!attribute [rw] playback_url + # Channel playback URL. + # @return [String] # - # [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html + # @!attribute [rw] preset + # 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 (`""`). # @return [String] # # @!attribute [rw] recording_configuration_arn @@ -251,19 +272,10 @@ class BatchStartViewerSessionRevocationViewerSession < Struct.new( # recording is disabled). # @return [String] # - # @!attribute [rw] ingest_endpoint - # Channel ingest endpoint, part of the definition of an ingest server, - # used when you set up streaming software. - # @return [String] - # - # @!attribute [rw] playback_url - # Channel playback URL. - # @return [String] - # - # @!attribute [rw] authorized - # Whether the channel is private (enabled for playback authorization). - # Default: `false`. - # @return [Boolean] + # @!attribute [rw] srt + # Specifies the endpoint and optional passphrase for streaming with + # the SRT protocol. + # @return [Types::Srt] # # @!attribute [rw] tags # Tags attached to the resource. Array of 1-50 maps, each of the form @@ -278,45 +290,33 @@ class BatchStartViewerSessionRevocationViewerSession < Struct.new( # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html # @return [Hash] # - # @!attribute [rw] insecure_ingest - # Whether the channel allows insecure RTMP ingest. Default: `false`. - # @return [Boolean] + # @!attribute [rw] type + # 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][1]. # - # @!attribute [rw] preset - # 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 (`""`). - # @return [String] # - # @!attribute [rw] srt - # Specifies the endpoint and optional passphrase for streaming with - # the SRT protocol. - # @return [Types::Srt] # - # @!attribute [rw] playback_restriction_policy_arn - # 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). + # [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/Channel AWS API Documentation # class Channel < Struct.new( :arn, - :name, - :latency_mode, - :type, - :recording_configuration_arn, - :ingest_endpoint, - :playback_url, :authorized, - :tags, + :ingest_endpoint, :insecure_ingest, + :latency_mode, + :name, + :playback_restriction_policy_arn, + :playback_url, :preset, + :recording_configuration_arn, :srt, - :playback_restriction_policy_arn) + :tags, + :type) SENSITIVE = [] include Aws::Structure end @@ -339,9 +339,14 @@ class ChannelNotBroadcasting < Struct.new( # Channel ARN. # @return [String] # - # @!attribute [rw] name - # Channel name. - # @return [String] + # @!attribute [rw] authorized + # Whether the channel is private (enabled for playback authorization). + # Default: `false`. + # @return [Boolean] + # + # @!attribute [rw] insecure_ingest + # Whether the channel allows insecure RTMP ingest. Default: `false`. + # @return [Boolean] # # @!attribute [rw] latency_mode # Channel latency mode. Use `NORMAL` to broadcast and deliver live @@ -349,10 +354,23 @@ class ChannelNotBroadcasting < Struct.new( # viewers. Default: `LOW`. # @return [String] # - # @!attribute [rw] authorized - # Whether the channel is private (enabled for playback authorization). - # Default: `false`. - # @return [Boolean] + # @!attribute [rw] name + # Channel name. + # @return [String] + # + # @!attribute [rw] playback_restriction_policy_arn + # 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). + # @return [String] + # + # @!attribute [rw] preset + # 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 (`""`). + # @return [String] # # @!attribute [rw] recording_configuration_arn # Recording-configuration ARN. A valid ARN value here both specifies @@ -373,10 +391,6 @@ class ChannelNotBroadcasting < Struct.new( # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html # @return [Hash] # - # @!attribute [rw] insecure_ingest - # Whether the channel allows insecure RTMP ingest. Default: `false`. - # @return [Boolean] - # # @!attribute [rw] type # Channel type, which determines the allowable resolution and bitrate. # *If you exceed the allowable input resolution or bitrate, the stream @@ -388,33 +402,19 @@ class ChannelNotBroadcasting < Struct.new( # [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html # @return [String] # - # @!attribute [rw] preset - # 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 (`""`). - # @return [String] - # - # @!attribute [rw] playback_restriction_policy_arn - # 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). - # @return [String] - # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ChannelSummary AWS API Documentation # class ChannelSummary < Struct.new( :arn, - :name, - :latency_mode, :authorized, - :recording_configuration_arn, - :tags, :insecure_ingest, - :type, + :latency_mode, + :name, + :playback_restriction_policy_arn, :preset, - :playback_restriction_policy_arn) + :recording_configuration_arn, + :tags, + :type) SENSITIVE = [] include Aws::Structure end @@ -431,9 +431,15 @@ class ConflictException < Struct.new( include Aws::Structure end - # @!attribute [rw] name - # Channel name. - # @return [String] + # @!attribute [rw] authorized + # Whether the channel is private (enabled for playback authorization). + # Default: `false`. + # @return [Boolean] + # + # @!attribute [rw] insecure_ingest + # Whether the channel allows insecure RTMP and SRT ingest. Default: + # `false`. + # @return [Boolean] # # @!attribute [rw] latency_mode # Channel latency mode. Use `NORMAL` to broadcast and deliver live @@ -441,21 +447,23 @@ class ConflictException < Struct.new( # viewers. Default: `LOW`. # @return [String] # - # @!attribute [rw] type - # 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][1]. - # - # + # @!attribute [rw] name + # Channel name. + # @return [String] # - # [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html + # @!attribute [rw] playback_restriction_policy_arn + # 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). # @return [String] # - # @!attribute [rw] authorized - # Whether the channel is private (enabled for playback authorization). - # Default: `false`. - # @return [Boolean] + # @!attribute [rw] preset + # 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 (`""`). + # @return [String] # # @!attribute [rw] recording_configuration_arn # Recording-configuration ARN. A valid ARN value here both specifies @@ -476,37 +484,29 @@ class ConflictException < Struct.new( # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html # @return [Hash] # - # @!attribute [rw] insecure_ingest - # Whether the channel allows insecure RTMP and SRT ingest. Default: - # `false`. - # @return [Boolean] + # @!attribute [rw] type + # 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][1]. # - # @!attribute [rw] preset - # 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 (`""`). - # @return [String] # - # @!attribute [rw] playback_restriction_policy_arn - # 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). + # + # [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateChannelRequest AWS API Documentation # class CreateChannelRequest < Struct.new( - :name, - :latency_mode, - :type, :authorized, - :recording_configuration_arn, - :tags, :insecure_ingest, + :latency_mode, + :name, + :playback_restriction_policy_arn, :preset, - :playback_restriction_policy_arn) + :recording_configuration_arn, + :tags, + :type) SENSITIVE = [] include Aws::Structure end @@ -593,15 +593,26 @@ class CreatePlaybackRestrictionPolicyResponse < Struct.new( include Aws::Structure end - # @!attribute [rw] name - # Recording-configuration name. The value does not need to be unique. - # @return [String] - # # @!attribute [rw] destination_configuration # A complex type that contains a destination configuration for where # recorded video will be stored. # @return [Types::DestinationConfiguration] # + # @!attribute [rw] name + # Recording-configuration name. The value does not need to be unique. + # @return [String] + # + # @!attribute [rw] recording_reconnect_window_seconds + # 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. + # @return [Integer] + # + # @!attribute [rw] rendition_configuration + # Object that describes which renditions should be recorded for a + # stream. + # @return [Types::RenditionConfiguration] + # # @!attribute [rw] tags # Array of 1-50 maps, each of the form `string:string (key:value)`. # See [Best practices and strategies][1] in *Tagging Amazon Web @@ -621,26 +632,15 @@ class CreatePlaybackRestrictionPolicyResponse < Struct.new( # thumbnails are generated for the live session. # @return [Types::ThumbnailConfiguration] # - # @!attribute [rw] recording_reconnect_window_seconds - # 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. - # @return [Integer] - # - # @!attribute [rw] rendition_configuration - # Object that describes which renditions should be recorded for a - # stream. - # @return [Types::RenditionConfiguration] - # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateRecordingConfigurationRequest AWS API Documentation # class CreateRecordingConfigurationRequest < Struct.new( - :name, :destination_configuration, - :tags, - :thumbnail_configuration, + :name, :recording_reconnect_window_seconds, - :rendition_configuration) + :rendition_configuration, + :tags, + :thumbnail_configuration) SENSITIVE = [] include Aws::Structure end @@ -957,14 +957,14 @@ class GetStreamSessionResponse < Struct.new( include Aws::Structure end - # @!attribute [rw] public_key_material - # The public portion of a customer-generated key pair. - # @return [String] - # # @!attribute [rw] name # Playback-key-pair name. The value does not need to be unique. # @return [String] # + # @!attribute [rw] public_key_material + # The public portion of a customer-generated key pair. + # @return [String] + # # @!attribute [rw] tags # Any tags provided with the request are added to the playback key # pair tags. See [Best practices and strategies][1] in *Tagging Amazon @@ -981,8 +981,8 @@ class GetStreamSessionResponse < Struct.new( # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ImportPlaybackKeyPairRequest AWS API Documentation # class ImportPlaybackKeyPairRequest < Struct.new( - :public_key_material, :name, + :public_key_material, :tags) SENSITIVE = [] include Aws::Structure @@ -1002,19 +1002,19 @@ class ImportPlaybackKeyPairResponse < Struct.new( # Object specifying the ingest configuration set up by the broadcaster, # usually in an encoder. # - # @!attribute [rw] video - # Encoder settings for video. - # @return [Types::VideoConfiguration] - # # @!attribute [rw] audio # Encoder settings for audio. # @return [Types::AudioConfiguration] # + # @!attribute [rw] video + # Encoder settings for video. + # @return [Types::VideoConfiguration] + # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/IngestConfiguration AWS API Documentation # class IngestConfiguration < Struct.new( - :video, - :audio) + :audio, + :video) SENSITIVE = [] include Aws::Structure end @@ -1035,32 +1035,32 @@ class InternalServerException < Struct.new( # Filters the channel list to match the specified name. # @return [String] # + # @!attribute [rw] filter_by_playback_restriction_policy_arn + # Filters the channel list to match the specified policy. + # @return [String] + # # @!attribute [rw] filter_by_recording_configuration_arn # Filters the channel list to match the specified # recording-configuration ARN. # @return [String] # - # @!attribute [rw] filter_by_playback_restriction_policy_arn - # Filters the channel list to match the specified policy. - # @return [String] + # @!attribute [rw] max_results + # Maximum number of channels to return. Default: 100. + # @return [Integer] # # @!attribute [rw] next_token # The first channel to retrieve. This is used for pagination; see the # `nextToken` response field. # @return [String] # - # @!attribute [rw] max_results - # Maximum number of channels to return. Default: 100. - # @return [Integer] - # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListChannelsRequest AWS API Documentation # class ListChannelsRequest < Struct.new( :filter_by_name, - :filter_by_recording_configuration_arn, :filter_by_playback_restriction_policy_arn, - :next_token, - :max_results) + :filter_by_recording_configuration_arn, + :max_results, + :next_token) SENSITIVE = [] include Aws::Structure end @@ -1083,21 +1083,21 @@ class ListChannelsResponse < Struct.new( include Aws::Structure end - # @!attribute [rw] next_token - # The first key pair to retrieve. This is used for pagination; see the - # `nextToken` response field. - # @return [String] - # # @!attribute [rw] max_results # Maximum number of key pairs to return. Default: your service quota # or 100, whichever is smaller. # @return [Integer] # + # @!attribute [rw] next_token + # The first key pair to retrieve. This is used for pagination; see the + # `nextToken` response field. + # @return [String] + # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListPlaybackKeyPairsRequest AWS API Documentation # class ListPlaybackKeyPairsRequest < Struct.new( - :next_token, - :max_results) + :max_results, + :next_token) SENSITIVE = [] include Aws::Structure end @@ -1120,75 +1120,75 @@ class ListPlaybackKeyPairsResponse < Struct.new( include Aws::Structure end + # @!attribute [rw] max_results + # Maximum number of policies to return. Default: 1. + # @return [Integer] + # # @!attribute [rw] next_token # The first policy to retrieve. This is used for pagination; see the # `nextToken` response field. # @return [String] # - # @!attribute [rw] max_results - # Maximum number of policies to return. Default: 1. - # @return [Integer] - # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListPlaybackRestrictionPoliciesRequest AWS API Documentation # class ListPlaybackRestrictionPoliciesRequest < Struct.new( - :next_token, - :max_results) + :max_results, + :next_token) SENSITIVE = [] include Aws::Structure end - # @!attribute [rw] playback_restriction_policies - # List of the matching policies. - # @return [Array] - # # @!attribute [rw] next_token # If there are more channels than `maxResults`, use `nextToken` in the # request to get the next set. # @return [String] # + # @!attribute [rw] playback_restriction_policies + # List of the matching policies. + # @return [Array] + # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListPlaybackRestrictionPoliciesResponse AWS API Documentation # class ListPlaybackRestrictionPoliciesResponse < Struct.new( - :playback_restriction_policies, - :next_token) + :next_token, + :playback_restriction_policies) SENSITIVE = [] include Aws::Structure end - # @!attribute [rw] next_token - # The first recording configuration to retrieve. This is used for - # pagination; see the `nextToken` response field. - # @return [String] - # # @!attribute [rw] max_results # Maximum number of recording configurations to return. Default: your # service quota or 100, whichever is smaller. # @return [Integer] # + # @!attribute [rw] next_token + # The first recording configuration to retrieve. This is used for + # pagination; see the `nextToken` response field. + # @return [String] + # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListRecordingConfigurationsRequest AWS API Documentation # class ListRecordingConfigurationsRequest < Struct.new( - :next_token, - :max_results) + :max_results, + :next_token) SENSITIVE = [] include Aws::Structure end - # @!attribute [rw] recording_configurations - # List of the matching recording configurations. - # @return [Array] - # # @!attribute [rw] next_token # If there are more recording configurations than `maxResults`, use # `nextToken` in the request to get the next set. # @return [String] # + # @!attribute [rw] recording_configurations + # List of the matching recording configurations. + # @return [Array] + # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListRecordingConfigurationsResponse AWS API Documentation # class ListRecordingConfigurationsResponse < Struct.new( - :recording_configurations, - :next_token) + :next_token, + :recording_configurations) SENSITIVE = [] include Aws::Structure end @@ -1197,39 +1197,39 @@ class ListRecordingConfigurationsResponse < Struct.new( # Channel ARN used to filter the list. # @return [String] # + # @!attribute [rw] max_results + # Maximum number of streamKeys to return. Default: 1. + # @return [Integer] + # # @!attribute [rw] next_token # The first stream key to retrieve. This is used for pagination; see # the `nextToken` response field. # @return [String] # - # @!attribute [rw] max_results - # Maximum number of streamKeys to return. Default: 1. - # @return [Integer] - # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeysRequest AWS API Documentation # class ListStreamKeysRequest < Struct.new( :channel_arn, - :next_token, - :max_results) + :max_results, + :next_token) SENSITIVE = [] include Aws::Structure end - # @!attribute [rw] stream_keys - # List of stream keys. - # @return [Array] - # # @!attribute [rw] next_token # If there are more stream keys than `maxResults`, use `nextToken` in # the request to get the next set. # @return [String] # + # @!attribute [rw] stream_keys + # List of stream keys. + # @return [Array] + # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeysResponse AWS API Documentation # class ListStreamKeysResponse < Struct.new( - :stream_keys, - :next_token) + :next_token, + :stream_keys) SENSITIVE = [] include Aws::Structure end @@ -1238,39 +1238,39 @@ class ListStreamKeysResponse < Struct.new( # Channel ARN used to filter the list. # @return [String] # + # @!attribute [rw] max_results + # Maximum number of streams to return. Default: 100. + # @return [Integer] + # # @!attribute [rw] next_token # The first stream to retrieve. This is used for pagination; see the # `nextToken` response field. # @return [String] # - # @!attribute [rw] max_results - # Maximum number of streams to return. Default: 100. - # @return [Integer] - # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamSessionsRequest AWS API Documentation # class ListStreamSessionsRequest < Struct.new( :channel_arn, - :next_token, - :max_results) + :max_results, + :next_token) SENSITIVE = [] include Aws::Structure end - # @!attribute [rw] stream_sessions - # List of stream sessions. - # @return [Array] - # # @!attribute [rw] next_token # If there are more streams than `maxResults`, use `nextToken` in the # request to get the next set. # @return [String] # + # @!attribute [rw] stream_sessions + # List of stream sessions. + # @return [Array] + # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamSessionsResponse AWS API Documentation # class ListStreamSessionsResponse < Struct.new( - :stream_sessions, - :next_token) + :next_token, + :stream_sessions) SENSITIVE = [] include Aws::Structure end @@ -1279,39 +1279,39 @@ class ListStreamSessionsResponse < Struct.new( # Filters the stream list to match the specified criterion. # @return [Types::StreamFilters] # + # @!attribute [rw] max_results + # Maximum number of streams to return. Default: 100. + # @return [Integer] + # # @!attribute [rw] next_token # The first stream to retrieve. This is used for pagination; see the # `nextToken` response field. # @return [String] # - # @!attribute [rw] max_results - # Maximum number of streams to return. Default: 100. - # @return [Integer] - # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamsRequest AWS API Documentation # class ListStreamsRequest < Struct.new( :filter_by, - :next_token, - :max_results) + :max_results, + :next_token) SENSITIVE = [] include Aws::Structure end - # @!attribute [rw] streams - # List of streams. - # @return [Array] - # # @!attribute [rw] next_token # If there are more streams than `maxResults`, use `nextToken` in the # request to get the next set. # @return [String] # + # @!attribute [rw] streams + # List of streams. + # @return [Array] + # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamsResponse AWS API Documentation # class ListStreamsResponse < Struct.new( - :streams, - :next_token) + :next_token, + :streams) SENSITIVE = [] include Aws::Structure end @@ -1360,14 +1360,14 @@ class PendingVerification < Struct.new( # Key-pair ARN. # @return [String] # - # @!attribute [rw] name - # Playback-key-pair name. The value does not need to be unique. - # @return [String] - # # @!attribute [rw] fingerprint # Key-pair identifier. # @return [String] # + # @!attribute [rw] name + # Playback-key-pair name. The value does not need to be unique. + # @return [String] + # # @!attribute [rw] tags # Tags attached to the resource. Array of 1-50 maps, each of the form # `string:string (key:value)`. See [Best practices and strategies][1] @@ -1385,8 +1385,8 @@ class PendingVerification < Struct.new( # class PlaybackKeyPair < Struct.new( :arn, - :name, :fingerprint, + :name, :tags) SENSITIVE = [] include Aws::Structure @@ -1428,10 +1428,6 @@ class PlaybackKeyPairSummary < Struct.new( # An object representing a policy to constrain playback by country # and/or origin sites. # - # @!attribute [rw] arn - # Playback-restriction-policy ARN - # @return [String] - # # @!attribute [rw] allowed_countries # A list of country codes that control geoblocking restriction. # Allowed values are the officially assigned [ISO 3166-1 alpha-2][1] @@ -1453,6 +1449,10 @@ class PlaybackKeyPairSummary < Struct.new( # [1]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin # @return [Array] # + # @!attribute [rw] arn + # Playback-restriction-policy ARN + # @return [String] + # # @!attribute [rw] enable_strict_origin_enforcement # Whether channel playback is constrained by origin site. Default: # `false`. @@ -1479,9 +1479,9 @@ class PlaybackKeyPairSummary < Struct.new( # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/PlaybackRestrictionPolicy AWS API Documentation # class PlaybackRestrictionPolicy < Struct.new( - :arn, :allowed_countries, :allowed_origins, + :arn, :enable_strict_origin_enforcement, :name, :tags) @@ -1491,10 +1491,6 @@ class PlaybackRestrictionPolicy < Struct.new( # Summary information about a PlaybackRestrictionPolicy. # - # @!attribute [rw] arn - # Playback-restriction-policy ARN - # @return [String] - # # @!attribute [rw] allowed_countries # A list of country codes that control geoblocking restriction. # Allowed values are the officially assigned [ISO 3166-1 alpha-2][1] @@ -1516,6 +1512,10 @@ class PlaybackRestrictionPolicy < Struct.new( # [1]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin # @return [Array] # + # @!attribute [rw] arn + # Playback-restriction-policy ARN + # @return [String] + # # @!attribute [rw] enable_strict_origin_enforcement # Whether channel playback is constrained by origin site. Default: # `false`. @@ -1542,9 +1542,9 @@ class PlaybackRestrictionPolicy < Struct.new( # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/PlaybackRestrictionPolicySummary AWS API Documentation # class PlaybackRestrictionPolicySummary < Struct.new( - :arn, :allowed_countries, :allowed_origins, + :arn, :enable_strict_origin_enforcement, :name, :tags) @@ -1576,15 +1576,26 @@ class PutMetadataRequest < Struct.new( # Recording-configuration ARN. # @return [String] # - # @!attribute [rw] name - # Recording-configuration name. The value does not need to be unique. - # @return [String] - # # @!attribute [rw] destination_configuration # A complex type that contains information about where recorded video # will be stored. # @return [Types::DestinationConfiguration] # + # @!attribute [rw] name + # Recording-configuration name. The value does not need to be unique. + # @return [String] + # + # @!attribute [rw] recording_reconnect_window_seconds + # 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. + # @return [Integer] + # + # @!attribute [rw] rendition_configuration + # Object that describes which renditions should be recorded for a + # stream. + # @return [Types::RenditionConfiguration] + # # @!attribute [rw] state # Indicates the current state of the recording configuration. When the # state is `ACTIVE`, the configuration is ready for recording a @@ -1610,40 +1621,25 @@ class PutMetadataRequest < Struct.new( # thumbnails are generated for the live session. # @return [Types::ThumbnailConfiguration] # - # @!attribute [rw] recording_reconnect_window_seconds - # 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. - # @return [Integer] - # - # @!attribute [rw] rendition_configuration - # Object that describes which renditions should be recorded for a - # stream. - # @return [Types::RenditionConfiguration] - # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/RecordingConfiguration AWS API Documentation # class RecordingConfiguration < Struct.new( :arn, - :name, :destination_configuration, + :name, + :recording_reconnect_window_seconds, + :rendition_configuration, :state, :tags, - :thumbnail_configuration, - :recording_reconnect_window_seconds, - :rendition_configuration) + :thumbnail_configuration) SENSITIVE = [] include Aws::Structure end # Summary information about a RecordingConfiguration. - # - # @!attribute [rw] arn - # Recording-configuration ARN. - # @return [String] - # - # @!attribute [rw] name - # Recording-configuration name. The value does not need to be unique. + # + # @!attribute [rw] arn + # Recording-configuration ARN. # @return [String] # # @!attribute [rw] destination_configuration @@ -1651,6 +1647,10 @@ class RecordingConfiguration < Struct.new( # will be stored. # @return [Types::DestinationConfiguration] # + # @!attribute [rw] name + # Recording-configuration name. The value does not need to be unique. + # @return [String] + # # @!attribute [rw] state # Indicates the current state of the recording configuration. When the # state is `ACTIVE`, the configuration is ready for recording a @@ -1674,8 +1674,8 @@ class RecordingConfiguration < Struct.new( # class RecordingConfigurationSummary < Struct.new( :arn, - :name, :destination_configuration, + :name, :state, :tags) SENSITIVE = [] @@ -1828,9 +1828,8 @@ class StopStreamResponse < Aws::EmptyStructure; end # Channel ARN for the stream. # @return [String] # - # @!attribute [rw] stream_id - # Unique identifier for a live or previously live stream in the - # specified channel. + # @!attribute [rw] health + # The stream’s health. # @return [String] # # @!attribute [rw] playback_url @@ -1849,8 +1848,9 @@ class StopStreamResponse < Aws::EmptyStructure; end # indicate that the stream is not live. # @return [String] # - # @!attribute [rw] health - # The stream’s health. + # @!attribute [rw] stream_id + # Unique identifier for a live or previously live stream in the + # specified channel. # @return [String] # # @!attribute [rw] viewer_count @@ -1865,11 +1865,11 @@ class StopStreamResponse < Aws::EmptyStructure; end # class Stream < Struct.new( :channel_arn, - :stream_id, + :health, :playback_url, :start_time, :state, - :health, + :stream_id, :viewer_count) SENSITIVE = [] include Aws::Structure @@ -1882,12 +1882,22 @@ class Stream < Struct.new( # # [1]: https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html # - # @!attribute [rw] name - # Name that identifies the stream event within a `type`. - # @return [String] + # @!attribute [rw] code + # 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: # - # @!attribute [rw] type - # Logical group for certain events. + # * `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. # @return [String] # # @!attribute [rw] event_time @@ -1895,12 +1905,21 @@ class Stream < Struct.new( # that this is returned as a string*. # @return [Time] # + # @!attribute [rw] name + # Name that identifies the stream event within a `type`. + # @return [String] + # + # @!attribute [rw] type + # Logical group for certain events. + # @return [String] + # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamEvent AWS API Documentation # class StreamEvent < Struct.new( + :code, + :event_time, :name, - :type, - :event_time) + :type) SENSITIVE = [] include Aws::Structure end @@ -1925,10 +1944,6 @@ class StreamFilters < Struct.new( # Stream-key ARN. # @return [String] # - # @!attribute [rw] value - # Stream-key value. - # @return [String] - # # @!attribute [rw] channel_arn # Channel ARN for the stream. # @return [String] @@ -1946,13 +1961,17 @@ class StreamFilters < Struct.new( # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html # @return [Hash] # + # @!attribute [rw] value + # Stream-key value. + # @return [String] + # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamKey AWS API Documentation # class StreamKey < Struct.new( :arn, - :value, :channel_arn, - :tags) + :tags, + :value) SENSITIVE = [:value] include Aws::Structure end @@ -1994,15 +2013,9 @@ class StreamKeySummary < Struct.new( # provisioned, the ingest configurations that the broadcaster used, and # the most recent Amazon IVS stream events it encountered. # - # @!attribute [rw] stream_id - # Unique identifier for a live or previously live stream in the - # specified channel. - # @return [String] - # - # @!attribute [rw] start_time - # Time when the channel went live. This is an ISO 8601 timestamp; - # *note that this is returned as a string*. - # @return [Time] + # @!attribute [rw] channel + # The properties of the channel at the time of going live. + # @return [Types::Channel] # # @!attribute [rw] end_time # Time when the channel went offline. This is an ISO 8601 timestamp; @@ -2010,10 +2023,6 @@ class StreamKeySummary < Struct.new( # `NULL`. # @return [Time] # - # @!attribute [rw] channel - # The properties of the channel at the time of going live. - # @return [Types::Channel] - # # @!attribute [rw] ingest_configuration # The properties of the incoming RTMP stream for the stream. # @return [Types::IngestConfiguration] @@ -2022,6 +2031,16 @@ class StreamKeySummary < Struct.new( # The properties of recording the live stream. # @return [Types::RecordingConfiguration] # + # @!attribute [rw] start_time + # Time when the channel went live. This is an ISO 8601 timestamp; + # *note that this is returned as a string*. + # @return [Time] + # + # @!attribute [rw] stream_id + # Unique identifier for a live or previously live stream in the + # specified channel. + # @return [String] + # # @!attribute [rw] truncated_events # List of Amazon IVS events that the stream encountered. The list is # sorted by most recent events and contains up to 500 events. For @@ -2036,12 +2055,12 @@ class StreamKeySummary < Struct.new( # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamSession AWS API Documentation # class StreamSession < Struct.new( - :stream_id, - :start_time, - :end_time, :channel, + :end_time, :ingest_configuration, :recording_configuration, + :start_time, + :stream_id, :truncated_events) SENSITIVE = [] include Aws::Structure @@ -2049,16 +2068,6 @@ class StreamSession < Struct.new( # Summary information about a stream session. # - # @!attribute [rw] stream_id - # Unique identifier for a live or previously live stream in the - # specified channel. - # @return [String] - # - # @!attribute [rw] start_time - # Time when the channel went live. This is an ISO 8601 timestamp; - # *note that this is returned as a string*. - # @return [Time] - # # @!attribute [rw] end_time # 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 @@ -2069,13 +2078,23 @@ class StreamSession < Struct.new( # If `true`, this stream encountered a quota breach or failure. # @return [Boolean] # + # @!attribute [rw] start_time + # Time when the channel went live. This is an ISO 8601 timestamp; + # *note that this is returned as a string*. + # @return [Time] + # + # @!attribute [rw] stream_id + # Unique identifier for a live or previously live stream in the + # specified channel. + # @return [String] + # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamSessionSummary AWS API Documentation # class StreamSessionSummary < Struct.new( - :stream_id, - :start_time, :end_time, - :has_error_event) + :has_error_event, + :start_time, + :stream_id) SENSITIVE = [] include Aws::Structure end @@ -2086,19 +2105,24 @@ class StreamSessionSummary < Struct.new( # Channel ARN for the stream. # @return [String] # - # @!attribute [rw] stream_id - # Unique identifier for a live or previously live stream in the - # specified channel. + # @!attribute [rw] health + # The stream’s health. # @return [String] # + # @!attribute [rw] start_time + # Time of the stream’s start. This is an ISO 8601 timestamp; *note + # that this is returned as a string*. + # @return [Time] + # # @!attribute [rw] state # 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. # @return [String] # - # @!attribute [rw] health - # The stream’s health. + # @!attribute [rw] stream_id + # Unique identifier for a live or previously live stream in the + # specified channel. # @return [String] # # @!attribute [rw] viewer_count @@ -2109,20 +2133,15 @@ class StreamSessionSummary < Struct.new( # timed out; in this case, retry. # @return [Integer] # - # @!attribute [rw] start_time - # Time of the stream’s start. This is an ISO 8601 timestamp; *note - # that this is returned as a string*. - # @return [Time] - # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamSummary AWS API Documentation # class StreamSummary < Struct.new( :channel_arn, - :stream_id, - :state, :health, - :viewer_count, - :start_time) + :start_time, + :state, + :stream_id, + :viewer_count) SENSITIVE = [] include Aws::Structure end @@ -2189,25 +2208,6 @@ class ThrottlingException < Struct.new( # Thumbnail recording mode. Default: `INTERVAL`. # @return [String] # - # @!attribute [rw] target_interval_seconds - # 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][1] for information - # on setting `IDR/Keyframe` to the recommended value in video-encoder - # settings. - # - # - # - # [1]: https://docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html - # @return [Integer] - # # @!attribute [rw] resolution # Indicates the desired resolution of recorded thumbnails. Thumbnails # are recorded at the selected resolution if the corresponding @@ -2231,13 +2231,32 @@ class ThrottlingException < Struct.new( # `SEQUENTIAL` and `LATEST`. Default: `SEQUENTIAL`. # @return [Array] # + # @!attribute [rw] target_interval_seconds + # 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][1] for information + # on setting `IDR/Keyframe` to the recommended value in video-encoder + # settings. + # + # + # + # [1]: https://docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html + # @return [Integer] + # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ThumbnailConfiguration AWS API Documentation # class ThumbnailConfiguration < Struct.new( :recording_mode, - :target_interval_seconds, :resolution, - :storage) + :storage, + :target_interval_seconds) SENSITIVE = [] include Aws::Structure end @@ -2277,9 +2296,14 @@ class UntagResourceResponse < Aws::EmptyStructure; end # ARN of the channel to be updated. # @return [String] # - # @!attribute [rw] name - # Channel name. - # @return [String] + # @!attribute [rw] authorized + # Whether the channel is private (enabled for playback authorization). + # @return [Boolean] + # + # @!attribute [rw] insecure_ingest + # Whether the channel allows insecure RTMP and SRT ingest. Default: + # `false`. + # @return [Boolean] # # @!attribute [rw] latency_mode # Channel latency mode. Use `NORMAL` to broadcast and deliver live @@ -2287,32 +2311,16 @@ class UntagResourceResponse < Aws::EmptyStructure; end # viewers. # @return [String] # - # @!attribute [rw] type - # 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][1]. - # - # - # - # [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html + # @!attribute [rw] name + # Channel name. # @return [String] # - # @!attribute [rw] authorized - # Whether the channel is private (enabled for playback authorization). - # @return [Boolean] - # - # @!attribute [rw] recording_configuration_arn - # 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. + # @!attribute [rw] playback_restriction_policy_arn + # 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. # @return [String] # - # @!attribute [rw] insecure_ingest - # Whether the channel allows insecure RTMP and SRT ingest. Default: - # `false`. - # @return [Boolean] - # # @!attribute [rw] preset # Optional transcode preset for the channel. This is selectable only # for `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel @@ -2321,24 +2329,35 @@ class UntagResourceResponse < Aws::EmptyStructure; end # string (`""`). # @return [String] # - # @!attribute [rw] playback_restriction_policy_arn - # 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. + # @!attribute [rw] recording_configuration_arn + # 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. + # @return [String] + # + # @!attribute [rw] type + # 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][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateChannelRequest AWS API Documentation # class UpdateChannelRequest < Struct.new( :arn, - :name, - :latency_mode, - :type, :authorized, - :recording_configuration_arn, :insecure_ingest, + :latency_mode, + :name, + :playback_restriction_policy_arn, :preset, - :playback_restriction_policy_arn) + :recording_configuration_arn, + :type) SENSITIVE = [] include Aws::Structure end @@ -2355,10 +2374,6 @@ class UpdateChannelResponse < Struct.new( include Aws::Structure end - # @!attribute [rw] arn - # ARN of the playback-restriction-policy to be updated. - # @return [String] - # # @!attribute [rw] allowed_countries # A list of country codes that control geoblocking restriction. # Allowed values are the officially assigned [ISO 3166-1 alpha-2][1] @@ -2380,6 +2395,10 @@ class UpdateChannelResponse < Struct.new( # [1]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin # @return [Array] # + # @!attribute [rw] arn + # ARN of the playback-restriction-policy to be updated. + # @return [String] + # # @!attribute [rw] enable_strict_origin_enforcement # Whether channel playback is constrained by origin site. Default: # `false`. @@ -2393,9 +2412,9 @@ class UpdateChannelResponse < Struct.new( # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdatePlaybackRestrictionPolicyRequest AWS API Documentation # class UpdatePlaybackRestrictionPolicyRequest < Struct.new( - :arn, :allowed_countries, :allowed_origins, + :arn, :enable_strict_origin_enforcement, :name) SENSITIVE = [] @@ -2431,17 +2450,17 @@ class ValidationException < Struct.new( # broadcaster (usually in an encoder). This is part of the # IngestConfiguration object and used for monitoring stream health. # - # @!attribute [rw] avc_profile - # Indicates to the decoder the requirements for decoding the stream. - # For definitions of the valid values, see the H.264 specification. - # @return [String] - # # @!attribute [rw] avc_level # 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. # @return [String] # + # @!attribute [rw] avc_profile + # Indicates to the decoder the requirements for decoding the stream. + # For definitions of the valid values, see the H.264 specification. + # @return [String] + # # @!attribute [rw] codec # Codec used for the video encoding. # @return [String] @@ -2470,8 +2489,8 @@ class ValidationException < Struct.new( # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/VideoConfiguration AWS API Documentation # class VideoConfiguration < Struct.new( - :avc_profile, :avc_level, + :avc_profile, :codec, :encoder, :target_bitrate, diff --git a/gems/aws-sdk-ivs/sig/client.rbs b/gems/aws-sdk-ivs/sig/client.rbs index d05cb576172..29bca735c03 100644 --- a/gems/aws-sdk-ivs/sig/client.rbs +++ b/gems/aws-sdk-ivs/sig/client.rbs @@ -88,8 +88,8 @@ module Aws interface _BatchGetStreamKeyResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::BatchGetStreamKeyResponse] - def stream_keys: () -> ::Array[Types::StreamKey] def errors: () -> ::Array[Types::BatchError] + def stream_keys: () -> ::Array[Types::StreamKey] end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IVS/Client.html#batch_get_stream_key-instance_method def batch_get_stream_key: ( @@ -120,15 +120,15 @@ module Aws end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IVS/Client.html#create_channel-instance_method def create_channel: ( - ?name: ::String, - ?latency_mode: ("NORMAL" | "LOW"), - ?type: ("BASIC" | "STANDARD" | "ADVANCED_SD" | "ADVANCED_HD"), ?authorized: bool, - ?recording_configuration_arn: ::String, - ?tags: Hash[::String, ::String], ?insecure_ingest: bool, + ?latency_mode: ("NORMAL" | "LOW"), + ?name: ::String, + ?playback_restriction_policy_arn: ::String, ?preset: ("HIGHER_BANDWIDTH_DELIVERY" | "CONSTRAINED_BANDWIDTH_DELIVERY"), - ?playback_restriction_policy_arn: ::String + ?recording_configuration_arn: ::String, + ?tags: Hash[::String, ::String], + ?type: ("BASIC" | "STANDARD" | "ADVANCED_SD" | "ADVANCED_HD") ) -> _CreateChannelResponseSuccess | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateChannelResponseSuccess @@ -152,23 +152,23 @@ module Aws end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IVS/Client.html#create_recording_configuration-instance_method def create_recording_configuration: ( - ?name: ::String, destination_configuration: { s3: { bucket_name: ::String }? }, - ?tags: Hash[::String, ::String], - ?thumbnail_configuration: { - recording_mode: ("DISABLED" | "INTERVAL")?, - target_interval_seconds: ::Integer?, - resolution: ("SD" | "HD" | "FULL_HD" | "LOWEST_RESOLUTION")?, - storage: Array[("SEQUENTIAL" | "LATEST")]? - }, + ?name: ::String, ?recording_reconnect_window_seconds: ::Integer, ?rendition_configuration: { rendition_selection: ("ALL" | "NONE" | "CUSTOM")?, renditions: Array[("SD" | "HD" | "FULL_HD" | "LOWEST_RESOLUTION")]? + }, + ?tags: Hash[::String, ::String], + ?thumbnail_configuration: { + recording_mode: ("DISABLED" | "INTERVAL")?, + resolution: ("SD" | "HD" | "FULL_HD" | "LOWEST_RESOLUTION")?, + storage: Array[("SEQUENTIAL" | "LATEST")]?, + target_interval_seconds: ::Integer? } ) -> _CreateRecordingConfigurationResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateRecordingConfigurationResponseSuccess @@ -294,8 +294,8 @@ module Aws end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IVS/Client.html#import_playback_key_pair-instance_method def import_playback_key_pair: ( - public_key_material: ::String, ?name: ::String, + public_key_material: ::String, ?tags: Hash[::String, ::String] ) -> _ImportPlaybackKeyPairResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ImportPlaybackKeyPairResponseSuccess @@ -308,10 +308,10 @@ module Aws # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IVS/Client.html#list_channels-instance_method def list_channels: ( ?filter_by_name: ::String, - ?filter_by_recording_configuration_arn: ::String, ?filter_by_playback_restriction_policy_arn: ::String, - ?next_token: ::String, - ?max_results: ::Integer + ?filter_by_recording_configuration_arn: ::String, + ?max_results: ::Integer, + ?next_token: ::String ) -> _ListChannelsResponseSuccess | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListChannelsResponseSuccess @@ -322,73 +322,73 @@ module Aws end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IVS/Client.html#list_playback_key_pairs-instance_method def list_playback_key_pairs: ( - ?next_token: ::String, - ?max_results: ::Integer + ?max_results: ::Integer, + ?next_token: ::String ) -> _ListPlaybackKeyPairsResponseSuccess | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListPlaybackKeyPairsResponseSuccess interface _ListPlaybackRestrictionPoliciesResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::ListPlaybackRestrictionPoliciesResponse] - def playback_restriction_policies: () -> ::Array[Types::PlaybackRestrictionPolicySummary] def next_token: () -> ::String + def playback_restriction_policies: () -> ::Array[Types::PlaybackRestrictionPolicySummary] end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IVS/Client.html#list_playback_restriction_policies-instance_method def list_playback_restriction_policies: ( - ?next_token: ::String, - ?max_results: ::Integer + ?max_results: ::Integer, + ?next_token: ::String ) -> _ListPlaybackRestrictionPoliciesResponseSuccess | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListPlaybackRestrictionPoliciesResponseSuccess interface _ListRecordingConfigurationsResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::ListRecordingConfigurationsResponse] - def recording_configurations: () -> ::Array[Types::RecordingConfigurationSummary] def next_token: () -> ::String + def recording_configurations: () -> ::Array[Types::RecordingConfigurationSummary] end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IVS/Client.html#list_recording_configurations-instance_method def list_recording_configurations: ( - ?next_token: ::String, - ?max_results: ::Integer + ?max_results: ::Integer, + ?next_token: ::String ) -> _ListRecordingConfigurationsResponseSuccess | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListRecordingConfigurationsResponseSuccess interface _ListStreamKeysResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::ListStreamKeysResponse] - def stream_keys: () -> ::Array[Types::StreamKeySummary] def next_token: () -> ::String + def stream_keys: () -> ::Array[Types::StreamKeySummary] end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IVS/Client.html#list_stream_keys-instance_method def list_stream_keys: ( channel_arn: ::String, - ?next_token: ::String, - ?max_results: ::Integer + ?max_results: ::Integer, + ?next_token: ::String ) -> _ListStreamKeysResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListStreamKeysResponseSuccess interface _ListStreamSessionsResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::ListStreamSessionsResponse] - def stream_sessions: () -> ::Array[Types::StreamSessionSummary] def next_token: () -> ::String + def stream_sessions: () -> ::Array[Types::StreamSessionSummary] end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IVS/Client.html#list_stream_sessions-instance_method def list_stream_sessions: ( channel_arn: ::String, - ?next_token: ::String, - ?max_results: ::Integer + ?max_results: ::Integer, + ?next_token: ::String ) -> _ListStreamSessionsResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListStreamSessionsResponseSuccess interface _ListStreamsResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::ListStreamsResponse] - def streams: () -> ::Array[Types::StreamSummary] def next_token: () -> ::String + def streams: () -> ::Array[Types::StreamSummary] end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IVS/Client.html#list_streams-instance_method def list_streams: ( ?filter_by: { health: ("HEALTHY" | "STARVING" | "UNKNOWN")? }, - ?next_token: ::String, - ?max_results: ::Integer + ?max_results: ::Integer, + ?next_token: ::String ) -> _ListStreamsResponseSuccess | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListStreamsResponseSuccess @@ -456,14 +456,14 @@ module Aws # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IVS/Client.html#update_channel-instance_method def update_channel: ( arn: ::String, - ?name: ::String, - ?latency_mode: ("NORMAL" | "LOW"), - ?type: ("BASIC" | "STANDARD" | "ADVANCED_SD" | "ADVANCED_HD"), ?authorized: bool, - ?recording_configuration_arn: ::String, ?insecure_ingest: bool, + ?latency_mode: ("NORMAL" | "LOW"), + ?name: ::String, + ?playback_restriction_policy_arn: ::String, ?preset: ("HIGHER_BANDWIDTH_DELIVERY" | "CONSTRAINED_BANDWIDTH_DELIVERY"), - ?playback_restriction_policy_arn: ::String + ?recording_configuration_arn: ::String, + ?type: ("BASIC" | "STANDARD" | "ADVANCED_SD" | "ADVANCED_HD") ) -> _UpdateChannelResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateChannelResponseSuccess @@ -473,9 +473,9 @@ module Aws end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IVS/Client.html#update_playback_restriction_policy-instance_method def update_playback_restriction_policy: ( - arn: ::String, ?allowed_countries: Array[::String], ?allowed_origins: Array[::String], + arn: ::String, ?enable_strict_origin_enforcement: bool, ?name: ::String ) -> _UpdatePlaybackRestrictionPolicyResponseSuccess diff --git a/gems/aws-sdk-ivs/sig/types.rbs b/gems/aws-sdk-ivs/sig/types.rbs index b6203e2074b..6bd40aedf13 100644 --- a/gems/aws-sdk-ivs/sig/types.rbs +++ b/gems/aws-sdk-ivs/sig/types.rbs @@ -14,10 +14,10 @@ module Aws::IVS end class AudioConfiguration + attr_accessor channels: ::Integer attr_accessor codec: ::String - attr_accessor target_bitrate: ::Integer attr_accessor sample_rate: ::Integer - attr_accessor channels: ::Integer + attr_accessor target_bitrate: ::Integer SENSITIVE: [] end @@ -45,16 +45,16 @@ module Aws::IVS end class BatchGetStreamKeyResponse - attr_accessor stream_keys: ::Array[Types::StreamKey] attr_accessor errors: ::Array[Types::BatchError] + attr_accessor stream_keys: ::Array[Types::StreamKey] SENSITIVE: [] end class BatchStartViewerSessionRevocationError attr_accessor channel_arn: ::String - attr_accessor viewer_id: ::String attr_accessor code: ::String attr_accessor message: ::String + attr_accessor viewer_id: ::String SENSITIVE: [] end @@ -77,18 +77,18 @@ module Aws::IVS class Channel attr_accessor arn: ::String - attr_accessor name: ::String - attr_accessor latency_mode: ("NORMAL" | "LOW") - attr_accessor type: ("BASIC" | "STANDARD" | "ADVANCED_SD" | "ADVANCED_HD") - attr_accessor recording_configuration_arn: ::String - attr_accessor ingest_endpoint: ::String - attr_accessor playback_url: ::String attr_accessor authorized: bool - attr_accessor tags: ::Hash[::String, ::String] + attr_accessor ingest_endpoint: ::String attr_accessor insecure_ingest: bool + attr_accessor latency_mode: ("NORMAL" | "LOW") + attr_accessor name: ::String + attr_accessor playback_restriction_policy_arn: ::String + attr_accessor playback_url: ::String attr_accessor preset: ("HIGHER_BANDWIDTH_DELIVERY" | "CONSTRAINED_BANDWIDTH_DELIVERY") + attr_accessor recording_configuration_arn: ::String attr_accessor srt: Types::Srt - attr_accessor playback_restriction_policy_arn: ::String + attr_accessor tags: ::Hash[::String, ::String] + attr_accessor type: ("BASIC" | "STANDARD" | "ADVANCED_SD" | "ADVANCED_HD") SENSITIVE: [] end @@ -99,15 +99,15 @@ module Aws::IVS class ChannelSummary attr_accessor arn: ::String - attr_accessor name: ::String - attr_accessor latency_mode: ("NORMAL" | "LOW") attr_accessor authorized: bool + attr_accessor insecure_ingest: bool + attr_accessor latency_mode: ("NORMAL" | "LOW") + attr_accessor name: ::String + attr_accessor playback_restriction_policy_arn: ::String + attr_accessor preset: ("HIGHER_BANDWIDTH_DELIVERY" | "CONSTRAINED_BANDWIDTH_DELIVERY") attr_accessor recording_configuration_arn: ::String attr_accessor tags: ::Hash[::String, ::String] - attr_accessor insecure_ingest: bool attr_accessor type: ("BASIC" | "STANDARD" | "ADVANCED_SD" | "ADVANCED_HD") - attr_accessor preset: ("HIGHER_BANDWIDTH_DELIVERY" | "CONSTRAINED_BANDWIDTH_DELIVERY") - attr_accessor playback_restriction_policy_arn: ::String SENSITIVE: [] end @@ -117,15 +117,15 @@ module Aws::IVS end class CreateChannelRequest - attr_accessor name: ::String - attr_accessor latency_mode: ("NORMAL" | "LOW") - attr_accessor type: ("BASIC" | "STANDARD" | "ADVANCED_SD" | "ADVANCED_HD") attr_accessor authorized: bool - attr_accessor recording_configuration_arn: ::String - attr_accessor tags: ::Hash[::String, ::String] attr_accessor insecure_ingest: bool - attr_accessor preset: ("HIGHER_BANDWIDTH_DELIVERY" | "CONSTRAINED_BANDWIDTH_DELIVERY") + attr_accessor latency_mode: ("NORMAL" | "LOW") + attr_accessor name: ::String attr_accessor playback_restriction_policy_arn: ::String + attr_accessor preset: ("HIGHER_BANDWIDTH_DELIVERY" | "CONSTRAINED_BANDWIDTH_DELIVERY") + attr_accessor recording_configuration_arn: ::String + attr_accessor tags: ::Hash[::String, ::String] + attr_accessor type: ("BASIC" | "STANDARD" | "ADVANCED_SD" | "ADVANCED_HD") SENSITIVE: [] end @@ -150,12 +150,12 @@ module Aws::IVS end class CreateRecordingConfigurationRequest - attr_accessor name: ::String attr_accessor destination_configuration: Types::DestinationConfiguration - attr_accessor tags: ::Hash[::String, ::String] - attr_accessor thumbnail_configuration: Types::ThumbnailConfiguration + attr_accessor name: ::String attr_accessor recording_reconnect_window_seconds: ::Integer attr_accessor rendition_configuration: Types::RenditionConfiguration + attr_accessor tags: ::Hash[::String, ::String] + attr_accessor thumbnail_configuration: Types::ThumbnailConfiguration SENSITIVE: [] end @@ -280,8 +280,8 @@ module Aws::IVS end class ImportPlaybackKeyPairRequest - attr_accessor public_key_material: ::String attr_accessor name: ::String + attr_accessor public_key_material: ::String attr_accessor tags: ::Hash[::String, ::String] SENSITIVE: [] end @@ -292,8 +292,8 @@ module Aws::IVS end class IngestConfiguration - attr_accessor video: Types::VideoConfiguration attr_accessor audio: Types::AudioConfiguration + attr_accessor video: Types::VideoConfiguration SENSITIVE: [] end @@ -304,10 +304,10 @@ module Aws::IVS class ListChannelsRequest attr_accessor filter_by_name: ::String - attr_accessor filter_by_recording_configuration_arn: ::String attr_accessor filter_by_playback_restriction_policy_arn: ::String - attr_accessor next_token: ::String + attr_accessor filter_by_recording_configuration_arn: ::String attr_accessor max_results: ::Integer + attr_accessor next_token: ::String SENSITIVE: [] end @@ -318,8 +318,8 @@ module Aws::IVS end class ListPlaybackKeyPairsRequest - attr_accessor next_token: ::String attr_accessor max_results: ::Integer + attr_accessor next_token: ::String SENSITIVE: [] end @@ -330,65 +330,65 @@ module Aws::IVS end class ListPlaybackRestrictionPoliciesRequest - attr_accessor next_token: ::String attr_accessor max_results: ::Integer + attr_accessor next_token: ::String SENSITIVE: [] end class ListPlaybackRestrictionPoliciesResponse - attr_accessor playback_restriction_policies: ::Array[Types::PlaybackRestrictionPolicySummary] attr_accessor next_token: ::String + attr_accessor playback_restriction_policies: ::Array[Types::PlaybackRestrictionPolicySummary] SENSITIVE: [] end class ListRecordingConfigurationsRequest - attr_accessor next_token: ::String attr_accessor max_results: ::Integer + attr_accessor next_token: ::String SENSITIVE: [] end class ListRecordingConfigurationsResponse - attr_accessor recording_configurations: ::Array[Types::RecordingConfigurationSummary] attr_accessor next_token: ::String + attr_accessor recording_configurations: ::Array[Types::RecordingConfigurationSummary] SENSITIVE: [] end class ListStreamKeysRequest attr_accessor channel_arn: ::String - attr_accessor next_token: ::String attr_accessor max_results: ::Integer + attr_accessor next_token: ::String SENSITIVE: [] end class ListStreamKeysResponse - attr_accessor stream_keys: ::Array[Types::StreamKeySummary] attr_accessor next_token: ::String + attr_accessor stream_keys: ::Array[Types::StreamKeySummary] SENSITIVE: [] end class ListStreamSessionsRequest attr_accessor channel_arn: ::String - attr_accessor next_token: ::String attr_accessor max_results: ::Integer + attr_accessor next_token: ::String SENSITIVE: [] end class ListStreamSessionsResponse - attr_accessor stream_sessions: ::Array[Types::StreamSessionSummary] attr_accessor next_token: ::String + attr_accessor stream_sessions: ::Array[Types::StreamSessionSummary] SENSITIVE: [] end class ListStreamsRequest attr_accessor filter_by: Types::StreamFilters - attr_accessor next_token: ::String attr_accessor max_results: ::Integer + attr_accessor next_token: ::String SENSITIVE: [] end class ListStreamsResponse - attr_accessor streams: ::Array[Types::StreamSummary] attr_accessor next_token: ::String + attr_accessor streams: ::Array[Types::StreamSummary] SENSITIVE: [] end @@ -409,8 +409,8 @@ module Aws::IVS class PlaybackKeyPair attr_accessor arn: ::String - attr_accessor name: ::String attr_accessor fingerprint: ::String + attr_accessor name: ::String attr_accessor tags: ::Hash[::String, ::String] SENSITIVE: [] end @@ -423,9 +423,9 @@ module Aws::IVS end class PlaybackRestrictionPolicy - attr_accessor arn: ::String attr_accessor allowed_countries: ::Array[::String] attr_accessor allowed_origins: ::Array[::String] + attr_accessor arn: ::String attr_accessor enable_strict_origin_enforcement: bool attr_accessor name: ::String attr_accessor tags: ::Hash[::String, ::String] @@ -433,9 +433,9 @@ module Aws::IVS end class PlaybackRestrictionPolicySummary - attr_accessor arn: ::String attr_accessor allowed_countries: ::Array[::String] attr_accessor allowed_origins: ::Array[::String] + attr_accessor arn: ::String attr_accessor enable_strict_origin_enforcement: bool attr_accessor name: ::String attr_accessor tags: ::Hash[::String, ::String] @@ -450,20 +450,20 @@ module Aws::IVS class RecordingConfiguration attr_accessor arn: ::String - attr_accessor name: ::String attr_accessor destination_configuration: Types::DestinationConfiguration + attr_accessor name: ::String + attr_accessor recording_reconnect_window_seconds: ::Integer + attr_accessor rendition_configuration: Types::RenditionConfiguration attr_accessor state: ("CREATING" | "CREATE_FAILED" | "ACTIVE") attr_accessor tags: ::Hash[::String, ::String] attr_accessor thumbnail_configuration: Types::ThumbnailConfiguration - attr_accessor recording_reconnect_window_seconds: ::Integer - attr_accessor rendition_configuration: Types::RenditionConfiguration SENSITIVE: [] end class RecordingConfigurationSummary attr_accessor arn: ::String - attr_accessor name: ::String attr_accessor destination_configuration: Types::DestinationConfiguration + attr_accessor name: ::String attr_accessor state: ("CREATING" | "CREATE_FAILED" | "ACTIVE") attr_accessor tags: ::Hash[::String, ::String] SENSITIVE: [] @@ -516,19 +516,20 @@ module Aws::IVS class Stream attr_accessor channel_arn: ::String - attr_accessor stream_id: ::String + attr_accessor health: ("HEALTHY" | "STARVING" | "UNKNOWN") attr_accessor playback_url: ::String attr_accessor start_time: ::Time attr_accessor state: ("LIVE" | "OFFLINE") - attr_accessor health: ("HEALTHY" | "STARVING" | "UNKNOWN") + attr_accessor stream_id: ::String attr_accessor viewer_count: ::Integer SENSITIVE: [] end class StreamEvent + attr_accessor code: ::String + attr_accessor event_time: ::Time attr_accessor name: ::String attr_accessor type: ::String - attr_accessor event_time: ::Time SENSITIVE: [] end @@ -539,9 +540,9 @@ module Aws::IVS class StreamKey attr_accessor arn: ::String - attr_accessor value: ::String attr_accessor channel_arn: ::String attr_accessor tags: ::Hash[::String, ::String] + attr_accessor value: ::String SENSITIVE: [:value] end @@ -553,31 +554,31 @@ module Aws::IVS end class StreamSession - attr_accessor stream_id: ::String - attr_accessor start_time: ::Time - attr_accessor end_time: ::Time attr_accessor channel: Types::Channel + attr_accessor end_time: ::Time attr_accessor ingest_configuration: Types::IngestConfiguration attr_accessor recording_configuration: Types::RecordingConfiguration + attr_accessor start_time: ::Time + attr_accessor stream_id: ::String attr_accessor truncated_events: ::Array[Types::StreamEvent] SENSITIVE: [] end class StreamSessionSummary - attr_accessor stream_id: ::String - attr_accessor start_time: ::Time attr_accessor end_time: ::Time attr_accessor has_error_event: bool + attr_accessor start_time: ::Time + attr_accessor stream_id: ::String SENSITIVE: [] end class StreamSummary attr_accessor channel_arn: ::String - attr_accessor stream_id: ::String - attr_accessor state: ("LIVE" | "OFFLINE") attr_accessor health: ("HEALTHY" | "STARVING" | "UNKNOWN") - attr_accessor viewer_count: ::Integer attr_accessor start_time: ::Time + attr_accessor state: ("LIVE" | "OFFLINE") + attr_accessor stream_id: ::String + attr_accessor viewer_count: ::Integer SENSITIVE: [] end @@ -602,9 +603,9 @@ module Aws::IVS class ThumbnailConfiguration attr_accessor recording_mode: ("DISABLED" | "INTERVAL") - attr_accessor target_interval_seconds: ::Integer attr_accessor resolution: ("SD" | "HD" | "FULL_HD" | "LOWEST_RESOLUTION") attr_accessor storage: ::Array[("SEQUENTIAL" | "LATEST")] + attr_accessor target_interval_seconds: ::Integer SENSITIVE: [] end @@ -619,14 +620,14 @@ module Aws::IVS class UpdateChannelRequest attr_accessor arn: ::String - attr_accessor name: ::String - attr_accessor latency_mode: ("NORMAL" | "LOW") - attr_accessor type: ("BASIC" | "STANDARD" | "ADVANCED_SD" | "ADVANCED_HD") attr_accessor authorized: bool - attr_accessor recording_configuration_arn: ::String attr_accessor insecure_ingest: bool - attr_accessor preset: ("HIGHER_BANDWIDTH_DELIVERY" | "CONSTRAINED_BANDWIDTH_DELIVERY") + attr_accessor latency_mode: ("NORMAL" | "LOW") + attr_accessor name: ::String attr_accessor playback_restriction_policy_arn: ::String + attr_accessor preset: ("HIGHER_BANDWIDTH_DELIVERY" | "CONSTRAINED_BANDWIDTH_DELIVERY") + attr_accessor recording_configuration_arn: ::String + attr_accessor type: ("BASIC" | "STANDARD" | "ADVANCED_SD" | "ADVANCED_HD") SENSITIVE: [] end @@ -636,9 +637,9 @@ module Aws::IVS end class UpdatePlaybackRestrictionPolicyRequest - attr_accessor arn: ::String attr_accessor allowed_countries: ::Array[::String] attr_accessor allowed_origins: ::Array[::String] + attr_accessor arn: ::String attr_accessor enable_strict_origin_enforcement: bool attr_accessor name: ::String SENSITIVE: [] @@ -655,8 +656,8 @@ module Aws::IVS end class VideoConfiguration - attr_accessor avc_profile: ::String attr_accessor avc_level: ::String + attr_accessor avc_profile: ::String attr_accessor codec: ::String attr_accessor encoder: ::String attr_accessor target_bitrate: ::Integer diff --git a/gems/aws-sdk-nimblestudio/CHANGELOG.md b/gems/aws-sdk-nimblestudio/CHANGELOG.md index 4e5ce3276ec..2af332f8d5e 100644 --- a/gems/aws-sdk-nimblestudio/CHANGELOG.md +++ b/gems/aws-sdk-nimblestudio/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.41.0 (2024-10-15) +------------------ + +* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details. + * Feature - Nimble Studio has been removed from the SDK because it has been discontinued. 1.40.0 (2024-09-24) diff --git a/gems/aws-sdk-nimblestudio/VERSION b/gems/aws-sdk-nimblestudio/VERSION index 32b7211cb61..7d47e599800 100644 --- a/gems/aws-sdk-nimblestudio/VERSION +++ b/gems/aws-sdk-nimblestudio/VERSION @@ -1 +1 @@ -1.40.0 +1.41.0 diff --git a/gems/aws-sdk-nimblestudio/aws-sdk-nimblestudio.gemspec b/gems/aws-sdk-nimblestudio/aws-sdk-nimblestudio.gemspec index a463cd00e0c..9d8153b8067 100644 --- a/gems/aws-sdk-nimblestudio/aws-sdk-nimblestudio.gemspec +++ b/gems/aws-sdk-nimblestudio/aws-sdk-nimblestudio.gemspec @@ -12,7 +12,7 @@ Gem::Specification.new do |spec| spec.name = 'aws-sdk-nimblestudio' spec.version = File.read(File.expand_path('../VERSION', __FILE__)).strip spec.summary = 'AWS SDK for Ruby - AmazonNimbleStudio' - spec.description = 'Official AWS Ruby gem for AmazonNimbleStudio. This gem is part of the AWS SDK for Ruby.' + spec.description = '[DEPRECATED] Official AWS Ruby gem for AmazonNimbleStudio. This gem is part of the AWS SDK for Ruby.' spec.author = 'Amazon Web Services' spec.homepage = 'https://github.com/aws/aws-sdk-ruby' spec.license = 'Apache-2.0' @@ -29,4 +29,5 @@ Gem::Specification.new do |spec| spec.add_dependency('aws-sigv4', '~> 1.1') spec.required_ruby_version = '>= 2.5' + spec.post_install_message = '*** aws-sdk-nimblestudio is deprecated ***' end diff --git a/gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio.rb b/gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio.rb index 3c70b0bf6fb..3958549a250 100644 --- a/gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio.rb +++ b/gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio.rb @@ -55,7 +55,7 @@ module Plugins autoload :EndpointProvider, 'aws-sdk-nimblestudio/endpoint_provider' autoload :Endpoints, 'aws-sdk-nimblestudio/endpoints' - GEM_VERSION = '1.40.0' + GEM_VERSION = '1.41.0' end diff --git a/gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb b/gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb index bb257dc1954..74e914ad833 100644 --- a/gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb +++ b/gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/client.rb @@ -3818,7 +3818,7 @@ def build_request(operation_name, params = {}) tracer: tracer ) context[:gem_name] = 'aws-sdk-nimblestudio' - context[:gem_version] = '1.40.0' + context[:gem_version] = '1.41.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-qbusiness/CHANGELOG.md b/gems/aws-sdk-qbusiness/CHANGELOG.md index 625752d91ed..7b18931f25b 100644 --- a/gems/aws-sdk-qbusiness/CHANGELOG.md +++ b/gems/aws-sdk-qbusiness/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.19.0 (2024-10-15) +------------------ + +* Feature - Amazon Q Business now supports embedding the Amazon Q Business web experience on third-party websites. + 1.18.0 (2024-09-24) ------------------ diff --git a/gems/aws-sdk-qbusiness/VERSION b/gems/aws-sdk-qbusiness/VERSION index 84cc529467b..815d5ca06d5 100644 --- a/gems/aws-sdk-qbusiness/VERSION +++ b/gems/aws-sdk-qbusiness/VERSION @@ -1 +1 @@ -1.18.0 +1.19.0 diff --git a/gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness.rb b/gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness.rb index 4e98a85dfc1..f3737b7d1a9 100644 --- a/gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness.rb +++ b/gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness.rb @@ -57,7 +57,7 @@ module Plugins autoload :AsyncClient, 'aws-sdk-qbusiness/async_client' autoload :EventStreams, 'aws-sdk-qbusiness/event_streams' - GEM_VERSION = '1.18.0' + GEM_VERSION = '1.19.0' end diff --git a/gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/async_client.rb b/gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/async_client.rb index 3b98f90a975..8934d99d3c5 100644 --- a/gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/async_client.rb +++ b/gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/async_client.rb @@ -372,7 +372,7 @@ def initialize(*args) # The identifier of the user attached to the chat input. # # @option params [Array] :user_groups - # The groups that a user associated with the chat input belongs to. + # The group names that a user associated with the chat input belongs to. # # @option params [String] :conversation_id # The identifier of the Amazon Q Business conversation. @@ -603,7 +603,7 @@ def build_request(operation_name, params = {}) tracer: tracer ) context[:gem_name] = 'aws-sdk-qbusiness' - context[:gem_version] = '1.18.0' + context[:gem_version] = '1.19.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb b/gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb index c956ba3fb2c..f8ec39b91b7 100644 --- a/gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb +++ b/gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client.rb @@ -688,7 +688,7 @@ def batch_put_document(params = {}, options = {}) # The identifier of the user attached to the chat input. # # @option params [Array] :user_groups - # The groups that a user associated with the chat input belongs to. + # The group names that a user associated with the chat input belongs to. # # @option params [String] :user_message # A end user message in a conversation. @@ -939,7 +939,13 @@ def chat_sync(params = {}, options = {}) # # @option params [String] :role_arn # The Amazon Resource Name (ARN) of an IAM role with permissions to - # access your Amazon CloudWatch logs and metrics. + # access your Amazon CloudWatch logs and metrics. If this property is + # not specified, Amazon Q Business will create a [service linked role + # (SLR)][1] and use it as the application's role. + # + # + # + # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles.html#slr-permissions # # @option params [String] :identity_type # The authentication type being used by a Amazon Q Business application. @@ -1588,6 +1594,15 @@ def create_user(params = {}, options = {}) # Determines whether sample prompts are enabled in the web experience # for an end user. # + # @option params [Array] :origins + # Sets the website domain origins that are allowed to embed the Amazon Q + # Business web experience. The domain origin refers to the + # base URL for accessing a website including the protocol + # (http/https), the domain name, and the port number (if + # specified).

You must only submit a base URL and + # not a full path. For example, + # https://docs.aws.amazon.com.

 + # # @option params [String] :role_arn # The Amazon Resource Name (ARN) of the service role attached to your # web experience. @@ -1630,6 +1645,7 @@ def create_user(params = {}, options = {}) # subtitle: "WebExperienceSubtitle", # welcome_message: "WebExperienceWelcomeMessage", # sample_prompts_control_mode: "ENABLED", # accepts ENABLED, DISABLED + # origins: ["Origin"], # role_arn: "RoleArn", # tags: [ # { @@ -2496,6 +2512,7 @@ def get_user(params = {}, options = {}) # * {Types::GetWebExperienceResponse#subtitle #subtitle} => String # * {Types::GetWebExperienceResponse#welcome_message #welcome_message} => String # * {Types::GetWebExperienceResponse#sample_prompts_control_mode #sample_prompts_control_mode} => String + # * {Types::GetWebExperienceResponse#origins #origins} => Array<String> # * {Types::GetWebExperienceResponse#role_arn #role_arn} => String # * {Types::GetWebExperienceResponse#identity_provider_configuration #identity_provider_configuration} => Types::IdentityProviderConfiguration # * {Types::GetWebExperienceResponse#authentication_configuration #authentication_configuration} => Types::WebExperienceAuthConfiguration @@ -2521,6 +2538,8 @@ def get_user(params = {}, options = {}) # resp.subtitle #=> String # resp.welcome_message #=> String # resp.sample_prompts_control_mode #=> String, one of "ENABLED", "DISABLED" + # resp.origins #=> Array + # resp.origins[0] #=> String # resp.role_arn #=> String # resp.identity_provider_configuration.saml_configuration.authentication_url #=> String # resp.identity_provider_configuration.open_id_connect_configuration.secrets_arn #=> String @@ -4097,6 +4116,17 @@ def update_user(params = {}, options = {}) # Information about the identity provider (IdP) used to authenticate end # users of an Amazon Q Business web experience. # + # @option params [Array] :origins + # Updates the website domain origins that are allowed to embed the + # Amazon Q Business web experience. The domain origin refers + # to the base URL for accessing a website including the protocol + # (http/https), the domain name, and the port number (if + # specified).

  • Any values except + # null submitted as part of this update will replace all + # previous values.

  • You must only submit a base + # URL and not a full path. For example, + # https://docs.aws.amazon.com.

 + # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values @@ -4126,6 +4156,7 @@ def update_user(params = {}, options = {}) # secrets_role: "RoleArn", # required # }, # }, + # origins: ["Origin"], # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateWebExperience AWS API Documentation @@ -4155,7 +4186,7 @@ def build_request(operation_name, params = {}) tracer: tracer ) context[:gem_name] = 'aws-sdk-qbusiness' - context[:gem_version] = '1.18.0' + context[:gem_version] = '1.19.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client_api.rb b/gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client_api.rb index 4f36675e56a..b30a881af92 100644 --- a/gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client_api.rb +++ b/gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/client_api.rb @@ -303,6 +303,7 @@ module ClientApi NumberAttributeBoostingType = Shapes::StringShape.new(name: 'NumberAttributeBoostingType') OAuth2ClientCredentialConfiguration = Shapes::StructureShape.new(name: 'OAuth2ClientCredentialConfiguration') OpenIDConnectProviderConfiguration = Shapes::StructureShape.new(name: 'OpenIDConnectProviderConfiguration') + Origin = Shapes::StringShape.new(name: 'Origin') Payload = Shapes::StringShape.new(name: 'Payload') PersonalizationConfiguration = Shapes::StructureShape.new(name: 'PersonalizationConfiguration') PersonalizationControlMode = Shapes::StringShape.new(name: 'PersonalizationControlMode') @@ -427,6 +428,7 @@ module ClientApi WebExperienceArn = Shapes::StringShape.new(name: 'WebExperienceArn') WebExperienceAuthConfiguration = Shapes::UnionShape.new(name: 'WebExperienceAuthConfiguration') WebExperienceId = Shapes::StringShape.new(name: 'WebExperienceId') + WebExperienceOrigins = Shapes::ListShape.new(name: 'WebExperienceOrigins') WebExperienceSamplePromptsControlMode = Shapes::StringShape.new(name: 'WebExperienceSamplePromptsControlMode') WebExperienceStatus = Shapes::StringShape.new(name: 'WebExperienceStatus') WebExperienceSubtitle = Shapes::StringShape.new(name: 'WebExperienceSubtitle') @@ -786,6 +788,7 @@ module ClientApi CreateWebExperienceRequest.add_member(:subtitle, Shapes::ShapeRef.new(shape: WebExperienceSubtitle, location_name: "subtitle")) CreateWebExperienceRequest.add_member(:welcome_message, Shapes::ShapeRef.new(shape: WebExperienceWelcomeMessage, location_name: "welcomeMessage")) CreateWebExperienceRequest.add_member(:sample_prompts_control_mode, Shapes::ShapeRef.new(shape: WebExperienceSamplePromptsControlMode, location_name: "samplePromptsControlMode")) + CreateWebExperienceRequest.add_member(:origins, Shapes::ShapeRef.new(shape: WebExperienceOrigins, location_name: "origins")) CreateWebExperienceRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "roleArn")) CreateWebExperienceRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags")) CreateWebExperienceRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true})) @@ -1167,6 +1170,7 @@ module ClientApi GetWebExperienceResponse.add_member(:subtitle, Shapes::ShapeRef.new(shape: WebExperienceSubtitle, location_name: "subtitle")) GetWebExperienceResponse.add_member(:welcome_message, Shapes::ShapeRef.new(shape: WebExperienceWelcomeMessage, location_name: "welcomeMessage")) GetWebExperienceResponse.add_member(:sample_prompts_control_mode, Shapes::ShapeRef.new(shape: WebExperienceSamplePromptsControlMode, location_name: "samplePromptsControlMode")) + GetWebExperienceResponse.add_member(:origins, Shapes::ShapeRef.new(shape: WebExperienceOrigins, location_name: "origins")) GetWebExperienceResponse.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "roleArn")) GetWebExperienceResponse.add_member(:identity_provider_configuration, Shapes::ShapeRef.new(shape: IdentityProviderConfiguration, location_name: "identityProviderConfiguration")) GetWebExperienceResponse.add_member(:authentication_configuration, Shapes::ShapeRef.new(shape: WebExperienceAuthConfiguration, deprecated: true, location_name: "authenticationConfiguration", metadata: {"deprecatedMessage"=>"Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management."})) @@ -1713,6 +1717,7 @@ module ClientApi UpdateWebExperienceRequest.add_member(:welcome_message, Shapes::ShapeRef.new(shape: WebExperienceWelcomeMessage, location_name: "welcomeMessage")) UpdateWebExperienceRequest.add_member(:sample_prompts_control_mode, Shapes::ShapeRef.new(shape: WebExperienceSamplePromptsControlMode, location_name: "samplePromptsControlMode")) UpdateWebExperienceRequest.add_member(:identity_provider_configuration, Shapes::ShapeRef.new(shape: IdentityProviderConfiguration, location_name: "identityProviderConfiguration")) + UpdateWebExperienceRequest.add_member(:origins, Shapes::ShapeRef.new(shape: WebExperienceOrigins, location_name: "origins")) UpdateWebExperienceRequest.struct_class = Types::UpdateWebExperienceRequest UpdateWebExperienceResponse.struct_class = Types::UpdateWebExperienceResponse @@ -1756,6 +1761,8 @@ module ClientApi WebExperienceAuthConfiguration.add_member_subclass(:unknown, Types::WebExperienceAuthConfiguration::Unknown) WebExperienceAuthConfiguration.struct_class = Types::WebExperienceAuthConfiguration + WebExperienceOrigins.member = Shapes::ShapeRef.new(shape: Origin) + WebExperiences.member = Shapes::ShapeRef.new(shape: WebExperience) diff --git a/gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb b/gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb index 80e8297b15d..9dc464e76f0 100644 --- a/gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb +++ b/gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb @@ -874,7 +874,8 @@ class BlockedPhrasesConfigurationUpdate < Struct.new( # @return [String] # # @!attribute [rw] user_groups - # The groups that a user associated with the chat input belongs to. + # The group names that a user associated with the chat input belongs + # to. # @return [Array] # # @!attribute [rw] conversation_id @@ -962,7 +963,8 @@ class ChatOutput < Struct.new( # @return [String] # # @!attribute [rw] user_groups - # The groups that a user associated with the chat input belongs to. + # The group names that a user associated with the chat input belongs + # to. # @return [Array] # # @!attribute [rw] user_message @@ -1251,7 +1253,13 @@ class Conversation < Struct.new( # # @!attribute [rw] role_arn # The Amazon Resource Name (ARN) of an IAM role with permissions to - # access your Amazon CloudWatch logs and metrics. + # access your Amazon CloudWatch logs and metrics. If this property is + # not specified, Amazon Q Business will create a [service linked role + # (SLR)][1] and use it as the application's role. + # + # + # + # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles.html#slr-permissions # @return [String] # # @!attribute [rw] identity_type @@ -1771,6 +1779,16 @@ class CreateUserResponse < Aws::EmptyStructure; end # for an end user. # @return [String] # + # @!attribute [rw] origins + # Sets the website domain origins that are allowed to embed the Amazon + # Q Business web experience. The domain origin refers to + # the base URL for accessing a website including the protocol + # (http/https), the domain name, and the port number (if + # specified).

You must only submit a base URL + # and not a full path. For example, + # https://docs.aws.amazon.com.

 + # @return [Array] + # # @!attribute [rw] role_arn # The Amazon Resource Name (ARN) of the service role attached to your # web experience. @@ -1812,6 +1830,7 @@ class CreateWebExperienceRequest < Struct.new( :subtitle, :welcome_message, :sample_prompts_control_mode, + :origins, :role_arn, :tags, :client_token, @@ -3643,6 +3662,14 @@ class GetWebExperienceRequest < Struct.new( # for an end user. # @return [String] # + # @!attribute [rw] origins + # Gets the website domain origins that are allowed to embed the Amazon + # Q Business web experience. The domain origin refers to + # the base URL for accessing a website including the protocol + # (http/https), the domain name, and the port number (if + # specified).

+ # @return [Array] + # # @!attribute [rw] role_arn # The Amazon Resource Name (ARN) of the service role attached to your # web experience. @@ -3678,6 +3705,7 @@ class GetWebExperienceResponse < Struct.new( :subtitle, :welcome_message, :sample_prompts_control_mode, + :origins, :role_arn, :identity_provider_configuration, :authentication_configuration, @@ -5198,7 +5226,7 @@ class PutGroupRequest < Struct.new( # class PutGroupResponse < Aws::EmptyStructure; end - # Configuration information about Amazon Q Apps. (preview feature) + # Configuration information about Amazon Q Apps. # # @!attribute [rw] q_apps_control_mode # Status information about whether end users can create and use Amazon @@ -6294,6 +6322,18 @@ class UpdateUserResponse < Struct.new( # end users of an Amazon Q Business web experience. # @return [Types::IdentityProviderConfiguration] # + # @!attribute [rw] origins + # Updates the website domain origins that are allowed to embed the + # Amazon Q Business web experience. The domain origin + # refers to the base URL for accessing a website including the + # protocol (http/https), the domain name, and the port + # number (if specified).

  • Any values except + # null submitted as part of this update will replace all + # previous values.

  • You must only submit a base + # URL and not a full path. For example, + # https://docs.aws.amazon.com.

 + # @return [Array] + # # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateWebExperienceRequest AWS API Documentation # class UpdateWebExperienceRequest < Struct.new( @@ -6305,7 +6345,8 @@ class UpdateWebExperienceRequest < Struct.new( :subtitle, :welcome_message, :sample_prompts_control_mode, - :identity_provider_configuration) + :identity_provider_configuration, + :origins) SENSITIVE = [] include Aws::Structure end @@ -6340,15 +6381,15 @@ class UserAlias < Struct.new( include Aws::Structure end - # Provides information about users and groups associated with a topic - # control rule. + # Provides information about users and group names associated with a + # topic control rule. # # @!attribute [rw] user_ids # The user ids associated with a topic control rule. # @return [Array] # # @!attribute [rw] user_groups - # The user groups associated with a topic control rule. + # The user group names associated with a topic control rule. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UsersAndGroups AWS API Documentation diff --git a/gems/aws-sdk-qbusiness/sig/client.rbs b/gems/aws-sdk-qbusiness/sig/client.rbs index bd78d015b1f..6e1537aa80b 100644 --- a/gems/aws-sdk-qbusiness/sig/client.rbs +++ b/gems/aws-sdk-qbusiness/sig/client.rbs @@ -613,6 +613,7 @@ module Aws ?subtitle: ::String, ?welcome_message: ::String, ?sample_prompts_control_mode: ("ENABLED" | "DISABLED"), + ?origins: Array[::String], ?role_arn: ::String, ?tags: Array[ { @@ -905,6 +906,7 @@ module Aws def subtitle: () -> ::String def welcome_message: () -> ::String def sample_prompts_control_mode: () -> ("ENABLED" | "DISABLED") + def origins: () -> ::Array[::String] def role_arn: () -> ::String def identity_provider_configuration: () -> Types::IdentityProviderConfiguration def authentication_configuration: () -> Types::WebExperienceAuthConfiguration @@ -1512,7 +1514,8 @@ module Aws secrets_arn: ::String, secrets_role: ::String }? - } + }, + ?origins: Array[::String] ) -> _UpdateWebExperienceResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateWebExperienceResponseSuccess end diff --git a/gems/aws-sdk-qbusiness/sig/types.rbs b/gems/aws-sdk-qbusiness/sig/types.rbs index f3e92da79bd..e3925c86a2a 100644 --- a/gems/aws-sdk-qbusiness/sig/types.rbs +++ b/gems/aws-sdk-qbusiness/sig/types.rbs @@ -431,6 +431,7 @@ module Aws::QBusiness attr_accessor subtitle: ::String attr_accessor welcome_message: ::String attr_accessor sample_prompts_control_mode: ("ENABLED" | "DISABLED") + attr_accessor origins: ::Array[::String] attr_accessor role_arn: ::String attr_accessor tags: ::Array[Types::Tag] attr_accessor client_token: ::String @@ -919,6 +920,7 @@ module Aws::QBusiness attr_accessor subtitle: ::String attr_accessor welcome_message: ::String attr_accessor sample_prompts_control_mode: ("ENABLED" | "DISABLED") + attr_accessor origins: ::Array[::String] attr_accessor role_arn: ::String attr_accessor identity_provider_configuration: Types::IdentityProviderConfiguration attr_accessor authentication_configuration: Types::WebExperienceAuthConfiguration @@ -1639,6 +1641,7 @@ module Aws::QBusiness attr_accessor welcome_message: ::String attr_accessor sample_prompts_control_mode: ("ENABLED" | "DISABLED") attr_accessor identity_provider_configuration: Types::IdentityProviderConfiguration + attr_accessor origins: ::Array[::String] SENSITIVE: [] end diff --git a/gems/aws-sdk-redshift/CHANGELOG.md b/gems/aws-sdk-redshift/CHANGELOG.md index 4fa8fccbd71..9b7c3187a53 100644 --- a/gems/aws-sdk-redshift/CHANGELOG.md +++ b/gems/aws-sdk-redshift/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.127.0 (2024-10-15) +------------------ + +* Feature - This release launches the CreateIntegration, DeleteIntegration, DescribeIntegrations and ModifyIntegration APIs to create and manage Amazon Redshift Zero-ETL Integrations. + 1.126.0 (2024-10-07) ------------------ diff --git a/gems/aws-sdk-redshift/VERSION b/gems/aws-sdk-redshift/VERSION index c96f047721f..a7fd4875b44 100644 --- a/gems/aws-sdk-redshift/VERSION +++ b/gems/aws-sdk-redshift/VERSION @@ -1 +1 @@ -1.126.0 +1.127.0 diff --git a/gems/aws-sdk-redshift/lib/aws-sdk-redshift.rb b/gems/aws-sdk-redshift/lib/aws-sdk-redshift.rb index 353aa047f10..b6ea10fe2ca 100644 --- a/gems/aws-sdk-redshift/lib/aws-sdk-redshift.rb +++ b/gems/aws-sdk-redshift/lib/aws-sdk-redshift.rb @@ -55,7 +55,7 @@ module Plugins autoload :EndpointProvider, 'aws-sdk-redshift/endpoint_provider' autoload :Endpoints, 'aws-sdk-redshift/endpoints' - GEM_VERSION = '1.126.0' + GEM_VERSION = '1.127.0' end diff --git a/gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb b/gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb index 31a74e949f6..6ca2716249d 100644 --- a/gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb +++ b/gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb @@ -1307,8 +1307,8 @@ def create_authentication_profile(params = {}, options = {}) # node types, go to [ Working with Clusters][1] in the *Amazon Redshift # Cluster Management Guide*. # - # Valid Values: `dc2.large` \| `dc2.8xlarge` \| `ra3.xlplus` \| - # `ra3.4xlarge` \| `ra3.16xlarge` + # Valid Values: `dc2.large` \| `dc2.8xlarge` \| `ra3.large` \| + # `ra3.xlplus` \| `ra3.4xlarge` \| `ra3.16xlarge` # # # @@ -2580,6 +2580,104 @@ def create_hsm_configuration(params = {}, options = {}) req.send_request(options) end + # Creates a zero-ETL integration with Amazon Redshift. + # + # @option params [required, String] :source_arn + # The Amazon Resource Name (ARN) of the database to use as the source + # for replication. + # + # @option params [required, String] :target_arn + # The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse + # to use as the target for replication. + # + # @option params [required, String] :integration_name + # The name of the integration. + # + # @option params [String] :kms_key_id + # 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. + # + # @option params [Array] :tag_list + # A list of tags. + # + # @option params [Hash] :additional_encryption_context + # An optional set of non-secret key–value pairs that contains additional + # contextual information about the data. For more information, see + # [Encryption context][1] in the *Amazon Web Services Key Management + # Service Developer Guide*. + # + # You can only include this parameter if you specify the `KMSKeyId` + # parameter. + # + # + # + # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context + # + # @option params [String] :description + # A description of the integration. + # + # @return [Types::Integration] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::Integration#integration_arn #integration_arn} => String + # * {Types::Integration#integration_name #integration_name} => String + # * {Types::Integration#source_arn #source_arn} => String + # * {Types::Integration#target_arn #target_arn} => String + # * {Types::Integration#status #status} => String + # * {Types::Integration#errors #errors} => Array<Types::IntegrationError> + # * {Types::Integration#create_time #create_time} => Time + # * {Types::Integration#description #description} => String + # * {Types::Integration#kms_key_id #kms_key_id} => String + # * {Types::Integration#additional_encryption_context #additional_encryption_context} => Hash<String,String> + # * {Types::Integration#tags #tags} => Array<Types::Tag> + # + # @example Request syntax with placeholder values + # + # resp = client.create_integration({ + # source_arn: "String", # required + # target_arn: "String", # required + # integration_name: "IntegrationName", # required + # kms_key_id: "String", + # tag_list: [ + # { + # key: "String", + # value: "String", + # }, + # ], + # additional_encryption_context: { + # "String" => "String", + # }, + # description: "IntegrationDescription", + # }) + # + # @example Response structure + # + # resp.integration_arn #=> String + # resp.integration_name #=> String + # resp.source_arn #=> String + # resp.target_arn #=> String + # resp.status #=> String, one of "creating", "active", "modifying", "failed", "deleting", "syncing", "needs_attention" + # resp.errors #=> Array + # resp.errors[0].error_code #=> String + # resp.errors[0].error_message #=> String + # resp.create_time #=> Time + # resp.description #=> String + # resp.kms_key_id #=> String + # resp.additional_encryption_context #=> Hash + # resp.additional_encryption_context["String"] #=> String + # resp.tags #=> Array + # resp.tags[0].key #=> String + # resp.tags[0].value #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateIntegration AWS API Documentation + # + # @overload create_integration(params = {}) + # @param [Hash] params ({}) + def create_integration(params = {}, options = {}) + req = build_request(:create_integration, params) + req.send_request(options) + end + # Creates an Amazon Redshift application for use with IAM Identity # Center. # @@ -3689,6 +3787,59 @@ def delete_hsm_configuration(params = {}, options = {}) req.send_request(options) end + # Deletes a zero-ETL integration with Amazon Redshift. + # + # @option params [required, String] :integration_arn + # The unique identifier of the integration to delete. + # + # @return [Types::Integration] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::Integration#integration_arn #integration_arn} => String + # * {Types::Integration#integration_name #integration_name} => String + # * {Types::Integration#source_arn #source_arn} => String + # * {Types::Integration#target_arn #target_arn} => String + # * {Types::Integration#status #status} => String + # * {Types::Integration#errors #errors} => Array<Types::IntegrationError> + # * {Types::Integration#create_time #create_time} => Time + # * {Types::Integration#description #description} => String + # * {Types::Integration#kms_key_id #kms_key_id} => String + # * {Types::Integration#additional_encryption_context #additional_encryption_context} => Hash<String,String> + # * {Types::Integration#tags #tags} => Array<Types::Tag> + # + # @example Request syntax with placeholder values + # + # resp = client.delete_integration({ + # integration_arn: "IntegrationArn", # required + # }) + # + # @example Response structure + # + # resp.integration_arn #=> String + # resp.integration_name #=> String + # resp.source_arn #=> String + # resp.target_arn #=> String + # resp.status #=> String, one of "creating", "active", "modifying", "failed", "deleting", "syncing", "needs_attention" + # resp.errors #=> Array + # resp.errors[0].error_code #=> String + # resp.errors[0].error_message #=> String + # resp.create_time #=> Time + # resp.description #=> String + # resp.kms_key_id #=> String + # resp.additional_encryption_context #=> Hash + # resp.additional_encryption_context["String"] #=> String + # resp.tags #=> Array + # resp.tags[0].key #=> String + # resp.tags[0].value #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeleteIntegration AWS API Documentation + # + # @overload delete_integration(params = {}) + # @param [Hash] params ({}) + def delete_integration(params = {}, options = {}) + req = build_request(:delete_integration, params) + req.send_request(options) + end + # Deletes a partner integration from a cluster. Data can still flow to # the cluster until the integration is deleted at the partner's # website. @@ -6041,6 +6192,82 @@ def describe_inbound_integrations(params = {}, options = {}) req.send_request(options) end + # Describes one or more zero-ETL integrations with Amazon Redshift. + # + # @option params [String] :integration_arn + # The unique identifier of the integration. + # + # @option params [Integer] :max_records + # 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. + # + # @option params [String] :marker + # 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`. + # + # @option params [Array] :filters + # A filter that specifies one or more resources to return. + # + # @return [Types::IntegrationsMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::IntegrationsMessage#marker #marker} => String + # * {Types::IntegrationsMessage#integrations #integrations} => Array<Types::Integration> + # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # + # @example Request syntax with placeholder values + # + # resp = client.describe_integrations({ + # integration_arn: "IntegrationArn", + # max_records: 1, + # marker: "String", + # filters: [ + # { + # name: "integration-arn", # required, accepts integration-arn, source-arn, source-types, status + # values: ["String"], # required + # }, + # ], + # }) + # + # @example Response structure + # + # resp.marker #=> String + # resp.integrations #=> Array + # resp.integrations[0].integration_arn #=> String + # resp.integrations[0].integration_name #=> String + # resp.integrations[0].source_arn #=> String + # resp.integrations[0].target_arn #=> String + # resp.integrations[0].status #=> String, one of "creating", "active", "modifying", "failed", "deleting", "syncing", "needs_attention" + # resp.integrations[0].errors #=> Array + # resp.integrations[0].errors[0].error_code #=> String + # resp.integrations[0].errors[0].error_message #=> String + # resp.integrations[0].create_time #=> Time + # resp.integrations[0].description #=> String + # resp.integrations[0].kms_key_id #=> String + # resp.integrations[0].additional_encryption_context #=> Hash + # resp.integrations[0].additional_encryption_context["String"] #=> String + # resp.integrations[0].tags #=> Array + # resp.integrations[0].tags[0].key #=> String + # resp.integrations[0].tags[0].value #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeIntegrations AWS API Documentation + # + # @overload describe_integrations(params = {}) + # @param [Hash] params ({}) + def describe_integrations(params = {}, options = {}) + req = build_request(:describe_integrations, params) + req.send_request(options) + end + # Describes whether information, such as queries and connection # attempts, is being logged for the specified Amazon Redshift cluster. # @@ -7081,6 +7308,14 @@ def describe_table_restore_status(params = {}, options = {}) # # * 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][1] in the Amazon Redshift Cluster @@ -8580,8 +8815,8 @@ def modify_authentication_profile(params = {}, options = {}) # in Amazon Redshift][1] in the *Amazon Redshift Cluster Management # Guide*. # - # Valid Values: `dc2.large` \| `dc2.8xlarge` \| `ra3.xlplus` \| - # `ra3.4xlarge` \| `ra3.16xlarge` + # Valid Values: `dc2.large` \| `dc2.8xlarge` \| `ra3.large` \| + # `ra3.xlplus` \| `ra3.4xlarge` \| `ra3.16xlarge` # # # @@ -9996,6 +10231,67 @@ def modify_event_subscription(params = {}, options = {}) req.send_request(options) end + # Modifies a zero-ETL integration with Amazon Redshift. + # + # @option params [required, String] :integration_arn + # The unique identifier of the integration to modify. + # + # @option params [String] :description + # A new description for the integration. + # + # @option params [String] :integration_name + # A new name for the integration. + # + # @return [Types::Integration] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::Integration#integration_arn #integration_arn} => String + # * {Types::Integration#integration_name #integration_name} => String + # * {Types::Integration#source_arn #source_arn} => String + # * {Types::Integration#target_arn #target_arn} => String + # * {Types::Integration#status #status} => String + # * {Types::Integration#errors #errors} => Array<Types::IntegrationError> + # * {Types::Integration#create_time #create_time} => Time + # * {Types::Integration#description #description} => String + # * {Types::Integration#kms_key_id #kms_key_id} => String + # * {Types::Integration#additional_encryption_context #additional_encryption_context} => Hash<String,String> + # * {Types::Integration#tags #tags} => Array<Types::Tag> + # + # @example Request syntax with placeholder values + # + # resp = client.modify_integration({ + # integration_arn: "IntegrationArn", # required + # description: "IntegrationDescription", + # integration_name: "IntegrationName", + # }) + # + # @example Response structure + # + # resp.integration_arn #=> String + # resp.integration_name #=> String + # resp.source_arn #=> String + # resp.target_arn #=> String + # resp.status #=> String, one of "creating", "active", "modifying", "failed", "deleting", "syncing", "needs_attention" + # resp.errors #=> Array + # resp.errors[0].error_code #=> String + # resp.errors[0].error_message #=> String + # resp.create_time #=> Time + # resp.description #=> String + # resp.kms_key_id #=> String + # resp.additional_encryption_context #=> Hash + # resp.additional_encryption_context["String"] #=> String + # resp.tags #=> Array + # resp.tags[0].key #=> String + # resp.tags[0].value #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyIntegration AWS API Documentation + # + # @overload modify_integration(params = {}) + # @param [Hash] params ({}) + def modify_integration(params = {}, options = {}) + req = build_request(:modify_integration, params) + req.send_request(options) + end + # Changes an existing Amazon Redshift IAM Identity Center application. # # @option params [required, String] :redshift_idc_application_arn @@ -11033,6 +11329,8 @@ def reset_cluster_parameter_group(params = {}, options = {}) # # * dc2.8xlarge # + # * ra3.large + # # * ra3.xlplus # # * ra3.4xlarge @@ -12433,7 +12731,7 @@ def build_request(operation_name, params = {}) tracer: tracer ) context[:gem_name] = 'aws-sdk-redshift' - context[:gem_version] = '1.126.0' + context[:gem_version] = '1.127.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-redshift/lib/aws-sdk-redshift/client_api.rb b/gems/aws-sdk-redshift/lib/aws-sdk-redshift/client_api.rb index c54429a1831..7e5375b7451 100644 --- a/gems/aws-sdk-redshift/lib/aws-sdk-redshift/client_api.rb +++ b/gems/aws-sdk-redshift/lib/aws-sdk-redshift/client_api.rb @@ -145,6 +145,7 @@ module ClientApi CreateHsmClientCertificateResult = Shapes::StructureShape.new(name: 'CreateHsmClientCertificateResult') CreateHsmConfigurationMessage = Shapes::StructureShape.new(name: 'CreateHsmConfigurationMessage') CreateHsmConfigurationResult = Shapes::StructureShape.new(name: 'CreateHsmConfigurationResult') + CreateIntegrationMessage = Shapes::StructureShape.new(name: 'CreateIntegrationMessage') CreateRedshiftIdcApplicationMessage = Shapes::StructureShape.new(name: 'CreateRedshiftIdcApplicationMessage') CreateRedshiftIdcApplicationResult = Shapes::StructureShape.new(name: 'CreateRedshiftIdcApplicationResult') CreateScheduledActionMessage = Shapes::StructureShape.new(name: 'CreateScheduledActionMessage') @@ -187,6 +188,7 @@ module ClientApi DeleteEventSubscriptionMessage = Shapes::StructureShape.new(name: 'DeleteEventSubscriptionMessage') DeleteHsmClientCertificateMessage = Shapes::StructureShape.new(name: 'DeleteHsmClientCertificateMessage') DeleteHsmConfigurationMessage = Shapes::StructureShape.new(name: 'DeleteHsmConfigurationMessage') + DeleteIntegrationMessage = Shapes::StructureShape.new(name: 'DeleteIntegrationMessage') DeleteRedshiftIdcApplicationMessage = Shapes::StructureShape.new(name: 'DeleteRedshiftIdcApplicationMessage') DeleteResourcePolicyMessage = Shapes::StructureShape.new(name: 'DeleteResourcePolicyMessage') DeleteScheduledActionMessage = Shapes::StructureShape.new(name: 'DeleteScheduledActionMessage') @@ -226,6 +228,11 @@ module ClientApi DescribeHsmClientCertificatesMessage = Shapes::StructureShape.new(name: 'DescribeHsmClientCertificatesMessage') DescribeHsmConfigurationsMessage = Shapes::StructureShape.new(name: 'DescribeHsmConfigurationsMessage') DescribeInboundIntegrationsMessage = Shapes::StructureShape.new(name: 'DescribeInboundIntegrationsMessage') + DescribeIntegrationsFilter = Shapes::StructureShape.new(name: 'DescribeIntegrationsFilter') + DescribeIntegrationsFilterList = Shapes::ListShape.new(name: 'DescribeIntegrationsFilterList') + DescribeIntegrationsFilterName = Shapes::StringShape.new(name: 'DescribeIntegrationsFilterName') + DescribeIntegrationsFilterValueList = Shapes::ListShape.new(name: 'DescribeIntegrationsFilterValueList') + DescribeIntegrationsMessage = Shapes::StructureShape.new(name: 'DescribeIntegrationsMessage') DescribeLoggingStatusMessage = Shapes::StructureShape.new(name: 'DescribeLoggingStatusMessage') DescribeNodeConfigurationOptionsMessage = Shapes::StructureShape.new(name: 'DescribeNodeConfigurationOptionsMessage') DescribeOrderableClusterOptionsMessage = Shapes::StructureShape.new(name: 'DescribeOrderableClusterOptionsMessage') @@ -245,6 +252,7 @@ module ClientApi DescribeTableRestoreStatusMessage = Shapes::StructureShape.new(name: 'DescribeTableRestoreStatusMessage') DescribeTagsMessage = Shapes::StructureShape.new(name: 'DescribeTagsMessage') DescribeUsageLimitsMessage = Shapes::StructureShape.new(name: 'DescribeUsageLimitsMessage') + Description = Shapes::StringShape.new(name: 'Description') DisableLoggingMessage = Shapes::StructureShape.new(name: 'DisableLoggingMessage') DisableSnapshotCopyMessage = Shapes::StructureShape.new(name: 'DisableSnapshotCopyMessage') DisableSnapshotCopyResult = Shapes::StructureShape.new(name: 'DisableSnapshotCopyResult') @@ -258,6 +266,7 @@ module ClientApi EnableLoggingMessage = Shapes::StructureShape.new(name: 'EnableLoggingMessage') EnableSnapshotCopyMessage = Shapes::StructureShape.new(name: 'EnableSnapshotCopyMessage') EnableSnapshotCopyResult = Shapes::StructureShape.new(name: 'EnableSnapshotCopyResult') + EncryptionContextMap = Shapes::MapShape.new(name: 'EncryptionContextMap') Endpoint = Shapes::StructureShape.new(name: 'Endpoint') EndpointAccess = Shapes::StructureShape.new(name: 'EndpointAccess') EndpointAccessList = Shapes::StructureShape.new(name: 'EndpointAccessList') @@ -326,9 +335,21 @@ module ClientApi InsufficientS3BucketPolicyFault = Shapes::StructureShape.new(name: 'InsufficientS3BucketPolicyFault', error: {"code"=>"InsufficientS3BucketPolicyFault", "httpStatusCode"=>400, "senderFault"=>true}) Integer = Shapes::IntegerShape.new(name: 'Integer') IntegerOptional = Shapes::IntegerShape.new(name: 'IntegerOptional') + Integration = Shapes::StructureShape.new(name: 'Integration') + IntegrationAlreadyExistsFault = Shapes::StructureShape.new(name: 'IntegrationAlreadyExistsFault', error: {"code"=>"IntegrationAlreadyExistsFault", "httpStatusCode"=>400, "senderFault"=>true}) + IntegrationArn = Shapes::StringShape.new(name: 'IntegrationArn') + IntegrationConflictOperationFault = Shapes::StructureShape.new(name: 'IntegrationConflictOperationFault', error: {"code"=>"IntegrationConflictOperationFault", "httpStatusCode"=>400, "senderFault"=>true}) + IntegrationConflictStateFault = Shapes::StructureShape.new(name: 'IntegrationConflictStateFault', error: {"code"=>"IntegrationConflictStateFault", "httpStatusCode"=>400, "senderFault"=>true}) + IntegrationDescription = Shapes::StringShape.new(name: 'IntegrationDescription') IntegrationError = Shapes::StructureShape.new(name: 'IntegrationError') IntegrationErrorList = Shapes::ListShape.new(name: 'IntegrationErrorList') + IntegrationList = Shapes::ListShape.new(name: 'IntegrationList') + IntegrationName = Shapes::StringShape.new(name: 'IntegrationName') IntegrationNotFoundFault = Shapes::StructureShape.new(name: 'IntegrationNotFoundFault', error: {"code"=>"IntegrationNotFoundFault", "httpStatusCode"=>404, "senderFault"=>true}) + IntegrationQuotaExceededFault = Shapes::StructureShape.new(name: 'IntegrationQuotaExceededFault', error: {"code"=>"IntegrationQuotaExceededFault", "httpStatusCode"=>400, "senderFault"=>true}) + IntegrationSourceNotFoundFault = Shapes::StructureShape.new(name: 'IntegrationSourceNotFoundFault', error: {"code"=>"IntegrationSourceNotFoundFault", "httpStatusCode"=>404, "senderFault"=>true}) + IntegrationTargetNotFoundFault = Shapes::StructureShape.new(name: 'IntegrationTargetNotFoundFault', error: {"code"=>"IntegrationTargetNotFoundFault", "httpStatusCode"=>404, "senderFault"=>true}) + IntegrationsMessage = Shapes::StructureShape.new(name: 'IntegrationsMessage') InvalidAuthenticationProfileRequestFault = Shapes::StructureShape.new(name: 'InvalidAuthenticationProfileRequestFault', error: {"code"=>"InvalidAuthenticationProfileRequestFault", "httpStatusCode"=>400, "senderFault"=>true}) InvalidAuthorizationStateFault = Shapes::StructureShape.new(name: 'InvalidAuthorizationStateFault', error: {"code"=>"InvalidAuthorizationState", "httpStatusCode"=>400, "senderFault"=>true}) InvalidClusterParameterGroupStateFault = Shapes::StructureShape.new(name: 'InvalidClusterParameterGroupStateFault', error: {"code"=>"InvalidClusterParameterGroupState", "httpStatusCode"=>400, "senderFault"=>true}) @@ -397,6 +418,7 @@ module ClientApi ModifyEndpointAccessMessage = Shapes::StructureShape.new(name: 'ModifyEndpointAccessMessage') ModifyEventSubscriptionMessage = Shapes::StructureShape.new(name: 'ModifyEventSubscriptionMessage') ModifyEventSubscriptionResult = Shapes::StructureShape.new(name: 'ModifyEventSubscriptionResult') + ModifyIntegrationMessage = Shapes::StructureShape.new(name: 'ModifyIntegrationMessage') ModifyRedshiftIdcApplicationMessage = Shapes::StructureShape.new(name: 'ModifyRedshiftIdcApplicationMessage') ModifyRedshiftIdcApplicationResult = Shapes::StructureShape.new(name: 'ModifyRedshiftIdcApplicationResult') ModifyScheduledActionMessage = Shapes::StructureShape.new(name: 'ModifyScheduledActionMessage') @@ -1138,6 +1160,15 @@ module ClientApi CreateHsmConfigurationResult.add_member(:hsm_configuration, Shapes::ShapeRef.new(shape: HsmConfiguration, location_name: "HsmConfiguration")) CreateHsmConfigurationResult.struct_class = Types::CreateHsmConfigurationResult + CreateIntegrationMessage.add_member(:source_arn, Shapes::ShapeRef.new(shape: String, required: true, location_name: "SourceArn")) + CreateIntegrationMessage.add_member(:target_arn, Shapes::ShapeRef.new(shape: String, required: true, location_name: "TargetArn")) + CreateIntegrationMessage.add_member(:integration_name, Shapes::ShapeRef.new(shape: IntegrationName, required: true, location_name: "IntegrationName")) + CreateIntegrationMessage.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: String, location_name: "KMSKeyId")) + CreateIntegrationMessage.add_member(:tag_list, Shapes::ShapeRef.new(shape: TagList, location_name: "TagList")) + CreateIntegrationMessage.add_member(:additional_encryption_context, Shapes::ShapeRef.new(shape: EncryptionContextMap, location_name: "AdditionalEncryptionContext")) + CreateIntegrationMessage.add_member(:description, Shapes::ShapeRef.new(shape: IntegrationDescription, location_name: "Description")) + CreateIntegrationMessage.struct_class = Types::CreateIntegrationMessage + CreateRedshiftIdcApplicationMessage.add_member(:idc_instance_arn, Shapes::ShapeRef.new(shape: String, required: true, location_name: "IdcInstanceArn")) CreateRedshiftIdcApplicationMessage.add_member(:redshift_idc_application_name, Shapes::ShapeRef.new(shape: RedshiftIdcApplicationName, required: true, location_name: "RedshiftIdcApplicationName")) CreateRedshiftIdcApplicationMessage.add_member(:identity_namespace, Shapes::ShapeRef.new(shape: IdentityNamespaceString, location_name: "IdentityNamespace")) @@ -1296,6 +1327,9 @@ module ClientApi DeleteHsmConfigurationMessage.add_member(:hsm_configuration_identifier, Shapes::ShapeRef.new(shape: String, required: true, location_name: "HsmConfigurationIdentifier")) DeleteHsmConfigurationMessage.struct_class = Types::DeleteHsmConfigurationMessage + DeleteIntegrationMessage.add_member(:integration_arn, Shapes::ShapeRef.new(shape: IntegrationArn, required: true, location_name: "IntegrationArn")) + DeleteIntegrationMessage.struct_class = Types::DeleteIntegrationMessage + DeleteRedshiftIdcApplicationMessage.add_member(:redshift_idc_application_arn, Shapes::ShapeRef.new(shape: String, required: true, location_name: "RedshiftIdcApplicationArn")) DeleteRedshiftIdcApplicationMessage.struct_class = Types::DeleteRedshiftIdcApplicationMessage @@ -1495,6 +1529,20 @@ module ClientApi DescribeInboundIntegrationsMessage.add_member(:marker, Shapes::ShapeRef.new(shape: String, location_name: "Marker")) DescribeInboundIntegrationsMessage.struct_class = Types::DescribeInboundIntegrationsMessage + DescribeIntegrationsFilter.add_member(:name, Shapes::ShapeRef.new(shape: DescribeIntegrationsFilterName, required: true, location_name: "Name")) + DescribeIntegrationsFilter.add_member(:values, Shapes::ShapeRef.new(shape: DescribeIntegrationsFilterValueList, required: true, location_name: "Values")) + DescribeIntegrationsFilter.struct_class = Types::DescribeIntegrationsFilter + + DescribeIntegrationsFilterList.member = Shapes::ShapeRef.new(shape: DescribeIntegrationsFilter, location_name: "DescribeIntegrationsFilter") + + DescribeIntegrationsFilterValueList.member = Shapes::ShapeRef.new(shape: String, location_name: "Value") + + DescribeIntegrationsMessage.add_member(:integration_arn, Shapes::ShapeRef.new(shape: IntegrationArn, location_name: "IntegrationArn")) + DescribeIntegrationsMessage.add_member(:max_records, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "MaxRecords")) + DescribeIntegrationsMessage.add_member(:marker, Shapes::ShapeRef.new(shape: String, location_name: "Marker")) + DescribeIntegrationsMessage.add_member(:filters, Shapes::ShapeRef.new(shape: DescribeIntegrationsFilterList, location_name: "Filters")) + DescribeIntegrationsMessage.struct_class = Types::DescribeIntegrationsMessage + DescribeLoggingStatusMessage.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: String, required: true, location_name: "ClusterIdentifier")) DescribeLoggingStatusMessage.struct_class = Types::DescribeLoggingStatusMessage @@ -1653,6 +1701,9 @@ module ClientApi EnableSnapshotCopyResult.add_member(:cluster, Shapes::ShapeRef.new(shape: Cluster, location_name: "Cluster")) EnableSnapshotCopyResult.struct_class = Types::EnableSnapshotCopyResult + EncryptionContextMap.key = Shapes::ShapeRef.new(shape: String) + EncryptionContextMap.value = Shapes::ShapeRef.new(shape: String) + Endpoint.add_member(:address, Shapes::ShapeRef.new(shape: String, location_name: "Address")) Endpoint.add_member(:port, Shapes::ShapeRef.new(shape: Integer, location_name: "Port")) Endpoint.add_member(:vpc_endpoints, Shapes::ShapeRef.new(shape: VpcEndpointsList, location_name: "VpcEndpoints")) @@ -1887,14 +1938,45 @@ module ClientApi InsufficientS3BucketPolicyFault.struct_class = Types::InsufficientS3BucketPolicyFault + Integration.add_member(:integration_arn, Shapes::ShapeRef.new(shape: String, location_name: "IntegrationArn")) + Integration.add_member(:integration_name, Shapes::ShapeRef.new(shape: IntegrationName, location_name: "IntegrationName")) + Integration.add_member(:source_arn, Shapes::ShapeRef.new(shape: String, location_name: "SourceArn")) + Integration.add_member(:target_arn, Shapes::ShapeRef.new(shape: String, location_name: "TargetArn")) + Integration.add_member(:status, Shapes::ShapeRef.new(shape: ZeroETLIntegrationStatus, location_name: "Status")) + Integration.add_member(:errors, Shapes::ShapeRef.new(shape: IntegrationErrorList, location_name: "Errors")) + Integration.add_member(:create_time, Shapes::ShapeRef.new(shape: TStamp, location_name: "CreateTime")) + Integration.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description")) + Integration.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: String, location_name: "KMSKeyId")) + Integration.add_member(:additional_encryption_context, Shapes::ShapeRef.new(shape: EncryptionContextMap, location_name: "AdditionalEncryptionContext")) + Integration.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags")) + Integration.struct_class = Types::Integration + + IntegrationAlreadyExistsFault.struct_class = Types::IntegrationAlreadyExistsFault + + IntegrationConflictOperationFault.struct_class = Types::IntegrationConflictOperationFault + + IntegrationConflictStateFault.struct_class = Types::IntegrationConflictStateFault + IntegrationError.add_member(:error_code, Shapes::ShapeRef.new(shape: String, required: true, location_name: "ErrorCode")) IntegrationError.add_member(:error_message, Shapes::ShapeRef.new(shape: String, location_name: "ErrorMessage")) IntegrationError.struct_class = Types::IntegrationError IntegrationErrorList.member = Shapes::ShapeRef.new(shape: IntegrationError, location_name: "IntegrationError") + IntegrationList.member = Shapes::ShapeRef.new(shape: Integration, location_name: "Integration") + IntegrationNotFoundFault.struct_class = Types::IntegrationNotFoundFault + IntegrationQuotaExceededFault.struct_class = Types::IntegrationQuotaExceededFault + + IntegrationSourceNotFoundFault.struct_class = Types::IntegrationSourceNotFoundFault + + IntegrationTargetNotFoundFault.struct_class = Types::IntegrationTargetNotFoundFault + + IntegrationsMessage.add_member(:marker, Shapes::ShapeRef.new(shape: String, location_name: "Marker")) + IntegrationsMessage.add_member(:integrations, Shapes::ShapeRef.new(shape: IntegrationList, location_name: "Integrations")) + IntegrationsMessage.struct_class = Types::IntegrationsMessage + InvalidAuthenticationProfileRequestFault.struct_class = Types::InvalidAuthenticationProfileRequestFault InvalidAuthorizationStateFault.struct_class = Types::InvalidAuthorizationStateFault @@ -2127,6 +2209,11 @@ module ClientApi ModifyEventSubscriptionResult.add_member(:event_subscription, Shapes::ShapeRef.new(shape: EventSubscription, location_name: "EventSubscription")) ModifyEventSubscriptionResult.struct_class = Types::ModifyEventSubscriptionResult + ModifyIntegrationMessage.add_member(:integration_arn, Shapes::ShapeRef.new(shape: IntegrationArn, required: true, location_name: "IntegrationArn")) + ModifyIntegrationMessage.add_member(:description, Shapes::ShapeRef.new(shape: IntegrationDescription, location_name: "Description")) + ModifyIntegrationMessage.add_member(:integration_name, Shapes::ShapeRef.new(shape: IntegrationName, location_name: "IntegrationName")) + ModifyIntegrationMessage.struct_class = Types::ModifyIntegrationMessage + ModifyRedshiftIdcApplicationMessage.add_member(:redshift_idc_application_arn, Shapes::ShapeRef.new(shape: String, required: true, location_name: "RedshiftIdcApplicationArn")) ModifyRedshiftIdcApplicationMessage.add_member(:identity_namespace, Shapes::ShapeRef.new(shape: IdentityNamespaceString, location_name: "IdentityNamespace")) ModifyRedshiftIdcApplicationMessage.add_member(:iam_role_arn, Shapes::ShapeRef.new(shape: String, location_name: "IamRoleArn")) @@ -3209,6 +3296,23 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: InvalidTagFault) end) + api.add_operation(:create_integration, Seahorse::Model::Operation.new.tap do |o| + o.name = "CreateIntegration" + o.http_method = "POST" + o.http_request_uri = "/" + o.input = Shapes::ShapeRef.new(shape: CreateIntegrationMessage) + o.output = Shapes::ShapeRef.new(shape: Integration) + o.errors << Shapes::ShapeRef.new(shape: IntegrationAlreadyExistsFault) + o.errors << Shapes::ShapeRef.new(shape: IntegrationConflictOperationFault) + o.errors << Shapes::ShapeRef.new(shape: IntegrationQuotaExceededFault) + o.errors << Shapes::ShapeRef.new(shape: IntegrationSourceNotFoundFault) + o.errors << Shapes::ShapeRef.new(shape: IntegrationTargetNotFoundFault) + o.errors << Shapes::ShapeRef.new(shape: UnsupportedOperationFault) + o.errors << Shapes::ShapeRef.new(shape: InvalidClusterStateFault) + o.errors << Shapes::ShapeRef.new(shape: TagLimitExceededFault) + o.errors << Shapes::ShapeRef.new(shape: InvalidTagFault) + end) + api.add_operation(:create_redshift_idc_application, Seahorse::Model::Operation.new.tap do |o| o.name = "CreateRedshiftIdcApplication" o.http_method = "POST" @@ -3421,6 +3525,18 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: HsmConfigurationNotFoundFault) end) + api.add_operation(:delete_integration, Seahorse::Model::Operation.new.tap do |o| + o.name = "DeleteIntegration" + o.http_method = "POST" + o.http_request_uri = "/" + o.input = Shapes::ShapeRef.new(shape: DeleteIntegrationMessage) + o.output = Shapes::ShapeRef.new(shape: Integration) + o.errors << Shapes::ShapeRef.new(shape: IntegrationNotFoundFault) + o.errors << Shapes::ShapeRef.new(shape: IntegrationConflictStateFault) + o.errors << Shapes::ShapeRef.new(shape: IntegrationConflictOperationFault) + o.errors << Shapes::ShapeRef.new(shape: UnsupportedOperationFault) + end) + api.add_operation(:delete_partner, Seahorse::Model::Operation.new.tap do |o| o.name = "DeletePartner" o.http_method = "POST" @@ -3861,6 +3977,22 @@ module ClientApi ) end) + api.add_operation(:describe_integrations, Seahorse::Model::Operation.new.tap do |o| + o.name = "DescribeIntegrations" + o.http_method = "POST" + o.http_request_uri = "/" + o.input = Shapes::ShapeRef.new(shape: DescribeIntegrationsMessage) + o.output = Shapes::ShapeRef.new(shape: IntegrationsMessage) + o.errors << Shapes::ShapeRef.new(shape: IntegrationNotFoundFault) + o.errors << Shapes::ShapeRef.new(shape: UnsupportedOperationFault) + o[:pager] = Aws::Pager.new( + limit_key: "max_records", + tokens: { + "marker" => "marker" + } + ) + end) + api.add_operation(:describe_logging_status, Seahorse::Model::Operation.new.tap do |o| o.name = "DescribeLoggingStatus" o.http_method = "POST" @@ -4438,6 +4570,19 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: InvalidSubscriptionStateFault) end) + api.add_operation(:modify_integration, Seahorse::Model::Operation.new.tap do |o| + o.name = "ModifyIntegration" + o.http_method = "POST" + o.http_request_uri = "/" + o.input = Shapes::ShapeRef.new(shape: ModifyIntegrationMessage) + o.output = Shapes::ShapeRef.new(shape: Integration) + o.errors << Shapes::ShapeRef.new(shape: IntegrationNotFoundFault) + o.errors << Shapes::ShapeRef.new(shape: IntegrationConflictStateFault) + o.errors << Shapes::ShapeRef.new(shape: IntegrationConflictOperationFault) + o.errors << Shapes::ShapeRef.new(shape: IntegrationAlreadyExistsFault) + o.errors << Shapes::ShapeRef.new(shape: UnsupportedOperationFault) + end) + api.add_operation(:modify_redshift_idc_application, Seahorse::Model::Operation.new.tap do |o| o.name = "ModifyRedshiftIdcApplication" o.http_method = "POST" diff --git a/gems/aws-sdk-redshift/lib/aws-sdk-redshift/endpoints.rb b/gems/aws-sdk-redshift/lib/aws-sdk-redshift/endpoints.rb index c55b5ba291a..fa20fd9392e 100644 --- a/gems/aws-sdk-redshift/lib/aws-sdk-redshift/endpoints.rb +++ b/gems/aws-sdk-redshift/lib/aws-sdk-redshift/endpoints.rb @@ -254,6 +254,17 @@ def self.build(context) end end + class CreateIntegration + def self.build(context) + Aws::Redshift::EndpointParameters.new( + region: context.config.region, + use_dual_stack: context.config.use_dualstack_endpoint, + use_fips: context.config.use_fips_endpoint, + endpoint: context.config.regional_endpoint ? nil : context.config.endpoint.to_s, + ) + end + end + class CreateRedshiftIdcApplication def self.build(context) Aws::Redshift::EndpointParameters.new( @@ -452,6 +463,17 @@ def self.build(context) end end + class DeleteIntegration + def self.build(context) + Aws::Redshift::EndpointParameters.new( + region: context.config.region, + use_dual_stack: context.config.use_dualstack_endpoint, + use_fips: context.config.use_fips_endpoint, + endpoint: context.config.regional_endpoint ? nil : context.config.endpoint.to_s, + ) + end + end + class DeletePartner def self.build(context) Aws::Redshift::EndpointParameters.new( @@ -804,6 +826,17 @@ def self.build(context) end end + class DescribeIntegrations + def self.build(context) + Aws::Redshift::EndpointParameters.new( + region: context.config.region, + use_dual_stack: context.config.use_dualstack_endpoint, + use_fips: context.config.use_fips_endpoint, + endpoint: context.config.regional_endpoint ? nil : context.config.endpoint.to_s, + ) + end + end + class DescribeLoggingStatus def self.build(context) Aws::Redshift::EndpointParameters.new( @@ -1255,6 +1288,17 @@ def self.build(context) end end + class ModifyIntegration + def self.build(context) + Aws::Redshift::EndpointParameters.new( + region: context.config.region, + use_dual_stack: context.config.use_dualstack_endpoint, + use_fips: context.config.use_fips_endpoint, + endpoint: context.config.regional_endpoint ? nil : context.config.endpoint.to_s, + ) + end + end + class ModifyRedshiftIdcApplication def self.build(context) Aws::Redshift::EndpointParameters.new( diff --git a/gems/aws-sdk-redshift/lib/aws-sdk-redshift/errors.rb b/gems/aws-sdk-redshift/lib/aws-sdk-redshift/errors.rb index 6d35651b835..ee52bbf19aa 100644 --- a/gems/aws-sdk-redshift/lib/aws-sdk-redshift/errors.rb +++ b/gems/aws-sdk-redshift/lib/aws-sdk-redshift/errors.rb @@ -80,7 +80,13 @@ module Aws::Redshift # * {IncompatibleOrderableOptions} # * {InsufficientClusterCapacityFault} # * {InsufficientS3BucketPolicyFault} + # * {IntegrationAlreadyExistsFault} + # * {IntegrationConflictOperationFault} + # * {IntegrationConflictStateFault} # * {IntegrationNotFoundFault} + # * {IntegrationQuotaExceededFault} + # * {IntegrationSourceNotFoundFault} + # * {IntegrationTargetNotFoundFault} # * {InvalidAuthenticationProfileRequestFault} # * {InvalidAuthorizationStateFault} # * {InvalidClusterParameterGroupStateFault} @@ -700,6 +706,36 @@ def initialize(context, message, data = Aws::EmptyStructure.new) end end + class IntegrationAlreadyExistsFault < ServiceError + + # @param [Seahorse::Client::RequestContext] context + # @param [String] message + # @param [Aws::Redshift::Types::IntegrationAlreadyExistsFault] data + def initialize(context, message, data = Aws::EmptyStructure.new) + super(context, message, data) + end + end + + class IntegrationConflictOperationFault < ServiceError + + # @param [Seahorse::Client::RequestContext] context + # @param [String] message + # @param [Aws::Redshift::Types::IntegrationConflictOperationFault] data + def initialize(context, message, data = Aws::EmptyStructure.new) + super(context, message, data) + end + end + + class IntegrationConflictStateFault < ServiceError + + # @param [Seahorse::Client::RequestContext] context + # @param [String] message + # @param [Aws::Redshift::Types::IntegrationConflictStateFault] data + def initialize(context, message, data = Aws::EmptyStructure.new) + super(context, message, data) + end + end + class IntegrationNotFoundFault < ServiceError # @param [Seahorse::Client::RequestContext] context @@ -710,6 +746,36 @@ def initialize(context, message, data = Aws::EmptyStructure.new) end end + class IntegrationQuotaExceededFault < ServiceError + + # @param [Seahorse::Client::RequestContext] context + # @param [String] message + # @param [Aws::Redshift::Types::IntegrationQuotaExceededFault] data + def initialize(context, message, data = Aws::EmptyStructure.new) + super(context, message, data) + end + end + + class IntegrationSourceNotFoundFault < ServiceError + + # @param [Seahorse::Client::RequestContext] context + # @param [String] message + # @param [Aws::Redshift::Types::IntegrationSourceNotFoundFault] data + def initialize(context, message, data = Aws::EmptyStructure.new) + super(context, message, data) + end + end + + class IntegrationTargetNotFoundFault < ServiceError + + # @param [Seahorse::Client::RequestContext] context + # @param [String] message + # @param [Aws::Redshift::Types::IntegrationTargetNotFoundFault] data + def initialize(context, message, data = Aws::EmptyStructure.new) + super(context, message, data) + end + end + class InvalidAuthenticationProfileRequestFault < ServiceError # @param [Seahorse::Client::RequestContext] context diff --git a/gems/aws-sdk-redshift/lib/aws-sdk-redshift/plugins/endpoints.rb b/gems/aws-sdk-redshift/lib/aws-sdk-redshift/plugins/endpoints.rb index cc4d95af7d8..3a49c5318c6 100644 --- a/gems/aws-sdk-redshift/lib/aws-sdk-redshift/plugins/endpoints.rb +++ b/gems/aws-sdk-redshift/lib/aws-sdk-redshift/plugins/endpoints.rb @@ -114,6 +114,8 @@ def parameters_for_operation(context) Aws::Redshift::Endpoints::CreateHsmClientCertificate.build(context) when :create_hsm_configuration Aws::Redshift::Endpoints::CreateHsmConfiguration.build(context) + when :create_integration + Aws::Redshift::Endpoints::CreateIntegration.build(context) when :create_redshift_idc_application Aws::Redshift::Endpoints::CreateRedshiftIdcApplication.build(context) when :create_scheduled_action @@ -150,6 +152,8 @@ def parameters_for_operation(context) Aws::Redshift::Endpoints::DeleteHsmClientCertificate.build(context) when :delete_hsm_configuration Aws::Redshift::Endpoints::DeleteHsmConfiguration.build(context) + when :delete_integration + Aws::Redshift::Endpoints::DeleteIntegration.build(context) when :delete_partner Aws::Redshift::Endpoints::DeletePartner.build(context) when :delete_redshift_idc_application @@ -214,6 +218,8 @@ def parameters_for_operation(context) Aws::Redshift::Endpoints::DescribeHsmConfigurations.build(context) when :describe_inbound_integrations Aws::Redshift::Endpoints::DescribeInboundIntegrations.build(context) + when :describe_integrations + Aws::Redshift::Endpoints::DescribeIntegrations.build(context) when :describe_logging_status Aws::Redshift::Endpoints::DescribeLoggingStatus.build(context) when :describe_node_configuration_options @@ -296,6 +302,8 @@ def parameters_for_operation(context) Aws::Redshift::Endpoints::ModifyEndpointAccess.build(context) when :modify_event_subscription Aws::Redshift::Endpoints::ModifyEventSubscription.build(context) + when :modify_integration + Aws::Redshift::Endpoints::ModifyIntegration.build(context) when :modify_redshift_idc_application Aws::Redshift::Endpoints::ModifyRedshiftIdcApplication.build(context) when :modify_scheduled_action diff --git a/gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb b/gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb index 98301da95bf..7fe64e6f05c 100644 --- a/gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb +++ b/gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb @@ -1974,8 +1974,8 @@ class CreateAuthenticationProfileResult < Struct.new( # about node types, go to [ Working with Clusters][1] in the *Amazon # Redshift Cluster Management Guide*. # - # Valid Values: `dc2.large` \| `dc2.8xlarge` \| `ra3.xlplus` \| - # `ra3.4xlarge` \| `ra3.16xlarge` + # Valid Values: `dc2.large` \| `dc2.8xlarge` \| `ra3.large` \| + # `ra3.xlplus` \| `ra3.4xlarge` \| `ra3.16xlarge` # # # @@ -2894,6 +2894,62 @@ class CreateHsmConfigurationResult < Struct.new( include Aws::Structure end + # @!attribute [rw] source_arn + # The Amazon Resource Name (ARN) of the database to use as the source + # for replication. + # @return [String] + # + # @!attribute [rw] target_arn + # The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse + # to use as the target for replication. + # @return [String] + # + # @!attribute [rw] integration_name + # The name of the integration. + # @return [String] + # + # @!attribute [rw] kms_key_id + # 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. + # @return [String] + # + # @!attribute [rw] tag_list + # A list of tags. + # @return [Array] + # + # @!attribute [rw] additional_encryption_context + # An optional set of non-secret key–value pairs that contains + # additional contextual information about the data. For more + # information, see [Encryption context][1] in the *Amazon Web Services + # Key Management Service Developer Guide*. + # + # You can only include this parameter if you specify the `KMSKeyId` + # parameter. + # + # + # + # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context + # @return [Hash] + # + # @!attribute [rw] description + # A description of the integration. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateIntegrationMessage AWS API Documentation + # + class CreateIntegrationMessage < Struct.new( + :source_arn, + :target_arn, + :integration_name, + :kms_key_id, + :tag_list, + :additional_encryption_context, + :description) + SENSITIVE = [] + include Aws::Structure + end + # @!attribute [rw] idc_instance_arn # The Amazon resource name (ARN) of the IAM Identity Center instance # where Amazon Redshift creates a new managed application. @@ -3690,6 +3746,18 @@ class DeleteHsmConfigurationMessage < Struct.new( include Aws::Structure end + # @!attribute [rw] integration_arn + # The unique identifier of the integration to delete. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeleteIntegrationMessage AWS API Documentation + # + class DeleteIntegrationMessage < Struct.new( + :integration_arn) + SENSITIVE = [] + include Aws::Structure + end + # @!attribute [rw] redshift_idc_application_arn # The ARN for a deleted Amazon Redshift IAM Identity Center # application. @@ -5103,6 +5171,63 @@ class DescribeInboundIntegrationsMessage < Struct.new( include Aws::Structure end + # A set of elements to filter the returned integrations. + # + # @!attribute [rw] name + # Specifies the type of integration filter. + # @return [String] + # + # @!attribute [rw] values + # Specifies the values to filter on. + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeIntegrationsFilter AWS API Documentation + # + class DescribeIntegrationsFilter < Struct.new( + :name, + :values) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] integration_arn + # The unique identifier of the integration. + # @return [String] + # + # @!attribute [rw] max_records + # 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. + # @return [Integer] + # + # @!attribute [rw] marker + # 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`. + # @return [String] + # + # @!attribute [rw] filters + # A filter that specifies one or more resources to return. + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeIntegrationsMessage AWS API Documentation + # + class DescribeIntegrationsMessage < Struct.new( + :integration_arn, + :max_records, + :marker, + :filters) + SENSITIVE = [] + include Aws::Structure + end + # @!attribute [rw] cluster_identifier # The identifier of the cluster from which to get the logging status. # @@ -5741,6 +5866,14 @@ class DescribeTableRestoreStatusMessage < Struct.new( # # * 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][1] in the Amazon Redshift @@ -7224,6 +7357,99 @@ class InsufficientClusterCapacityFault < Aws::EmptyStructure; end # class InsufficientS3BucketPolicyFault < Aws::EmptyStructure; end + # @!attribute [rw] integration_arn + # The Amazon Resource Name (ARN) of the integration. + # @return [String] + # + # @!attribute [rw] integration_name + # The name of the integration. + # @return [String] + # + # @!attribute [rw] source_arn + # The Amazon Resource Name (ARN) of the database used as the source + # for replication. + # @return [String] + # + # @!attribute [rw] target_arn + # The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse + # to use as the target for replication. + # @return [String] + # + # @!attribute [rw] status + # The current status of the integration. + # @return [String] + # + # @!attribute [rw] errors + # Any errors associated with the integration. + # @return [Array] + # + # @!attribute [rw] create_time + # The time (UTC) when the integration was created. + # @return [Time] + # + # @!attribute [rw] description + # The description of the integration. + # @return [String] + # + # @!attribute [rw] kms_key_id + # The Key Management Service (KMS) key identifier for the key used to + # encrypt the integration. + # @return [String] + # + # @!attribute [rw] additional_encryption_context + # The encryption context for the integration. For more information, + # see [Encryption context][1] in the *Amazon Web Services Key + # Management Service Developer Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context + # @return [Hash] + # + # @!attribute [rw] tags + # The list of tags associated with the integration. + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/Integration AWS API Documentation + # + class Integration < Struct.new( + :integration_arn, + :integration_name, + :source_arn, + :target_arn, + :status, + :errors, + :create_time, + :description, + :kms_key_id, + :additional_encryption_context, + :tags) + SENSITIVE = [] + include Aws::Structure + end + + # The integration you are trying to create already exists. + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/IntegrationAlreadyExistsFault AWS API Documentation + # + class IntegrationAlreadyExistsFault < Aws::EmptyStructure; end + + # 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. + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/IntegrationConflictOperationFault AWS API Documentation + # + class IntegrationConflictOperationFault < Aws::EmptyStructure; end + + # The integration is in an invalid state and can't perform the + # requested operation. + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/IntegrationConflictStateFault AWS API Documentation + # + class IntegrationConflictStateFault < Aws::EmptyStructure; end + # The error of an inbound integration. # # @!attribute [rw] error_code @@ -7249,6 +7475,47 @@ class IntegrationError < Struct.new( # class IntegrationNotFoundFault < Aws::EmptyStructure; end + # You can't create any more zero-ETL integrations because the quota has + # been reached. + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/IntegrationQuotaExceededFault AWS API Documentation + # + class IntegrationQuotaExceededFault < Aws::EmptyStructure; end + + # The specified integration source can't be found. + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/IntegrationSourceNotFoundFault AWS API Documentation + # + class IntegrationSourceNotFoundFault < Aws::EmptyStructure; end + + # The specified integration target can't be found. + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/IntegrationTargetNotFoundFault AWS API Documentation + # + class IntegrationTargetNotFoundFault < Aws::EmptyStructure; end + + # @!attribute [rw] marker + # 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. + # @return [String] + # + # @!attribute [rw] integrations + # List of integrations that are described. + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/IntegrationsMessage AWS API Documentation + # + class IntegrationsMessage < Struct.new( + :marker, + :integrations) + SENSITIVE = [] + include Aws::Structure + end + # The authentication profile request is not valid. The profile name # can't be null or empty. The authentication profile API operation must # be available in the Amazon Web Services Region. @@ -7884,8 +8151,8 @@ class ModifyClusterMaintenanceResult < Struct.new( # Clusters in Amazon Redshift][1] in the *Amazon Redshift Cluster # Management Guide*. # - # Valid Values: `dc2.large` \| `dc2.8xlarge` \| `ra3.xlplus` \| - # `ra3.4xlarge` \| `ra3.16xlarge` + # Valid Values: `dc2.large` \| `dc2.8xlarge` \| `ra3.large` \| + # `ra3.xlplus` \| `ra3.4xlarge` \| `ra3.16xlarge` # # # @@ -8514,6 +8781,28 @@ class ModifyEventSubscriptionResult < Struct.new( include Aws::Structure end + # @!attribute [rw] integration_arn + # The unique identifier of the integration to modify. + # @return [String] + # + # @!attribute [rw] description + # A new description for the integration. + # @return [String] + # + # @!attribute [rw] integration_name + # A new name for the integration. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyIntegrationMessage AWS API Documentation + # + class ModifyIntegrationMessage < Struct.new( + :integration_arn, + :description, + :integration_name) + SENSITIVE = [] + include Aws::Structure + end + # @!attribute [rw] redshift_idc_application_arn # The ARN for the Redshift application that integrates with IAM # Identity Center. diff --git a/gems/aws-sdk-redshift/sig/client.rbs b/gems/aws-sdk-redshift/sig/client.rbs index f81f9535657..9b7a30773bf 100644 --- a/gems/aws-sdk-redshift/sig/client.rbs +++ b/gems/aws-sdk-redshift/sig/client.rbs @@ -480,6 +480,37 @@ module Aws ) -> _CreateHsmConfigurationResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateHsmConfigurationResponseSuccess + interface _CreateIntegrationResponseSuccess + include ::Seahorse::Client::_ResponseSuccess[Types::Integration] + def integration_arn: () -> ::String + def integration_name: () -> ::String + def source_arn: () -> ::String + def target_arn: () -> ::String + def status: () -> ("creating" | "active" | "modifying" | "failed" | "deleting" | "syncing" | "needs_attention") + def errors: () -> ::Array[Types::IntegrationError] + def create_time: () -> ::Time + def description: () -> ::String + def kms_key_id: () -> ::String + def additional_encryption_context: () -> ::Hash[::String, ::String] + def tags: () -> ::Array[Types::Tag] + end + # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Redshift/Client.html#create_integration-instance_method + def create_integration: ( + source_arn: ::String, + target_arn: ::String, + integration_name: ::String, + ?kms_key_id: ::String, + ?tag_list: Array[ + { + key: ::String?, + value: ::String? + }, + ], + ?additional_encryption_context: Hash[::String, ::String], + ?description: ::String + ) -> _CreateIntegrationResponseSuccess + | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateIntegrationResponseSuccess + interface _CreateRedshiftIdcApplicationResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::CreateRedshiftIdcApplicationResult] def redshift_idc_application: () -> Types::RedshiftIdcApplication @@ -746,6 +777,26 @@ module Aws ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure] | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure] + interface _DeleteIntegrationResponseSuccess + include ::Seahorse::Client::_ResponseSuccess[Types::Integration] + def integration_arn: () -> ::String + def integration_name: () -> ::String + def source_arn: () -> ::String + def target_arn: () -> ::String + def status: () -> ("creating" | "active" | "modifying" | "failed" | "deleting" | "syncing" | "needs_attention") + def errors: () -> ::Array[Types::IntegrationError] + def create_time: () -> ::Time + def description: () -> ::String + def kms_key_id: () -> ::String + def additional_encryption_context: () -> ::Hash[::String, ::String] + def tags: () -> ::Array[Types::Tag] + end + # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Redshift/Client.html#delete_integration-instance_method + def delete_integration: ( + integration_arn: ::String + ) -> _DeleteIntegrationResponseSuccess + | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteIntegrationResponseSuccess + interface _DeletePartnerResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::PartnerIntegrationOutputMessage] def database_name: () -> ::String @@ -1149,6 +1200,25 @@ module Aws ) -> _DescribeInboundIntegrationsResponseSuccess | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeInboundIntegrationsResponseSuccess + interface _DescribeIntegrationsResponseSuccess + include ::Seahorse::Client::_ResponseSuccess[Types::IntegrationsMessage] + def marker: () -> ::String + def integrations: () -> ::Array[Types::Integration] + end + # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Redshift/Client.html#describe_integrations-instance_method + def describe_integrations: ( + ?integration_arn: ::String, + ?max_records: ::Integer, + ?marker: ::String, + ?filters: Array[ + { + name: ("integration-arn" | "source-arn" | "source-types" | "status"), + values: Array[::String] + }, + ] + ) -> _DescribeIntegrationsResponseSuccess + | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeIntegrationsResponseSuccess + interface _DescribeLoggingStatusResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::LoggingStatus] def logging_enabled: () -> bool @@ -1787,6 +1857,28 @@ module Aws ) -> _ModifyEventSubscriptionResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ModifyEventSubscriptionResponseSuccess + interface _ModifyIntegrationResponseSuccess + include ::Seahorse::Client::_ResponseSuccess[Types::Integration] + def integration_arn: () -> ::String + def integration_name: () -> ::String + def source_arn: () -> ::String + def target_arn: () -> ::String + def status: () -> ("creating" | "active" | "modifying" | "failed" | "deleting" | "syncing" | "needs_attention") + def errors: () -> ::Array[Types::IntegrationError] + def create_time: () -> ::Time + def description: () -> ::String + def kms_key_id: () -> ::String + def additional_encryption_context: () -> ::Hash[::String, ::String] + def tags: () -> ::Array[Types::Tag] + end + # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Redshift/Client.html#modify_integration-instance_method + def modify_integration: ( + integration_arn: ::String, + ?description: ::String, + ?integration_name: ::String + ) -> _ModifyIntegrationResponseSuccess + | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ModifyIntegrationResponseSuccess + interface _ModifyRedshiftIdcApplicationResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::ModifyRedshiftIdcApplicationResult] def redshift_idc_application: () -> Types::RedshiftIdcApplication diff --git a/gems/aws-sdk-redshift/sig/errors.rbs b/gems/aws-sdk-redshift/sig/errors.rbs index 3ec36f7c975..633d85940ee 100644 --- a/gems/aws-sdk-redshift/sig/errors.rbs +++ b/gems/aws-sdk-redshift/sig/errors.rbs @@ -117,8 +117,20 @@ module Aws end class InsufficientS3BucketPolicyFault < ::Aws::Errors::ServiceError end + class IntegrationAlreadyExistsFault < ::Aws::Errors::ServiceError + end + class IntegrationConflictOperationFault < ::Aws::Errors::ServiceError + end + class IntegrationConflictStateFault < ::Aws::Errors::ServiceError + end class IntegrationNotFoundFault < ::Aws::Errors::ServiceError end + class IntegrationQuotaExceededFault < ::Aws::Errors::ServiceError + end + class IntegrationSourceNotFoundFault < ::Aws::Errors::ServiceError + end + class IntegrationTargetNotFoundFault < ::Aws::Errors::ServiceError + end class InvalidAuthenticationProfileRequestFault < ::Aws::Errors::ServiceError end class InvalidAuthorizationStateFault < ::Aws::Errors::ServiceError diff --git a/gems/aws-sdk-redshift/sig/types.rbs b/gems/aws-sdk-redshift/sig/types.rbs index f56c7653c8c..9af7534254b 100644 --- a/gems/aws-sdk-redshift/sig/types.rbs +++ b/gems/aws-sdk-redshift/sig/types.rbs @@ -655,6 +655,17 @@ module Aws::Redshift SENSITIVE: [] end + class CreateIntegrationMessage + attr_accessor source_arn: ::String + attr_accessor target_arn: ::String + attr_accessor integration_name: ::String + attr_accessor kms_key_id: ::String + attr_accessor tag_list: ::Array[Types::Tag] + attr_accessor additional_encryption_context: ::Hash[::String, ::String] + attr_accessor description: ::String + SENSITIVE: [] + end + class CreateRedshiftIdcApplicationMessage attr_accessor idc_instance_arn: ::String attr_accessor redshift_idc_application_name: ::String @@ -865,6 +876,11 @@ module Aws::Redshift SENSITIVE: [] end + class DeleteIntegrationMessage + attr_accessor integration_arn: ::String + SENSITIVE: [] + end + class DeleteRedshiftIdcApplicationMessage attr_accessor redshift_idc_application_arn: ::String SENSITIVE: [] @@ -1139,6 +1155,20 @@ module Aws::Redshift SENSITIVE: [] end + class DescribeIntegrationsFilter + attr_accessor name: ("integration-arn" | "source-arn" | "source-types" | "status") + attr_accessor values: ::Array[::String] + SENSITIVE: [] + end + + class DescribeIntegrationsMessage + attr_accessor integration_arn: ::String + attr_accessor max_records: ::Integer + attr_accessor marker: ::String + attr_accessor filters: ::Array[Types::DescribeIntegrationsFilter] + SENSITIVE: [] + end + class DescribeLoggingStatusMessage attr_accessor cluster_identifier: ::String SENSITIVE: [] @@ -1631,6 +1661,30 @@ module Aws::Redshift class InsufficientS3BucketPolicyFault < Aws::EmptyStructure end + class Integration + attr_accessor integration_arn: ::String + attr_accessor integration_name: ::String + attr_accessor source_arn: ::String + attr_accessor target_arn: ::String + attr_accessor status: ("creating" | "active" | "modifying" | "failed" | "deleting" | "syncing" | "needs_attention") + attr_accessor errors: ::Array[Types::IntegrationError] + attr_accessor create_time: ::Time + attr_accessor description: ::String + attr_accessor kms_key_id: ::String + attr_accessor additional_encryption_context: ::Hash[::String, ::String] + attr_accessor tags: ::Array[Types::Tag] + SENSITIVE: [] + end + + class IntegrationAlreadyExistsFault < Aws::EmptyStructure + end + + class IntegrationConflictOperationFault < Aws::EmptyStructure + end + + class IntegrationConflictStateFault < Aws::EmptyStructure + end + class IntegrationError attr_accessor error_code: ::String attr_accessor error_message: ::String @@ -1640,6 +1694,21 @@ module Aws::Redshift class IntegrationNotFoundFault < Aws::EmptyStructure end + class IntegrationQuotaExceededFault < Aws::EmptyStructure + end + + class IntegrationSourceNotFoundFault < Aws::EmptyStructure + end + + class IntegrationTargetNotFoundFault < Aws::EmptyStructure + end + + class IntegrationsMessage + attr_accessor marker: ::String + attr_accessor integrations: ::Array[Types::Integration] + SENSITIVE: [] + end + class InvalidAuthenticationProfileRequestFault < Aws::EmptyStructure end @@ -1962,6 +2031,13 @@ module Aws::Redshift SENSITIVE: [] end + class ModifyIntegrationMessage + attr_accessor integration_arn: ::String + attr_accessor description: ::String + attr_accessor integration_name: ::String + SENSITIVE: [] + end + class ModifyRedshiftIdcApplicationMessage attr_accessor redshift_idc_application_arn: ::String attr_accessor identity_namespace: ::String diff --git a/gems/aws-sdk-resiliencehub/CHANGELOG.md b/gems/aws-sdk-resiliencehub/CHANGELOG.md index cef7906e6e0..e612c01ee39 100644 --- a/gems/aws-sdk-resiliencehub/CHANGELOG.md +++ b/gems/aws-sdk-resiliencehub/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.40.0 (2024-10-15) +------------------ + +* Feature - AWS Resilience Hub now integrates with the myApplications platform, enabling customers to easily assess the resilience of applications defined in myApplications. The new Resiliency widget provides visibility into application resilience and actionable recommendations for improvement. + 1.39.0 (2024-09-24) ------------------ diff --git a/gems/aws-sdk-resiliencehub/VERSION b/gems/aws-sdk-resiliencehub/VERSION index 5edffce6d57..32b7211cb61 100644 --- a/gems/aws-sdk-resiliencehub/VERSION +++ b/gems/aws-sdk-resiliencehub/VERSION @@ -1 +1 @@ -1.39.0 +1.40.0 diff --git a/gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub.rb b/gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub.rb index 548dc10e74f..1beed2d46cb 100644 --- a/gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub.rb +++ b/gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub.rb @@ -54,7 +54,7 @@ module Plugins autoload :EndpointProvider, 'aws-sdk-resiliencehub/endpoint_provider' autoload :Endpoints, 'aws-sdk-resiliencehub/endpoints' - GEM_VERSION = '1.39.0' + GEM_VERSION = '1.40.0' end diff --git a/gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/client.rb b/gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/client.rb index 73fa77976b6..42308fccdcf 100644 --- a/gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/client.rb +++ b/gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/client.rb @@ -616,7 +616,7 @@ def add_draft_app_version_resource_mappings(params = {}, options = {}) # entry_id: "String255", # required # exclude_reason: "AlreadyImplemented", # accepts AlreadyImplemented, NotRelevant, ComplexityOfImplementation # excluded: false, # required - # item: { # required + # item: { # resource_id: "String500", # target_account_id: "CustomerId", # target_region: "AwsRegion", @@ -675,6 +675,16 @@ def batch_update_recommendation_status(params = {}, options = {}) # @option params [String] :assessment_schedule # Assessment execution schedule with 'Daily' or 'Disabled' values. # + # @option params [String] :aws_application_arn + # 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)][1] in the *Amazon Web Services General + # Reference* guide. + # + # + # + # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + # # @option params [String] :client_token # Used for an idempotency token. A client token is a unique, # case-sensitive string of up to 64 ASCII characters. You should not @@ -722,6 +732,7 @@ def batch_update_recommendation_status(params = {}, options = {}) # # resp = client.create_app({ # assessment_schedule: "Disabled", # accepts Disabled, Daily + # aws_application_arn: "Arn", # client_token: "ClientToken", # description: "EntityDescription", # event_subscriptions: [ @@ -747,6 +758,7 @@ def batch_update_recommendation_status(params = {}, options = {}) # # resp.app.app_arn #=> String # resp.app.assessment_schedule #=> String, one of "Disabled", "Daily" + # resp.app.aws_application_arn #=> String # resp.app.compliance_status #=> String, one of "PolicyBreached", "PolicyMet", "NotAssessed", "ChangesDetected", "NotApplicable", "MissingPolicy" # resp.app.creation_time #=> Time # resp.app.description #=> String @@ -1666,6 +1678,7 @@ def delete_resiliency_policy(params = {}, options = {}) # # resp.app.app_arn #=> String # resp.app.assessment_schedule #=> String, one of "Disabled", "Daily" + # resp.app.aws_application_arn #=> String # resp.app.compliance_status #=> String, one of "PolicyBreached", "PolicyMet", "NotAssessed", "ChangesDetected", "NotApplicable", "MissingPolicy" # resp.app.creation_time #=> Time # resp.app.description #=> String @@ -2120,6 +2133,7 @@ def describe_app_version_template(params = {}, options = {}) # # * {Types::DescribeDraftAppVersionResourcesImportStatusResponse#app_arn #app_arn} => String # * {Types::DescribeDraftAppVersionResourcesImportStatusResponse#app_version #app_version} => String + # * {Types::DescribeDraftAppVersionResourcesImportStatusResponse#error_details #error_details} => Array<Types::ErrorDetail> # * {Types::DescribeDraftAppVersionResourcesImportStatusResponse#error_message #error_message} => String # * {Types::DescribeDraftAppVersionResourcesImportStatusResponse#status #status} => String # * {Types::DescribeDraftAppVersionResourcesImportStatusResponse#status_change_time #status_change_time} => Time @@ -2134,6 +2148,8 @@ def describe_app_version_template(params = {}, options = {}) # # resp.app_arn #=> String # resp.app_version #=> String + # resp.error_details #=> Array + # resp.error_details[0].error_message #=> String # resp.error_message #=> String # resp.status #=> String, one of "Pending", "InProgress", "Failed", "Success" # resp.status_change_time #=> Time @@ -2395,8 +2411,8 @@ def list_alarm_recommendations(params = {}, options = {}) req.send_request(options) end - # List of compliance drifts that were detected while running an - # assessment. + # Indicates the list of compliance drifts that were detected while + # running an assessment. # # @option params [required, String] :assessment_arn # Amazon Resource Name (ARN) of the assessment. The format for this ARN @@ -3157,6 +3173,16 @@ def list_app_versions(params = {}, options = {}) # # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # + # @option params [String] :aws_application_arn + # 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)][1] in the *Amazon Web Services General + # Reference* guide. + # + # + # + # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + # # @option params [Time,DateTime,Date,Integer,String] :from_last_assessment_time # Indicates the lower limit of the range that is used to filter # applications based on their last assessment times. @@ -3194,6 +3220,7 @@ def list_app_versions(params = {}, options = {}) # # resp = client.list_apps({ # app_arn: "Arn", + # aws_application_arn: "Arn", # from_last_assessment_time: Time.now, # max_results: 1, # name: "EntityName", @@ -3207,6 +3234,7 @@ def list_app_versions(params = {}, options = {}) # resp.app_summaries #=> Array # resp.app_summaries[0].app_arn #=> String # resp.app_summaries[0].assessment_schedule #=> String, one of "Disabled", "Daily" + # resp.app_summaries[0].aws_application_arn #=> String # resp.app_summaries[0].compliance_status #=> String, one of "PolicyBreached", "PolicyMet", "NotAssessed", "ChangesDetected", "NotApplicable", "MissingPolicy" # resp.app_summaries[0].creation_time #=> Time # resp.app_summaries[0].description #=> String @@ -4520,6 +4548,7 @@ def untag_resource(params = {}, options = {}) # # resp.app.app_arn #=> String # resp.app.assessment_schedule #=> String, one of "Disabled", "Daily" + # resp.app.aws_application_arn #=> String # resp.app.compliance_status #=> String, one of "PolicyBreached", "PolicyMet", "NotAssessed", "ChangesDetected", "NotApplicable", "MissingPolicy" # resp.app.creation_time #=> Time # resp.app.description #=> String @@ -4930,7 +4959,7 @@ def build_request(operation_name, params = {}) tracer: tracer ) context[:gem_name] = 'aws-sdk-resiliencehub' - context[:gem_version] = '1.39.0' + context[:gem_version] = '1.40.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/client_api.rb b/gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/client_api.rb index 953ee2e7833..be23d111d35 100644 --- a/gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/client_api.rb +++ b/gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/client_api.rb @@ -143,6 +143,8 @@ module ClientApi EntityName255 = Shapes::StringShape.new(name: 'EntityName255') EntityNameList = Shapes::ListShape.new(name: 'EntityNameList') EntityVersion = Shapes::StringShape.new(name: 'EntityVersion') + ErrorDetail = Shapes::StructureShape.new(name: 'ErrorDetail') + ErrorDetailList = Shapes::ListShape.new(name: 'ErrorDetailList') ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage') EstimatedCostTier = Shapes::StringShape.new(name: 'EstimatedCostTier') EventSubscription = Shapes::StructureShape.new(name: 'EventSubscription') @@ -372,6 +374,7 @@ module ClientApi App.add_member(:app_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "appArn")) App.add_member(:assessment_schedule, Shapes::ShapeRef.new(shape: AppAssessmentScheduleType, location_name: "assessmentSchedule")) + App.add_member(:aws_application_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "awsApplicationArn")) App.add_member(:compliance_status, Shapes::ShapeRef.new(shape: AppComplianceStatusType, location_name: "complianceStatus")) App.add_member(:creation_time, Shapes::ShapeRef.new(shape: TimeStamp, required: true, location_name: "creationTime")) App.add_member(:description, Shapes::ShapeRef.new(shape: EntityDescription, location_name: "description")) @@ -459,6 +462,7 @@ module ClientApi AppSummary.add_member(:app_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "appArn")) AppSummary.add_member(:assessment_schedule, Shapes::ShapeRef.new(shape: AppAssessmentScheduleType, location_name: "assessmentSchedule")) + AppSummary.add_member(:aws_application_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "awsApplicationArn")) AppSummary.add_member(:compliance_status, Shapes::ShapeRef.new(shape: AppComplianceStatusType, location_name: "complianceStatus")) AppSummary.add_member(:creation_time, Shapes::ShapeRef.new(shape: TimeStamp, required: true, location_name: "creationTime")) AppSummary.add_member(:description, Shapes::ShapeRef.new(shape: EntityDescription, location_name: "description")) @@ -519,7 +523,7 @@ module ClientApi BatchUpdateRecommendationStatusSuccessfulEntry.add_member(:entry_id, Shapes::ShapeRef.new(shape: String255, required: true, location_name: "entryId")) BatchUpdateRecommendationStatusSuccessfulEntry.add_member(:exclude_reason, Shapes::ShapeRef.new(shape: ExcludeRecommendationReason, location_name: "excludeReason")) BatchUpdateRecommendationStatusSuccessfulEntry.add_member(:excluded, Shapes::ShapeRef.new(shape: BooleanOptional, required: true, location_name: "excluded")) - BatchUpdateRecommendationStatusSuccessfulEntry.add_member(:item, Shapes::ShapeRef.new(shape: UpdateRecommendationStatusItem, required: true, location_name: "item")) + BatchUpdateRecommendationStatusSuccessfulEntry.add_member(:item, Shapes::ShapeRef.new(shape: UpdateRecommendationStatusItem, location_name: "item")) BatchUpdateRecommendationStatusSuccessfulEntry.add_member(:reference_id, Shapes::ShapeRef.new(shape: SpecReferenceId, required: true, location_name: "referenceId")) BatchUpdateRecommendationStatusSuccessfulEntry.struct_class = Types::BatchUpdateRecommendationStatusSuccessfulEntry @@ -571,6 +575,7 @@ module ClientApi Cost.struct_class = Types::Cost CreateAppRequest.add_member(:assessment_schedule, Shapes::ShapeRef.new(shape: AppAssessmentScheduleType, location_name: "assessmentSchedule")) + CreateAppRequest.add_member(:aws_application_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "awsApplicationArn")) CreateAppRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true})) CreateAppRequest.add_member(:description, Shapes::ShapeRef.new(shape: EntityDescription, location_name: "description")) CreateAppRequest.add_member(:event_subscriptions, Shapes::ShapeRef.new(shape: EventSubscriptionList, location_name: "eventSubscriptions")) @@ -775,6 +780,7 @@ module ClientApi DescribeDraftAppVersionResourcesImportStatusResponse.add_member(:app_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "appArn")) DescribeDraftAppVersionResourcesImportStatusResponse.add_member(:app_version, Shapes::ShapeRef.new(shape: EntityVersion, required: true, location_name: "appVersion")) + DescribeDraftAppVersionResourcesImportStatusResponse.add_member(:error_details, Shapes::ShapeRef.new(shape: ErrorDetailList, location_name: "errorDetails")) DescribeDraftAppVersionResourcesImportStatusResponse.add_member(:error_message, Shapes::ShapeRef.new(shape: String500, location_name: "errorMessage")) DescribeDraftAppVersionResourcesImportStatusResponse.add_member(:status, Shapes::ShapeRef.new(shape: ResourceImportStatusType, required: true, location_name: "status")) DescribeDraftAppVersionResourcesImportStatusResponse.add_member(:status_change_time, Shapes::ShapeRef.new(shape: TimeStamp, required: true, location_name: "statusChangeTime")) @@ -827,6 +833,11 @@ module ClientApi EntityNameList.member = Shapes::ShapeRef.new(shape: EntityName) + ErrorDetail.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "errorMessage")) + ErrorDetail.struct_class = Types::ErrorDetail + + ErrorDetailList.member = Shapes::ShapeRef.new(shape: ErrorDetail) + EventSubscription.add_member(:event_type, Shapes::ShapeRef.new(shape: EventType, required: true, location_name: "eventType")) EventSubscription.add_member(:name, Shapes::ShapeRef.new(shape: String255, required: true, location_name: "name")) EventSubscription.add_member(:sns_topic_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "snsTopicArn")) @@ -1006,6 +1017,7 @@ module ClientApi ListAppVersionsResponse.struct_class = Types::ListAppVersionsResponse ListAppsRequest.add_member(:app_arn, Shapes::ShapeRef.new(shape: Arn, location: "querystring", location_name: "appArn")) + ListAppsRequest.add_member(:aws_application_arn, Shapes::ShapeRef.new(shape: Arn, location: "querystring", location_name: "awsApplicationArn")) ListAppsRequest.add_member(:from_last_assessment_time, Shapes::ShapeRef.new(shape: TimeStamp, location: "querystring", location_name: "fromLastAssessmentTime")) ListAppsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults")) ListAppsRequest.add_member(:name, Shapes::ShapeRef.new(shape: EntityName, location: "querystring", location_name: "name")) @@ -1444,7 +1456,7 @@ module ClientApi UpdateRecommendationStatusRequestEntry.add_member(:entry_id, Shapes::ShapeRef.new(shape: String255, required: true, location_name: "entryId")) UpdateRecommendationStatusRequestEntry.add_member(:exclude_reason, Shapes::ShapeRef.new(shape: ExcludeRecommendationReason, location_name: "excludeReason")) UpdateRecommendationStatusRequestEntry.add_member(:excluded, Shapes::ShapeRef.new(shape: BooleanOptional, required: true, location_name: "excluded")) - UpdateRecommendationStatusRequestEntry.add_member(:item, Shapes::ShapeRef.new(shape: UpdateRecommendationStatusItem, required: true, location_name: "item")) + UpdateRecommendationStatusRequestEntry.add_member(:item, Shapes::ShapeRef.new(shape: UpdateRecommendationStatusItem, location_name: "item")) UpdateRecommendationStatusRequestEntry.add_member(:reference_id, Shapes::ShapeRef.new(shape: SpecReferenceId, required: true, location_name: "referenceId")) UpdateRecommendationStatusRequestEntry.struct_class = Types::UpdateRecommendationStatusRequestEntry diff --git a/gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb b/gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb index 10e50ce9da2..2ba9e2492c1 100644 --- a/gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb +++ b/gems/aws-sdk-resiliencehub/lib/aws-sdk-resiliencehub/types.rb @@ -235,6 +235,17 @@ class AlarmRecommendation < Struct.new( # Assessment execution schedule with 'Daily' or 'Disabled' values. # @return [String] # + # @!attribute [rw] aws_application_arn + # 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)][1] in the *Amazon + # Web Services General Reference* guide. + # + # + # + # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + # @return [String] + # # @!attribute [rw] compliance_status # Current status of compliance for the resiliency policy. # @return [String] @@ -319,6 +330,7 @@ class AlarmRecommendation < Struct.new( class App < Struct.new( :app_arn, :assessment_schedule, + :aws_application_arn, :compliance_status, :creation_time, :description, @@ -424,8 +436,13 @@ class App < Struct.new( # @return [Time] # # @!attribute [rw] summary - # Indicates a concise summary that provides an overview of the - # Resilience Hub assessment. + # 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. + # + # # @return [Types::AssessmentSummary] # # @!attribute [rw] tags @@ -710,6 +727,17 @@ class AppInputSource < Struct.new( # Assessment execution schedule with 'Daily' or 'Disabled' values. # @return [String] # + # @!attribute [rw] aws_application_arn + # 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)][1] in the *Amazon + # Web Services General Reference* guide. + # + # + # + # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + # @return [String] + # # @!attribute [rw] compliance_status # The current status of compliance for the resiliency policy. # @return [String] @@ -756,6 +784,7 @@ class AppInputSource < Struct.new( class AppSummary < Struct.new( :app_arn, :assessment_schedule, + :aws_application_arn, :compliance_status, :creation_time, :description, @@ -1228,6 +1257,17 @@ class Cost < Struct.new( # Assessment execution schedule with 'Daily' or 'Disabled' values. # @return [String] # + # @!attribute [rw] aws_application_arn + # 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)][1] in the *Amazon + # Web Services General Reference* guide. + # + # + # + # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + # @return [String] + # # @!attribute [rw] client_token # Used for an idempotency token. A client token is a unique, # case-sensitive string of up to 64 ASCII characters. You should not @@ -1279,6 +1319,7 @@ class Cost < Struct.new( # class CreateAppRequest < Struct.new( :assessment_schedule, + :aws_application_arn, :client_token, :description, :event_subscriptions, @@ -2768,8 +2809,12 @@ class DescribeDraftAppVersionResourcesImportStatusRequest < Struct.new( # The version of the application. # @return [String] # + # @!attribute [rw] error_details + # List of errors that were encountered while importing resources. + # @return [Array] + # # @!attribute [rw] error_message - # The returned error message for the request. + # The error message returned for the resource request. # @return [String] # # @!attribute [rw] status @@ -2785,6 +2830,7 @@ class DescribeDraftAppVersionResourcesImportStatusRequest < Struct.new( class DescribeDraftAppVersionResourcesImportStatusResponse < Struct.new( :app_arn, :app_version, + :error_details, :error_message, :status, :status_change_time) @@ -2992,6 +3038,20 @@ class EksSourceClusterNamespace < Struct.new( include Aws::Structure end + # Indicates the error that was encountered while importing a resource. + # + # @!attribute [rw] error_message + # Provides additional information about the error. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ErrorDetail AWS API Documentation + # + class ErrorDetail < Struct.new( + :error_message) + SENSITIVE = [] + include Aws::Structure + end + # Indicates an event you would like to subscribe and get notification # for. Currently, Resilience Hub supports notifications only for **Drift # detected** and **Scheduled assessment failure** events. @@ -3972,6 +4032,17 @@ class ListAppVersionsResponse < Struct.new( # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # @return [String] # + # @!attribute [rw] aws_application_arn + # 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)][1] in the *Amazon + # Web Services General Reference* guide. + # + # + # + # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + # @return [String] + # # @!attribute [rw] from_last_assessment_time # Indicates the lower limit of the range that is used to filter # applications based on their last assessment times. @@ -4009,6 +4080,7 @@ class ListAppVersionsResponse < Struct.new( # class ListAppsRequest < Struct.new( :app_arn, + :aws_application_arn, :from_last_assessment_time, :max_results, :name, diff --git a/gems/aws-sdk-resiliencehub/sig/client.rbs b/gems/aws-sdk-resiliencehub/sig/client.rbs index 6a78d445523..1c107544c23 100644 --- a/gems/aws-sdk-resiliencehub/sig/client.rbs +++ b/gems/aws-sdk-resiliencehub/sig/client.rbs @@ -138,7 +138,7 @@ module Aws resource_id: ::String?, target_account_id: ::String?, target_region: ::String? - }, + }?, reference_id: ::String }, ] @@ -152,6 +152,7 @@ module Aws # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ResilienceHub/Client.html#create_app-instance_method def create_app: ( ?assessment_schedule: ("Disabled" | "Daily"), + ?aws_application_arn: ::String, ?client_token: ::String, ?description: ::String, ?event_subscriptions: Array[ @@ -461,6 +462,7 @@ module Aws include ::Seahorse::Client::_ResponseSuccess[Types::DescribeDraftAppVersionResourcesImportStatusResponse] def app_arn: () -> ::String def app_version: () -> ::String + def error_details: () -> ::Array[Types::ErrorDetail] def error_message: () -> ::String def status: () -> ("Pending" | "InProgress" | "Failed" | "Success") def status_change_time: () -> ::Time @@ -688,6 +690,7 @@ module Aws # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ResilienceHub/Client.html#list_apps-instance_method def list_apps: ( ?app_arn: ::String, + ?aws_application_arn: ::String, ?from_last_assessment_time: ::Time, ?max_results: ::Integer, ?name: ::String, diff --git a/gems/aws-sdk-resiliencehub/sig/types.rbs b/gems/aws-sdk-resiliencehub/sig/types.rbs index 9a3d587a363..5fca3d7a0af 100644 --- a/gems/aws-sdk-resiliencehub/sig/types.rbs +++ b/gems/aws-sdk-resiliencehub/sig/types.rbs @@ -60,6 +60,7 @@ module Aws::ResilienceHub class App attr_accessor app_arn: ::String attr_accessor assessment_schedule: ("Disabled" | "Daily") + attr_accessor aws_application_arn: ::String attr_accessor compliance_status: ("PolicyBreached" | "PolicyMet" | "NotAssessed" | "ChangesDetected" | "NotApplicable" | "MissingPolicy") attr_accessor creation_time: ::Time attr_accessor description: ::String @@ -151,6 +152,7 @@ module Aws::ResilienceHub class AppSummary attr_accessor app_arn: ::String attr_accessor assessment_schedule: ("Disabled" | "Daily") + attr_accessor aws_application_arn: ::String attr_accessor compliance_status: ("PolicyBreached" | "PolicyMet" | "NotAssessed" | "ChangesDetected" | "NotApplicable" | "MissingPolicy") attr_accessor creation_time: ::Time attr_accessor description: ::String @@ -264,6 +266,7 @@ module Aws::ResilienceHub class CreateAppRequest attr_accessor assessment_schedule: ("Disabled" | "Daily") + attr_accessor aws_application_arn: ::String attr_accessor client_token: ::String attr_accessor description: ::String attr_accessor event_subscriptions: ::Array[Types::EventSubscription] @@ -546,6 +549,7 @@ module Aws::ResilienceHub class DescribeDraftAppVersionResourcesImportStatusResponse attr_accessor app_arn: ::String attr_accessor app_version: ::String + attr_accessor error_details: ::Array[Types::ErrorDetail] attr_accessor error_message: ::String attr_accessor status: ("Pending" | "InProgress" | "Failed" | "Success") attr_accessor status_change_time: ::Time @@ -601,6 +605,11 @@ module Aws::ResilienceHub SENSITIVE: [] end + class ErrorDetail + attr_accessor error_message: ::String + SENSITIVE: [] + end + class EventSubscription attr_accessor event_type: ("ScheduledAssessmentFailure" | "DriftDetected") attr_accessor name: ::String @@ -833,6 +842,7 @@ module Aws::ResilienceHub class ListAppsRequest attr_accessor app_arn: ::String + attr_accessor aws_application_arn: ::String attr_accessor from_last_assessment_time: ::Time attr_accessor max_results: ::Integer attr_accessor name: ::String diff --git a/gems/aws-sdk-sesv2/CHANGELOG.md b/gems/aws-sdk-sesv2/CHANGELOG.md index 85033d9a270..37eecca92da 100644 --- a/gems/aws-sdk-sesv2/CHANGELOG.md +++ b/gems/aws-sdk-sesv2/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.64.0 (2024-10-15) +------------------ + +* Feature - This release adds support for email maximum delivery seconds that allows senders to control the time within which their emails are attempted for delivery. + 1.63.0 (2024-09-27) ------------------ diff --git a/gems/aws-sdk-sesv2/VERSION b/gems/aws-sdk-sesv2/VERSION index af92bdd9f58..9405730420f 100644 --- a/gems/aws-sdk-sesv2/VERSION +++ b/gems/aws-sdk-sesv2/VERSION @@ -1 +1 @@ -1.63.0 +1.64.0 diff --git a/gems/aws-sdk-sesv2/lib/aws-sdk-sesv2.rb b/gems/aws-sdk-sesv2/lib/aws-sdk-sesv2.rb index 8fdd4a64b92..9dff0f18b82 100644 --- a/gems/aws-sdk-sesv2/lib/aws-sdk-sesv2.rb +++ b/gems/aws-sdk-sesv2/lib/aws-sdk-sesv2.rb @@ -54,7 +54,7 @@ module Plugins autoload :EndpointProvider, 'aws-sdk-sesv2/endpoint_provider' autoload :Endpoints, 'aws-sdk-sesv2/endpoints' - GEM_VERSION = '1.63.0' + GEM_VERSION = '1.64.0' end diff --git a/gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb b/gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb index ee76b442e21..2f391585cf0 100644 --- a/gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb +++ b/gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb @@ -584,6 +584,7 @@ def cancel_export_job(params = {}, options = {}) # delivery_options: { # tls_policy: "REQUIRE", # accepts REQUIRE, OPTIONAL # sending_pool_name: "PoolName", + # max_delivery_seconds: 1, # }, # reputation_options: { # reputation_metrics_enabled: false, @@ -1767,6 +1768,7 @@ def get_blacklist_reports(params = {}, options = {}) # resp.tracking_options.https_policy #=> String, one of "REQUIRE", "REQUIRE_OPEN_ONLY", "OPTIONAL" # resp.delivery_options.tls_policy #=> String, one of "REQUIRE", "OPTIONAL" # resp.delivery_options.sending_pool_name #=> String + # resp.delivery_options.max_delivery_seconds #=> Integer # resp.reputation_options.reputation_metrics_enabled #=> Boolean # resp.reputation_options.last_fresh_start #=> Time # resp.sending_options.sending_enabled #=> Boolean @@ -3753,6 +3755,12 @@ def put_account_vdm_attributes(params = {}, options = {}) # The name of the dedicated IP pool to associate with the configuration # set. # + # @option params [Integer] :max_delivery_seconds + # 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). + # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values @@ -3761,6 +3769,7 @@ def put_account_vdm_attributes(params = {}, options = {}) # configuration_set_name: "ConfigurationSetName", # required # tls_policy: "REQUIRE", # accepts REQUIRE, OPTIONAL # sending_pool_name: "SendingPoolName", + # max_delivery_seconds: 1, # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutConfigurationSetDeliveryOptions AWS API Documentation @@ -5176,7 +5185,7 @@ def build_request(operation_name, params = {}) tracer: tracer ) context[:gem_name] = 'aws-sdk-sesv2' - context[:gem_version] = '1.63.0' + context[:gem_version] = '1.64.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client_api.rb b/gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client_api.rb index 4d84771f92f..4ee202b72cb 100644 --- a/gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client_api.rb +++ b/gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client_api.rb @@ -317,6 +317,7 @@ module ClientApi MailFromDomainStatus = Shapes::StringShape.new(name: 'MailFromDomainStatus') MailType = Shapes::StringShape.new(name: 'MailType') Max24HourSend = Shapes::FloatShape.new(name: 'Max24HourSend') + MaxDeliverySeconds = Shapes::IntegerShape.new(name: 'MaxDeliverySeconds') MaxItems = Shapes::IntegerShape.new(name: 'MaxItems') MaxSendRate = Shapes::FloatShape.new(name: 'MaxSendRate') Message = Shapes::StructureShape.new(name: 'Message') @@ -817,6 +818,7 @@ module ClientApi DeliveryOptions.add_member(:tls_policy, Shapes::ShapeRef.new(shape: TlsPolicy, location_name: "TlsPolicy")) DeliveryOptions.add_member(:sending_pool_name, Shapes::ShapeRef.new(shape: PoolName, location_name: "SendingPoolName")) + DeliveryOptions.add_member(:max_delivery_seconds, Shapes::ShapeRef.new(shape: MaxDeliverySeconds, location_name: "MaxDeliverySeconds")) DeliveryOptions.struct_class = Types::DeliveryOptions Destination.add_member(:to_addresses, Shapes::ShapeRef.new(shape: EmailAddressList, location_name: "ToAddresses")) @@ -1499,6 +1501,7 @@ module ClientApi PutConfigurationSetDeliveryOptionsRequest.add_member(:configuration_set_name, Shapes::ShapeRef.new(shape: ConfigurationSetName, required: true, location: "uri", location_name: "ConfigurationSetName")) PutConfigurationSetDeliveryOptionsRequest.add_member(:tls_policy, Shapes::ShapeRef.new(shape: TlsPolicy, location_name: "TlsPolicy")) PutConfigurationSetDeliveryOptionsRequest.add_member(:sending_pool_name, Shapes::ShapeRef.new(shape: SendingPoolName, location_name: "SendingPoolName")) + PutConfigurationSetDeliveryOptionsRequest.add_member(:max_delivery_seconds, Shapes::ShapeRef.new(shape: MaxDeliverySeconds, location_name: "MaxDeliverySeconds")) PutConfigurationSetDeliveryOptionsRequest.struct_class = Types::PutConfigurationSetDeliveryOptionsRequest PutConfigurationSetDeliveryOptionsResponse.struct_class = Types::PutConfigurationSetDeliveryOptionsResponse diff --git a/gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb b/gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb index 4ba91be18c5..6224ac86d36 100644 --- a/gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb +++ b/gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb @@ -1694,11 +1694,19 @@ class DeliverabilityTestReport < Struct.new( # configuration set. # @return [String] # + # @!attribute [rw] max_delivery_seconds + # 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). + # @return [Integer] + # # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeliveryOptions AWS API Documentation # class DeliveryOptions < Struct.new( :tls_policy, - :sending_pool_name) + :sending_pool_name, + :max_delivery_seconds) SENSITIVE = [] include Aws::Structure end @@ -5471,12 +5479,20 @@ class PutAccountVdmAttributesResponse < Aws::EmptyStructure; end # configuration set. # @return [String] # + # @!attribute [rw] max_delivery_seconds + # 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). + # @return [Integer] + # # @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutConfigurationSetDeliveryOptionsRequest AWS API Documentation # class PutConfigurationSetDeliveryOptionsRequest < Struct.new( :configuration_set_name, :tls_policy, - :sending_pool_name) + :sending_pool_name, + :max_delivery_seconds) SENSITIVE = [] include Aws::Structure end diff --git a/gems/aws-sdk-sesv2/sig/client.rbs b/gems/aws-sdk-sesv2/sig/client.rbs index aedee74c2b1..05f0e1357cf 100644 --- a/gems/aws-sdk-sesv2/sig/client.rbs +++ b/gems/aws-sdk-sesv2/sig/client.rbs @@ -116,7 +116,8 @@ module Aws }, ?delivery_options: { tls_policy: ("REQUIRE" | "OPTIONAL")?, - sending_pool_name: ::String? + sending_pool_name: ::String?, + max_delivery_seconds: ::Integer? }, ?reputation_options: { reputation_metrics_enabled: bool?, @@ -1054,7 +1055,8 @@ module Aws def put_configuration_set_delivery_options: ( configuration_set_name: ::String, ?tls_policy: ("REQUIRE" | "OPTIONAL"), - ?sending_pool_name: ::String + ?sending_pool_name: ::String, + ?max_delivery_seconds: ::Integer ) -> _PutConfigurationSetDeliveryOptionsResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutConfigurationSetDeliveryOptionsResponseSuccess diff --git a/gems/aws-sdk-sesv2/sig/types.rbs b/gems/aws-sdk-sesv2/sig/types.rbs index 6c717b04684..96e2bf7ad2b 100644 --- a/gems/aws-sdk-sesv2/sig/types.rbs +++ b/gems/aws-sdk-sesv2/sig/types.rbs @@ -424,6 +424,7 @@ module Aws::SESV2 class DeliveryOptions attr_accessor tls_policy: ("REQUIRE" | "OPTIONAL") attr_accessor sending_pool_name: ::String + attr_accessor max_delivery_seconds: ::Integer SENSITIVE: [] end @@ -1279,6 +1280,7 @@ module Aws::SESV2 attr_accessor configuration_set_name: ::String attr_accessor tls_policy: ("REQUIRE" | "OPTIONAL") attr_accessor sending_pool_name: ::String + attr_accessor max_delivery_seconds: ::Integer SENSITIVE: [] end diff --git a/gems/aws-sdk-transcribestreamingservice/CHANGELOG.md b/gems/aws-sdk-transcribestreamingservice/CHANGELOG.md index 98b2e8bfada..947ac97e5bf 100644 --- a/gems/aws-sdk-transcribestreamingservice/CHANGELOG.md +++ b/gems/aws-sdk-transcribestreamingservice/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.71.0 (2024-10-15) +------------------ + +* Feature - We are expanding support for 40 new locales in AWS Transcribe Streaming. + 1.70.0 (2024-09-24) ------------------ diff --git a/gems/aws-sdk-transcribestreamingservice/VERSION b/gems/aws-sdk-transcribestreamingservice/VERSION index 832e9afb6c1..df484cbb1d9 100644 --- a/gems/aws-sdk-transcribestreamingservice/VERSION +++ b/gems/aws-sdk-transcribestreamingservice/VERSION @@ -1 +1 @@ -1.70.0 +1.71.0 diff --git a/gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice.rb b/gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice.rb index dc2bfa865bd..527f9ed4746 100644 --- a/gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice.rb +++ b/gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice.rb @@ -56,7 +56,7 @@ module Plugins autoload :AsyncClient, 'aws-sdk-transcribestreamingservice/async_client' autoload :EventStreams, 'aws-sdk-transcribestreamingservice/event_streams' - GEM_VERSION = '1.70.0' + GEM_VERSION = '1.71.0' end diff --git a/gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/async_client.rb b/gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/async_client.rb index 0a330f37d1f..31c0366946a 100644 --- a/gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/async_client.rb +++ b/gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/async_client.rb @@ -387,10 +387,7 @@ def initialize(*args) # Specify the language code that represents the language spoken in your # audio. # - # If you're unsure of the language spoken in your audio, consider using - # `IdentifyLanguage` to enable automatic language identification. - # - # For a list of languages supported with streaming Call Analytics, refer + # For a list of languages supported with real-time Call Analytics, refer # to the [Supported languages][1] table. # # @@ -439,8 +436,6 @@ def initialize(*args) # don't include this parameter in your request, Amazon Transcribe # generates an ID and returns it in the response. # - # You can use a session ID to retry a streaming session. - # # @option params [String] :vocabulary_filter_name # Specify the name of the custom vocabulary filter that you want to use # when processing your transcription. Note that vocabulary filter names @@ -511,7 +506,8 @@ def initialize(*args) # # Content identification is performed at the segment level; PII # specified in `PiiEntityTypes` is flagged upon complete transcription - # of an audio segment. + # of an audio segment. If you don't include `PiiEntityTypes` in your + # request, all PII is identified. # # You can’t set `ContentIdentificationType` and `ContentRedactionType` # in the same request. If you set both, your request returns a @@ -530,7 +526,8 @@ def initialize(*args) # # Content redaction is performed at the segment level; PII specified in # `PiiEntityTypes` is redacted upon complete transcription of an audio - # segment. + # segment. If you don't include `PiiEntityTypes` in your request, all + # PII is redacted. # # You can’t set `ContentRedactionType` and `ContentIdentificationType` # in the same request. If you set both, your request returns a @@ -548,14 +545,17 @@ def initialize(*args) # want to redact in your transcript. You can include as many types as # you'd like, or you can select `ALL`. # - # To include `PiiEntityTypes` in your Call Analytics request, you must - # also include either `ContentIdentificationType` or - # `ContentRedactionType`. + # Values must be comma-separated and can include: `ADDRESS`, + # `BANK_ACCOUNT_NUMBER`, `BANK_ROUTING`, `CREDIT_DEBIT_CVV`, + # `CREDIT_DEBIT_EXPIRY`, `CREDIT_DEBIT_NUMBER`, `EMAIL`, `NAME`, + # `PHONE`, `PIN`, `SSN`, or `ALL`. + # + # Note that if you include `PiiEntityTypes` in your request, you must + # also include `ContentIdentificationType` or `ContentRedactionType`. # - # Values must be comma-separated and can include: `BANK_ACCOUNT_NUMBER`, - # `BANK_ROUTING`, `CREDIT_DEBIT_NUMBER`, `CREDIT_DEBIT_CVV`, - # `CREDIT_DEBIT_EXPIRY`, `PIN`, `EMAIL`, `ADDRESS`, `NAME`, `PHONE`, - # `SSN`, or `ALL`. + # If you include `ContentRedactionType` or `ContentIdentificationType` + # in your request, but do not include `PiiEntityTypes`, all PII is + # redacted or identified. # # @return [Types::StartCallAnalyticsStreamTranscriptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -873,8 +873,6 @@ def start_call_analytics_stream_transcription(params = {}, options = {}, &block) # this parameter in your request, Amazon Transcribe Medical generates an # ID and returns it in the response. # - # You can use a session ID to retry a streaming session. - # # @option params [Boolean] :enable_channel_identification # Enables channel identification in multi-channel audio. # @@ -886,6 +884,9 @@ def start_call_analytics_stream_transcription(params = {}, options = {}, &block) # identification, your audio is transcribed in a continuous manner and # your transcript is not separated by channel. # + # If you include `EnableChannelIdentification` in your request, you must + # also include `NumberOfChannels`. + # # For more information, see [Transcribing multi-channel audio][1]. # # @@ -893,8 +894,13 @@ def start_call_analytics_stream_transcription(params = {}, options = {}, &block) # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html # # @option params [Integer] :number_of_channels - # Specify the number of channels in your audio stream. Up to two - # channels are supported. + # Specify the number of channels in your audio stream. This value must + # be `2`, as only two channels are supported. If your audio doesn't + # contain multiple channels, do not include this parameter in your + # request. + # + # If you include `NumberOfChannels` in your request, you must also + # include `EnableChannelIdentification`. # # @option params [String] :content_identification_type # Labels all personal health information (PHI) identified in your @@ -1023,7 +1029,7 @@ def start_call_analytics_stream_transcription(params = {}, options = {}, &block) # @example Request syntax with placeholder values # # async_resp = async_client.start_medical_stream_transcription({ - # language_code: "en-US", # required, accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN, hi-IN, th-TH + # language_code: "en-US", # required, accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN, th-TH, es-ES, ar-SA, pt-PT, ca-ES, ar-AE, hi-IN, zh-HK, nl-NL, no-NO, sv-SE, pl-PL, fi-FI, zh-TW, en-IN, en-IE, en-NZ, en-AB, en-ZA, en-WL, de-CH, af-ZA, eu-ES, hr-HR, cs-CZ, da-DK, fa-IR, gl-ES, el-GR, he-IL, id-ID, lv-LV, ms-MY, ro-RO, ru-RU, sr-RS, sk-SK, so-SO, tl-PH, uk-UA, vi-VN, zu-ZA # media_sample_rate_hertz: 1, # required # media_encoding: "pcm", # required, accepts pcm, ogg-opus, flac # vocabulary_name: "VocabularyName", @@ -1044,7 +1050,7 @@ def start_call_analytics_stream_transcription(params = {}, options = {}, &block) # @example Response structure # # resp.request_id #=> String - # resp.language_code #=> String, one of "en-US", "en-GB", "es-US", "fr-CA", "fr-FR", "en-AU", "it-IT", "de-DE", "pt-BR", "ja-JP", "ko-KR", "zh-CN", "hi-IN", "th-TH" + # resp.language_code #=> String, one of "en-US", "en-GB", "es-US", "fr-CA", "fr-FR", "en-AU", "it-IT", "de-DE", "pt-BR", "ja-JP", "ko-KR", "zh-CN", "th-TH", "es-ES", "ar-SA", "pt-PT", "ca-ES", "ar-AE", "hi-IN", "zh-HK", "nl-NL", "no-NO", "sv-SE", "pl-PL", "fi-FI", "zh-TW", "en-IN", "en-IE", "en-NZ", "en-AB", "en-ZA", "en-WL", "de-CH", "af-ZA", "eu-ES", "hr-HR", "cs-CZ", "da-DK", "fa-IR", "gl-ES", "el-GR", "he-IL", "id-ID", "lv-LV", "ms-MY", "ro-RO", "ru-RU", "sr-RS", "sk-SK", "so-SO", "tl-PH", "uk-UA", "vi-VN", "zu-ZA" # resp.media_sample_rate_hertz #=> Integer # resp.media_encoding #=> String, one of "pcm", "ogg-opus", "flac" # resp.vocabulary_name #=> String @@ -1208,8 +1214,6 @@ def start_medical_stream_transcription(params = {}, options = {}, &block) # this parameter in your request, Amazon Transcribe generates an ID and # returns it in the response. # - # You can use a session ID to retry a streaming session. - # # @option params [String] :vocabulary_filter_name # Specify the name of the custom vocabulary filter that you want to use # when processing your transcription. Note that vocabulary filter names @@ -1263,6 +1267,9 @@ def start_medical_stream_transcription(params = {}, options = {}, &block) # identification, your audio is transcribed in a continuous manner and # your transcript is not separated by channel. # + # If you include `EnableChannelIdentification` in your request, you must + # also include `NumberOfChannels`. + # # For more information, see [Transcribing multi-channel audio][1]. # # @@ -1270,8 +1277,13 @@ def start_medical_stream_transcription(params = {}, options = {}, &block) # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html # # @option params [Integer] :number_of_channels - # Specify the number of channels in your audio stream. Up to two - # channels are supported. + # Specify the number of channels in your audio stream. This value must + # be `2`, as only two channels are supported. If your audio doesn't + # contain multiple channels, do not include this parameter in your + # request. + # + # If you include `NumberOfChannels` in your request, you must also + # include `EnableChannelIdentification`. # # @option params [Boolean] :enable_partial_results_stabilization # Enables partial result stabilization for your transcription. Partial @@ -1301,7 +1313,8 @@ def start_medical_stream_transcription(params = {}, options = {}, &block) # # Content identification is performed at the segment level; PII # specified in `PiiEntityTypes` is flagged upon complete transcription - # of an audio segment. + # of an audio segment. If you don't include `PiiEntityTypes` in your + # request, all PII is identified. # # You can’t set `ContentIdentificationType` and `ContentRedactionType` # in the same request. If you set both, your request returns a @@ -1320,7 +1333,8 @@ def start_medical_stream_transcription(params = {}, options = {}, &block) # # Content redaction is performed at the segment level; PII specified in # `PiiEntityTypes` is redacted upon complete transcription of an audio - # segment. + # segment. If you don't include `PiiEntityTypes` in your request, all + # PII is redacted. # # You can’t set `ContentRedactionType` and `ContentIdentificationType` # in the same request. If you set both, your request returns a @@ -1338,13 +1352,17 @@ def start_medical_stream_transcription(params = {}, options = {}, &block) # want to redact in your transcript. You can include as many types as # you'd like, or you can select `ALL`. # - # To include `PiiEntityTypes` in your request, you must also include - # either `ContentIdentificationType` or `ContentRedactionType`. + # Values must be comma-separated and can include: `ADDRESS`, + # `BANK_ACCOUNT_NUMBER`, `BANK_ROUTING`, `CREDIT_DEBIT_CVV`, + # `CREDIT_DEBIT_EXPIRY`, `CREDIT_DEBIT_NUMBER`, `EMAIL`, `NAME`, + # `PHONE`, `PIN`, `SSN`, or `ALL`. + # + # Note that if you include `PiiEntityTypes` in your request, you must + # also include `ContentIdentificationType` or `ContentRedactionType`. # - # Values must be comma-separated and can include: `BANK_ACCOUNT_NUMBER`, - # `BANK_ROUTING`, `CREDIT_DEBIT_NUMBER`, `CREDIT_DEBIT_CVV`, - # `CREDIT_DEBIT_EXPIRY`, `PIN`, `EMAIL`, `ADDRESS`, `NAME`, `PHONE`, - # `SSN`, or `ALL`. + # If you include `ContentRedactionType` or `ContentIdentificationType` + # in your request, but do not include `PiiEntityTypes`, all PII is + # redacted or identified. # # @option params [String] :language_model_name # Specify the name of the custom language model that you want to use @@ -1365,10 +1383,9 @@ def start_medical_stream_transcription(params = {}, options = {}, &block) # @option params [Boolean] :identify_language # Enables automatic language identification for your transcription. # - # If you include `IdentifyLanguage`, you can optionally include a list - # of language codes, using `LanguageOptions`, that you think may be - # present in your audio stream. Including language options can improve - # transcription accuracy. + # If you include `IdentifyLanguage`, you must include a list of language + # codes, using `LanguageOptions`, that you think may be present in your + # audio stream. # # You can also include a preferred language using `PreferredLanguage`. # Adding a preferred language can help Amazon Transcribe identify the @@ -1389,14 +1406,13 @@ def start_medical_stream_transcription(params = {}, options = {}, &block) # @option params [String] :language_options # Specify two or more language codes that represent the languages you # think may be present in your media; including more than five is not - # recommended. If you're unsure what languages are present, do not - # include this parameter. + # recommended. # # Including language options can improve the accuracy of language # identification. # # If you include `LanguageOptions` in your request, you must also - # include `IdentifyLanguage`. + # include `IdentifyLanguage` or `IdentifyMultipleLanguages`. # # For a list of languages supported with Amazon Transcribe streaming, # refer to the [Supported languages][1] table. @@ -1421,11 +1437,9 @@ def start_medical_stream_transcription(params = {}, options = {}, &block) # language. If your stream contains only one language, use # IdentifyLanguage instead. # - # If you include `IdentifyMultipleLanguages`, you can optionally include - # a list of language codes, using `LanguageOptions`, that you think may - # be present in your stream. Including `LanguageOptions` restricts - # `IdentifyMultipleLanguages` to only the language options that you - # specify, which can improve transcription accuracy. + # If you include `IdentifyMultipleLanguages`, you must include a list of + # language codes, using `LanguageOptions`, that you think may be present + # in your stream. # # If you want to apply a custom vocabulary or a custom vocabulary filter # to your automatic multiple language identification request, include @@ -1599,7 +1613,7 @@ def start_medical_stream_transcription(params = {}, options = {}, &block) # @example Request syntax with placeholder values # # async_resp = async_client.start_stream_transcription({ - # language_code: "en-US", # accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN, hi-IN, th-TH + # language_code: "en-US", # accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN, th-TH, es-ES, ar-SA, pt-PT, ca-ES, ar-AE, hi-IN, zh-HK, nl-NL, no-NO, sv-SE, pl-PL, fi-FI, zh-TW, en-IN, en-IE, en-NZ, en-AB, en-ZA, en-WL, de-CH, af-ZA, eu-ES, hr-HR, cs-CZ, da-DK, fa-IR, gl-ES, el-GR, he-IL, id-ID, lv-LV, ms-MY, ro-RO, ru-RU, sr-RS, sk-SK, so-SO, tl-PH, uk-UA, vi-VN, zu-ZA # media_sample_rate_hertz: 1, # required # media_encoding: "pcm", # required, accepts pcm, ogg-opus, flac # vocabulary_name: "VocabularyName", @@ -1618,7 +1632,7 @@ def start_medical_stream_transcription(params = {}, options = {}, &block) # language_model_name: "ModelName", # identify_language: false, # language_options: "LanguageOptions", - # preferred_language: "en-US", # accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN, hi-IN, th-TH + # preferred_language: "en-US", # accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN, th-TH, es-ES, ar-SA, pt-PT, ca-ES, ar-AE, hi-IN, zh-HK, nl-NL, no-NO, sv-SE, pl-PL, fi-FI, zh-TW, en-IN, en-IE, en-NZ, en-AB, en-ZA, en-WL, de-CH, af-ZA, eu-ES, hr-HR, cs-CZ, da-DK, fa-IR, gl-ES, el-GR, he-IL, id-ID, lv-LV, ms-MY, ro-RO, ru-RU, sr-RS, sk-SK, so-SO, tl-PH, uk-UA, vi-VN, zu-ZA # identify_multiple_languages: false, # vocabulary_names: "VocabularyNames", # vocabulary_filter_names: "VocabularyFilterNames", @@ -1631,7 +1645,7 @@ def start_medical_stream_transcription(params = {}, options = {}, &block) # @example Response structure # # resp.request_id #=> String - # resp.language_code #=> String, one of "en-US", "en-GB", "es-US", "fr-CA", "fr-FR", "en-AU", "it-IT", "de-DE", "pt-BR", "ja-JP", "ko-KR", "zh-CN", "hi-IN", "th-TH" + # resp.language_code #=> String, one of "en-US", "en-GB", "es-US", "fr-CA", "fr-FR", "en-AU", "it-IT", "de-DE", "pt-BR", "ja-JP", "ko-KR", "zh-CN", "th-TH", "es-ES", "ar-SA", "pt-PT", "ca-ES", "ar-AE", "hi-IN", "zh-HK", "nl-NL", "no-NO", "sv-SE", "pl-PL", "fi-FI", "zh-TW", "en-IN", "en-IE", "en-NZ", "en-AB", "en-ZA", "en-WL", "de-CH", "af-ZA", "eu-ES", "hr-HR", "cs-CZ", "da-DK", "fa-IR", "gl-ES", "el-GR", "he-IL", "id-ID", "lv-LV", "ms-MY", "ro-RO", "ru-RU", "sr-RS", "sk-SK", "so-SO", "tl-PH", "uk-UA", "vi-VN", "zu-ZA" # resp.media_sample_rate_hertz #=> Integer # resp.media_encoding #=> String, one of "pcm", "ogg-opus", "flac" # resp.vocabulary_name #=> String @@ -1665,9 +1679,9 @@ def start_medical_stream_transcription(params = {}, options = {}, &block) # event.transcript.results[0].alternatives[0].entities[0].content #=> String # event.transcript.results[0].alternatives[0].entities[0].confidence #=> Float # event.transcript.results[0].channel_id #=> String - # event.transcript.results[0].language_code #=> String, one of "en-US", "en-GB", "es-US", "fr-CA", "fr-FR", "en-AU", "it-IT", "de-DE", "pt-BR", "ja-JP", "ko-KR", "zh-CN", "hi-IN", "th-TH" + # event.transcript.results[0].language_code #=> String, one of "en-US", "en-GB", "es-US", "fr-CA", "fr-FR", "en-AU", "it-IT", "de-DE", "pt-BR", "ja-JP", "ko-KR", "zh-CN", "th-TH", "es-ES", "ar-SA", "pt-PT", "ca-ES", "ar-AE", "hi-IN", "zh-HK", "nl-NL", "no-NO", "sv-SE", "pl-PL", "fi-FI", "zh-TW", "en-IN", "en-IE", "en-NZ", "en-AB", "en-ZA", "en-WL", "de-CH", "af-ZA", "eu-ES", "hr-HR", "cs-CZ", "da-DK", "fa-IR", "gl-ES", "el-GR", "he-IL", "id-ID", "lv-LV", "ms-MY", "ro-RO", "ru-RU", "sr-RS", "sk-SK", "so-SO", "tl-PH", "uk-UA", "vi-VN", "zu-ZA" # event.transcript.results[0].language_identification #=> Array - # event.transcript.results[0].language_identification[0].language_code #=> String, one of "en-US", "en-GB", "es-US", "fr-CA", "fr-FR", "en-AU", "it-IT", "de-DE", "pt-BR", "ja-JP", "ko-KR", "zh-CN", "hi-IN", "th-TH" + # event.transcript.results[0].language_identification[0].language_code #=> String, one of "en-US", "en-GB", "es-US", "fr-CA", "fr-FR", "en-AU", "it-IT", "de-DE", "pt-BR", "ja-JP", "ko-KR", "zh-CN", "th-TH", "es-ES", "ar-SA", "pt-PT", "ca-ES", "ar-AE", "hi-IN", "zh-HK", "nl-NL", "no-NO", "sv-SE", "pl-PL", "fi-FI", "zh-TW", "en-IN", "en-IE", "en-NZ", "en-AB", "en-ZA", "en-WL", "de-CH", "af-ZA", "eu-ES", "hr-HR", "cs-CZ", "da-DK", "fa-IR", "gl-ES", "el-GR", "he-IL", "id-ID", "lv-LV", "ms-MY", "ro-RO", "ru-RU", "sr-RS", "sk-SK", "so-SO", "tl-PH", "uk-UA", "vi-VN", "zu-ZA" # event.transcript.results[0].language_identification[0].score #=> Float # # For :bad_request_exception event available at #on_bad_request_exception_event callback and response eventstream enumerator: @@ -1698,7 +1712,7 @@ def start_medical_stream_transcription(params = {}, options = {}, &block) # resp.language_model_name #=> String # resp.identify_language #=> Boolean # resp.language_options #=> String - # resp.preferred_language #=> String, one of "en-US", "en-GB", "es-US", "fr-CA", "fr-FR", "en-AU", "it-IT", "de-DE", "pt-BR", "ja-JP", "ko-KR", "zh-CN", "hi-IN", "th-TH" + # resp.preferred_language #=> String, one of "en-US", "en-GB", "es-US", "fr-CA", "fr-FR", "en-AU", "it-IT", "de-DE", "pt-BR", "ja-JP", "ko-KR", "zh-CN", "th-TH", "es-ES", "ar-SA", "pt-PT", "ca-ES", "ar-AE", "hi-IN", "zh-HK", "nl-NL", "no-NO", "sv-SE", "pl-PL", "fi-FI", "zh-TW", "en-IN", "en-IE", "en-NZ", "en-AB", "en-ZA", "en-WL", "de-CH", "af-ZA", "eu-ES", "hr-HR", "cs-CZ", "da-DK", "fa-IR", "gl-ES", "el-GR", "he-IL", "id-ID", "lv-LV", "ms-MY", "ro-RO", "ru-RU", "sr-RS", "sk-SK", "so-SO", "tl-PH", "uk-UA", "vi-VN", "zu-ZA" # resp.identify_multiple_languages #=> Boolean # resp.vocabulary_names #=> String # resp.vocabulary_filter_names #=> String @@ -1751,7 +1765,7 @@ def build_request(operation_name, params = {}) tracer: tracer ) context[:gem_name] = 'aws-sdk-transcribestreamingservice' - context[:gem_version] = '1.70.0' + context[:gem_version] = '1.71.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/client.rb b/gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/client.rb index 5befcda4a14..0bf7c5fc8a2 100644 --- a/gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/client.rb +++ b/gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/client.rb @@ -476,7 +476,7 @@ def build_request(operation_name, params = {}) tracer: tracer ) context[:gem_name] = 'aws-sdk-transcribestreamingservice' - context[:gem_version] = '1.70.0' + context[:gem_version] = '1.71.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/event_streams.rb b/gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/event_streams.rb index b1e624a3b86..c1cb42adbd6 100644 --- a/gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/event_streams.rb +++ b/gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/event_streams.rb @@ -29,7 +29,15 @@ def signal_audio_event_event(params = {}) # @option params [Types::PostCallAnalyticsSettings] :post_call_analytics_settings # Provides additional optional settings for your Call Analytics # post-call request, including encryption and output locations for your - # redacted and unredacted transcript. + # redacted transcript. + # + # `PostCallAnalyticsSettings` provides you with the same insights as a + # Call Analytics post-call transcription. Refer to [Post-call + # analytics][1] for more information on this feature. + # + # + # + # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-post-call.html # def signal_configuration_event_event(params = {}) @event_emitter.emit(:configuration_event, params) @@ -65,7 +73,15 @@ def signal_audio_event_event(params = {}) # @option params [Types::PostCallAnalyticsSettings] :post_call_analytics_settings # Provides additional optional settings for your Call Analytics # post-call request, including encryption and output locations for your - # redacted and unredacted transcript. + # redacted transcript. + # + # `PostCallAnalyticsSettings` provides you with the same insights as a + # Call Analytics post-call transcription. Refer to [Post-call + # analytics][1] for more information on this feature. + # + # + # + # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-post-call.html # def signal_configuration_event_event(params = {}) @event_emitter.emit(:configuration_event, params) @@ -101,7 +117,15 @@ def signal_audio_event_event(params = {}) # @option params [Types::PostCallAnalyticsSettings] :post_call_analytics_settings # Provides additional optional settings for your Call Analytics # post-call request, including encryption and output locations for your - # redacted and unredacted transcript. + # redacted transcript. + # + # `PostCallAnalyticsSettings` provides you with the same insights as a + # Call Analytics post-call transcription. Refer to [Post-call + # analytics][1] for more information on this feature. + # + # + # + # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-post-call.html # def signal_configuration_event_event(params = {}) @event_emitter.emit(:configuration_event, params) diff --git a/gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb b/gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb index e7af46354b4..1933d5295f3 100644 --- a/gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb +++ b/gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb @@ -64,7 +64,7 @@ class AudioEvent < Struct.new( # One or more arguments to the `StartStreamTranscription`, # `StartMedicalStreamTranscription`, or # `StartCallAnalyticsStreamTranscription` operation was not valid. For - # example, `MediaEncoding` or `LanguageCode` used not valid values. + # example, `MediaEncoding` or `LanguageCode` used unsupported values. # Check the specified parameters and try your request again. # # @!attribute [rw] message @@ -269,7 +269,15 @@ class CharacterOffsets < Struct.new( # @!attribute [rw] post_call_analytics_settings # Provides additional optional settings for your Call Analytics # post-call request, including encryption and output locations for - # your redacted and unredacted transcript. + # your redacted transcript. + # + # `PostCallAnalyticsSettings` provides you with the same insights as a + # Call Analytics post-call transcription. Refer to [Post-call + # analytics][1] for more information on this feature. + # + # + # + # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-post-call.html # @return [Types::PostCallAnalyticsSettings] # # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/ConfigurationEvent AWS API Documentation @@ -713,13 +721,19 @@ class PointsOfInterest < Struct.new( include Aws::Structure end - # Allows you to specify additional settings for your streaming Call - # Analytics post-call request, including output locations for your - # redacted and unredacted transcript, which IAM role to use, and, - # optionally, which encryption key to use. + # Allows you to specify additional settings for your Call Analytics + # post-call request, including output locations for your redacted + # transcript, which IAM role to use, and which encryption key to use. + # + # `DataAccessRoleArn` and `OutputLocation` are required fields. + # + # `PostCallAnalyticsSettings` provides you with the same insights as a + # Call Analytics post-call transcription. Refer to [Post-call + # analytics][1] for more information on this feature. + # # - # `ContentRedactionOutput`, `DataAccessRoleArn`, and `OutputLocation` - # are required fields. + # + # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-post-call.html # # @!attribute [rw] output_location # The Amazon S3 location where you want your Call Analytics post-call @@ -789,7 +803,7 @@ class PointsOfInterest < Struct.new( # 2. Use the ARN for the KMS key alias. For example, # `arn:aws:kms:region:account-ID:alias/ExampleAlias`. # - # Note that the user making the request must have permission to use + # Note that the role making the request must have permission to use # the specified KMS key. # @return [String] # @@ -887,11 +901,7 @@ class ServiceUnavailableException < Struct.new( # Specify the language code that represents the language spoken in # your audio. # - # If you're unsure of the language spoken in your audio, consider - # using `IdentifyLanguage` to enable automatic language - # identification. - # - # For a list of languages supported with streaming Call Analytics, + # For a list of languages supported with real-time Call Analytics, # refer to the [Supported languages][1] table. # # @@ -943,8 +953,6 @@ class ServiceUnavailableException < Struct.new( # Specify a name for your Call Analytics transcription session. If you # don't include this parameter in your request, Amazon Transcribe # generates an ID and returns it in the response. - # - # You can use a session ID to retry a streaming session. # @return [String] # # @!attribute [rw] audio_stream @@ -1034,7 +1042,8 @@ class ServiceUnavailableException < Struct.new( # # Content identification is performed at the segment level; PII # specified in `PiiEntityTypes` is flagged upon complete transcription - # of an audio segment. + # of an audio segment. If you don't include `PiiEntityTypes` in your + # request, all PII is identified. # # You can’t set `ContentIdentificationType` and `ContentRedactionType` # in the same request. If you set both, your request returns a @@ -1054,7 +1063,8 @@ class ServiceUnavailableException < Struct.new( # # Content redaction is performed at the segment level; PII specified # in `PiiEntityTypes` is redacted upon complete transcription of an - # audio segment. + # audio segment. If you don't include `PiiEntityTypes` in your + # request, all PII is redacted. # # You can’t set `ContentRedactionType` and `ContentIdentificationType` # in the same request. If you set both, your request returns a @@ -1073,14 +1083,17 @@ class ServiceUnavailableException < Struct.new( # want to redact in your transcript. You can include as many types as # you'd like, or you can select `ALL`. # - # To include `PiiEntityTypes` in your Call Analytics request, you must - # also include either `ContentIdentificationType` or - # `ContentRedactionType`. + # Values must be comma-separated and can include: `ADDRESS`, + # `BANK_ACCOUNT_NUMBER`, `BANK_ROUTING`, `CREDIT_DEBIT_CVV`, + # `CREDIT_DEBIT_EXPIRY`, `CREDIT_DEBIT_NUMBER`, `EMAIL`, `NAME`, + # `PHONE`, `PIN`, `SSN`, or `ALL`. # - # Values must be comma-separated and can include: - # `BANK_ACCOUNT_NUMBER`, `BANK_ROUTING`, `CREDIT_DEBIT_NUMBER`, - # `CREDIT_DEBIT_CVV`, `CREDIT_DEBIT_EXPIRY`, `PIN`, `EMAIL`, - # `ADDRESS`, `NAME`, `PHONE`, `SSN`, or `ALL`. + # Note that if you include `PiiEntityTypes` in your request, you must + # also include `ContentIdentificationType` or `ContentRedactionType`. + # + # If you include `ContentRedactionType` or `ContentIdentificationType` + # in your request, but do not include `PiiEntityTypes`, all PII is + # redacted or identified. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/StartCallAnalyticsStreamTranscriptionRequest AWS API Documentation @@ -1105,7 +1118,7 @@ class StartCallAnalyticsStreamTranscriptionRequest < Struct.new( end # @!attribute [rw] request_id - # Provides the identifier for your Call Analytics streaming request. + # Provides the identifier for your real-time Call Analytics request. # @return [String] # # @!attribute [rw] language_code @@ -1134,7 +1147,7 @@ class StartCallAnalyticsStreamTranscriptionRequest < Struct.new( # @return [String] # # @!attribute [rw] call_analytics_transcript_result_stream - # Provides detailed information about your Call Analytics streaming + # Provides detailed information about your real-time Call Analytics # session. # @return [Types::CallAnalyticsTranscriptResultStream] # @@ -1262,8 +1275,6 @@ class StartCallAnalyticsStreamTranscriptionResponse < Struct.new( # Specify a name for your transcription session. If you don't include # this parameter in your request, Amazon Transcribe Medical generates # an ID and returns it in the response. - # - # You can use a session ID to retry a streaming session. # @return [String] # # @!attribute [rw] audio_stream @@ -1288,6 +1299,9 @@ class StartCallAnalyticsStreamTranscriptionResponse < Struct.new( # identification, your audio is transcribed in a continuous manner and # your transcript is not separated by channel. # + # If you include `EnableChannelIdentification` in your request, you + # must also include `NumberOfChannels`. + # # For more information, see [Transcribing multi-channel audio][1]. # # @@ -1296,8 +1310,13 @@ class StartCallAnalyticsStreamTranscriptionResponse < Struct.new( # @return [Boolean] # # @!attribute [rw] number_of_channels - # Specify the number of channels in your audio stream. Up to two - # channels are supported. + # Specify the number of channels in your audio stream. This value must + # be `2`, as only two channels are supported. If your audio doesn't + # contain multiple channels, do not include this parameter in your + # request. + # + # If you include `NumberOfChannels` in your request, you must also + # include `EnableChannelIdentification`. # @return [Integer] # # @!attribute [rw] content_identification_type @@ -1477,8 +1496,6 @@ class StartMedicalStreamTranscriptionResponse < Struct.new( # Specify a name for your transcription session. If you don't include # this parameter in your request, Amazon Transcribe generates an ID # and returns it in the response. - # - # You can use a session ID to retry a streaming session. # @return [String] # # @!attribute [rw] audio_stream @@ -1549,6 +1566,9 @@ class StartMedicalStreamTranscriptionResponse < Struct.new( # identification, your audio is transcribed in a continuous manner and # your transcript is not separated by channel. # + # If you include `EnableChannelIdentification` in your request, you + # must also include `NumberOfChannels`. + # # For more information, see [Transcribing multi-channel audio][1]. # # @@ -1557,8 +1577,13 @@ class StartMedicalStreamTranscriptionResponse < Struct.new( # @return [Boolean] # # @!attribute [rw] number_of_channels - # Specify the number of channels in your audio stream. Up to two - # channels are supported. + # Specify the number of channels in your audio stream. This value must + # be `2`, as only two channels are supported. If your audio doesn't + # contain multiple channels, do not include this parameter in your + # request. + # + # If you include `NumberOfChannels` in your request, you must also + # include `EnableChannelIdentification`. # @return [Integer] # # @!attribute [rw] enable_partial_results_stabilization @@ -1592,7 +1617,8 @@ class StartMedicalStreamTranscriptionResponse < Struct.new( # # Content identification is performed at the segment level; PII # specified in `PiiEntityTypes` is flagged upon complete transcription - # of an audio segment. + # of an audio segment. If you don't include `PiiEntityTypes` in your + # request, all PII is identified. # # You can’t set `ContentIdentificationType` and `ContentRedactionType` # in the same request. If you set both, your request returns a @@ -1612,7 +1638,8 @@ class StartMedicalStreamTranscriptionResponse < Struct.new( # # Content redaction is performed at the segment level; PII specified # in `PiiEntityTypes` is redacted upon complete transcription of an - # audio segment. + # audio segment. If you don't include `PiiEntityTypes` in your + # request, all PII is redacted. # # You can’t set `ContentRedactionType` and `ContentIdentificationType` # in the same request. If you set both, your request returns a @@ -1631,13 +1658,17 @@ class StartMedicalStreamTranscriptionResponse < Struct.new( # want to redact in your transcript. You can include as many types as # you'd like, or you can select `ALL`. # - # To include `PiiEntityTypes` in your request, you must also include - # either `ContentIdentificationType` or `ContentRedactionType`. + # Values must be comma-separated and can include: `ADDRESS`, + # `BANK_ACCOUNT_NUMBER`, `BANK_ROUTING`, `CREDIT_DEBIT_CVV`, + # `CREDIT_DEBIT_EXPIRY`, `CREDIT_DEBIT_NUMBER`, `EMAIL`, `NAME`, + # `PHONE`, `PIN`, `SSN`, or `ALL`. # - # Values must be comma-separated and can include: - # `BANK_ACCOUNT_NUMBER`, `BANK_ROUTING`, `CREDIT_DEBIT_NUMBER`, - # `CREDIT_DEBIT_CVV`, `CREDIT_DEBIT_EXPIRY`, `PIN`, `EMAIL`, - # `ADDRESS`, `NAME`, `PHONE`, `SSN`, or `ALL`. + # Note that if you include `PiiEntityTypes` in your request, you must + # also include `ContentIdentificationType` or `ContentRedactionType`. + # + # If you include `ContentRedactionType` or `ContentIdentificationType` + # in your request, but do not include `PiiEntityTypes`, all PII is + # redacted or identified. # @return [String] # # @!attribute [rw] language_model_name @@ -1660,10 +1691,9 @@ class StartMedicalStreamTranscriptionResponse < Struct.new( # @!attribute [rw] identify_language # Enables automatic language identification for your transcription. # - # If you include `IdentifyLanguage`, you can optionally include a list - # of language codes, using `LanguageOptions`, that you think may be - # present in your audio stream. Including language options can improve - # transcription accuracy. + # If you include `IdentifyLanguage`, you must include a list of + # language codes, using `LanguageOptions`, that you think may be + # present in your audio stream. # # You can also include a preferred language using `PreferredLanguage`. # Adding a preferred language can help Amazon Transcribe identify the @@ -1686,14 +1716,13 @@ class StartMedicalStreamTranscriptionResponse < Struct.new( # @!attribute [rw] language_options # Specify two or more language codes that represent the languages you # think may be present in your media; including more than five is not - # recommended. If you're unsure what languages are present, do not - # include this parameter. + # recommended. # # Including language options can improve the accuracy of language # identification. # # If you include `LanguageOptions` in your request, you must also - # include `IdentifyLanguage`. + # include `IdentifyLanguage` or `IdentifyMultipleLanguages`. # # For a list of languages supported with Amazon Transcribe streaming, # refer to the [Supported languages][1] table. @@ -1721,11 +1750,9 @@ class StartMedicalStreamTranscriptionResponse < Struct.new( # contains more than one language. If your stream contains only one # language, use IdentifyLanguage instead. # - # If you include `IdentifyMultipleLanguages`, you can optionally - # include a list of language codes, using `LanguageOptions`, that you - # think may be present in your stream. Including `LanguageOptions` - # restricts `IdentifyMultipleLanguages` to only the language options - # that you specify, which can improve transcription accuracy. + # If you include `IdentifyMultipleLanguages`, you must include a list + # of language codes, using `LanguageOptions`, that you think may be + # present in your stream. # # If you want to apply a custom vocabulary or a custom vocabulary # filter to your automatic multiple language identification request, @@ -2112,7 +2139,7 @@ def event_types end - # Contains detailed information about your Call Analytics streaming + # Contains detailed information about your real-time Call Analytics # session. These details are provided in the `UtteranceEvent` and # `CategoryEvent` objects. # diff --git a/gems/aws-sdk-transcribestreamingservice/sig/client.rbs b/gems/aws-sdk-transcribestreamingservice/sig/client.rbs index ff61671f755..e58cda3f8b0 100644 --- a/gems/aws-sdk-transcribestreamingservice/sig/client.rbs +++ b/gems/aws-sdk-transcribestreamingservice/sig/client.rbs @@ -118,7 +118,7 @@ module Aws interface _StartMedicalStreamTranscriptionResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::StartMedicalStreamTranscriptionResponse] def request_id: () -> ::String - def language_code: () -> ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "hi-IN" | "th-TH") + def language_code: () -> ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "th-TH" | "es-ES" | "ar-SA" | "pt-PT" | "ca-ES" | "ar-AE" | "hi-IN" | "zh-HK" | "nl-NL" | "no-NO" | "sv-SE" | "pl-PL" | "fi-FI" | "zh-TW" | "en-IN" | "en-IE" | "en-NZ" | "en-AB" | "en-ZA" | "en-WL" | "de-CH" | "af-ZA" | "eu-ES" | "hr-HR" | "cs-CZ" | "da-DK" | "fa-IR" | "gl-ES" | "el-GR" | "he-IL" | "id-ID" | "lv-LV" | "ms-MY" | "ro-RO" | "ru-RU" | "sr-RS" | "sk-SK" | "so-SO" | "tl-PH" | "uk-UA" | "vi-VN" | "zu-ZA") def media_sample_rate_hertz: () -> ::Integer def media_encoding: () -> ("pcm" | "ogg-opus" | "flac") def vocabulary_name: () -> ::String @@ -133,7 +133,7 @@ module Aws end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/TranscribeStreamingService/Client.html#start_medical_stream_transcription-instance_method def start_medical_stream_transcription: ( - language_code: ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "hi-IN" | "th-TH"), + language_code: ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "th-TH" | "es-ES" | "ar-SA" | "pt-PT" | "ca-ES" | "ar-AE" | "hi-IN" | "zh-HK" | "nl-NL" | "no-NO" | "sv-SE" | "pl-PL" | "fi-FI" | "zh-TW" | "en-IN" | "en-IE" | "en-NZ" | "en-AB" | "en-ZA" | "en-WL" | "de-CH" | "af-ZA" | "eu-ES" | "hr-HR" | "cs-CZ" | "da-DK" | "fa-IR" | "gl-ES" | "el-GR" | "he-IL" | "id-ID" | "lv-LV" | "ms-MY" | "ro-RO" | "ru-RU" | "sr-RS" | "sk-SK" | "so-SO" | "tl-PH" | "uk-UA" | "vi-VN" | "zu-ZA"), media_sample_rate_hertz: ::Integer, media_encoding: ("pcm" | "ogg-opus" | "flac"), ?vocabulary_name: ::String, @@ -151,7 +151,7 @@ module Aws interface _StartStreamTranscriptionResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::StartStreamTranscriptionResponse] def request_id: () -> ::String - def language_code: () -> ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "hi-IN" | "th-TH") + def language_code: () -> ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "th-TH" | "es-ES" | "ar-SA" | "pt-PT" | "ca-ES" | "ar-AE" | "hi-IN" | "zh-HK" | "nl-NL" | "no-NO" | "sv-SE" | "pl-PL" | "fi-FI" | "zh-TW" | "en-IN" | "en-IE" | "en-NZ" | "en-AB" | "en-ZA" | "en-WL" | "de-CH" | "af-ZA" | "eu-ES" | "hr-HR" | "cs-CZ" | "da-DK" | "fa-IR" | "gl-ES" | "el-GR" | "he-IL" | "id-ID" | "lv-LV" | "ms-MY" | "ro-RO" | "ru-RU" | "sr-RS" | "sk-SK" | "so-SO" | "tl-PH" | "uk-UA" | "vi-VN" | "zu-ZA") def media_sample_rate_hertz: () -> ::Integer def media_encoding: () -> ("pcm" | "ogg-opus" | "flac") def vocabulary_name: () -> ::String @@ -170,14 +170,14 @@ module Aws def language_model_name: () -> ::String def identify_language: () -> bool def language_options: () -> ::String - def preferred_language: () -> ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "hi-IN" | "th-TH") + def preferred_language: () -> ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "th-TH" | "es-ES" | "ar-SA" | "pt-PT" | "ca-ES" | "ar-AE" | "hi-IN" | "zh-HK" | "nl-NL" | "no-NO" | "sv-SE" | "pl-PL" | "fi-FI" | "zh-TW" | "en-IN" | "en-IE" | "en-NZ" | "en-AB" | "en-ZA" | "en-WL" | "de-CH" | "af-ZA" | "eu-ES" | "hr-HR" | "cs-CZ" | "da-DK" | "fa-IR" | "gl-ES" | "el-GR" | "he-IL" | "id-ID" | "lv-LV" | "ms-MY" | "ro-RO" | "ru-RU" | "sr-RS" | "sk-SK" | "so-SO" | "tl-PH" | "uk-UA" | "vi-VN" | "zu-ZA") def identify_multiple_languages: () -> bool def vocabulary_names: () -> ::String def vocabulary_filter_names: () -> ::String end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/TranscribeStreamingService/Client.html#start_stream_transcription-instance_method def start_stream_transcription: ( - ?language_code: ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "hi-IN" | "th-TH"), + ?language_code: ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "th-TH" | "es-ES" | "ar-SA" | "pt-PT" | "ca-ES" | "ar-AE" | "hi-IN" | "zh-HK" | "nl-NL" | "no-NO" | "sv-SE" | "pl-PL" | "fi-FI" | "zh-TW" | "en-IN" | "en-IE" | "en-NZ" | "en-AB" | "en-ZA" | "en-WL" | "de-CH" | "af-ZA" | "eu-ES" | "hr-HR" | "cs-CZ" | "da-DK" | "fa-IR" | "gl-ES" | "el-GR" | "he-IL" | "id-ID" | "lv-LV" | "ms-MY" | "ro-RO" | "ru-RU" | "sr-RS" | "sk-SK" | "so-SO" | "tl-PH" | "uk-UA" | "vi-VN" | "zu-ZA"), media_sample_rate_hertz: ::Integer, media_encoding: ("pcm" | "ogg-opus" | "flac"), ?vocabulary_name: ::String, @@ -196,7 +196,7 @@ module Aws ?language_model_name: ::String, ?identify_language: bool, ?language_options: ::String, - ?preferred_language: ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "hi-IN" | "th-TH"), + ?preferred_language: ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "th-TH" | "es-ES" | "ar-SA" | "pt-PT" | "ca-ES" | "ar-AE" | "hi-IN" | "zh-HK" | "nl-NL" | "no-NO" | "sv-SE" | "pl-PL" | "fi-FI" | "zh-TW" | "en-IN" | "en-IE" | "en-NZ" | "en-AB" | "en-ZA" | "en-WL" | "de-CH" | "af-ZA" | "eu-ES" | "hr-HR" | "cs-CZ" | "da-DK" | "fa-IR" | "gl-ES" | "el-GR" | "he-IL" | "id-ID" | "lv-LV" | "ms-MY" | "ro-RO" | "ru-RU" | "sr-RS" | "sk-SK" | "so-SO" | "tl-PH" | "uk-UA" | "vi-VN" | "zu-ZA"), ?identify_multiple_languages: bool, ?vocabulary_names: ::String, ?vocabulary_filter_names: ::String diff --git a/gems/aws-sdk-transcribestreamingservice/sig/types.rbs b/gems/aws-sdk-transcribestreamingservice/sig/types.rbs index 925b765cd15..c4746843775 100644 --- a/gems/aws-sdk-transcribestreamingservice/sig/types.rbs +++ b/gems/aws-sdk-transcribestreamingservice/sig/types.rbs @@ -114,7 +114,7 @@ module Aws::TranscribeStreamingService end class LanguageWithScore - attr_accessor language_code: ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "hi-IN" | "th-TH") + attr_accessor language_code: ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "th-TH" | "es-ES" | "ar-SA" | "pt-PT" | "ca-ES" | "ar-AE" | "hi-IN" | "zh-HK" | "nl-NL" | "no-NO" | "sv-SE" | "pl-PL" | "fi-FI" | "zh-TW" | "en-IN" | "en-IE" | "en-NZ" | "en-AB" | "en-ZA" | "en-WL" | "de-CH" | "af-ZA" | "eu-ES" | "hr-HR" | "cs-CZ" | "da-DK" | "fa-IR" | "gl-ES" | "el-GR" | "he-IL" | "id-ID" | "lv-LV" | "ms-MY" | "ro-RO" | "ru-RU" | "sr-RS" | "sk-SK" | "so-SO" | "tl-PH" | "uk-UA" | "vi-VN" | "zu-ZA") attr_accessor score: ::Float SENSITIVE: [] end @@ -192,7 +192,7 @@ module Aws::TranscribeStreamingService attr_accessor is_partial: bool attr_accessor alternatives: ::Array[Types::Alternative] attr_accessor channel_id: ::String - attr_accessor language_code: ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "hi-IN" | "th-TH") + attr_accessor language_code: ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "th-TH" | "es-ES" | "ar-SA" | "pt-PT" | "ca-ES" | "ar-AE" | "hi-IN" | "zh-HK" | "nl-NL" | "no-NO" | "sv-SE" | "pl-PL" | "fi-FI" | "zh-TW" | "en-IN" | "en-IE" | "en-NZ" | "en-AB" | "en-ZA" | "en-WL" | "de-CH" | "af-ZA" | "eu-ES" | "hr-HR" | "cs-CZ" | "da-DK" | "fa-IR" | "gl-ES" | "el-GR" | "he-IL" | "id-ID" | "lv-LV" | "ms-MY" | "ro-RO" | "ru-RU" | "sr-RS" | "sk-SK" | "so-SO" | "tl-PH" | "uk-UA" | "vi-VN" | "zu-ZA") attr_accessor language_identification: ::Array[Types::LanguageWithScore] SENSITIVE: [] end @@ -241,7 +241,7 @@ module Aws::TranscribeStreamingService end class StartMedicalStreamTranscriptionRequest - attr_accessor language_code: ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "hi-IN" | "th-TH") + attr_accessor language_code: ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "th-TH" | "es-ES" | "ar-SA" | "pt-PT" | "ca-ES" | "ar-AE" | "hi-IN" | "zh-HK" | "nl-NL" | "no-NO" | "sv-SE" | "pl-PL" | "fi-FI" | "zh-TW" | "en-IN" | "en-IE" | "en-NZ" | "en-AB" | "en-ZA" | "en-WL" | "de-CH" | "af-ZA" | "eu-ES" | "hr-HR" | "cs-CZ" | "da-DK" | "fa-IR" | "gl-ES" | "el-GR" | "he-IL" | "id-ID" | "lv-LV" | "ms-MY" | "ro-RO" | "ru-RU" | "sr-RS" | "sk-SK" | "so-SO" | "tl-PH" | "uk-UA" | "vi-VN" | "zu-ZA") attr_accessor media_sample_rate_hertz: ::Integer attr_accessor media_encoding: ("pcm" | "ogg-opus" | "flac") attr_accessor vocabulary_name: ::String @@ -258,7 +258,7 @@ module Aws::TranscribeStreamingService class StartMedicalStreamTranscriptionResponse attr_accessor request_id: ::String - attr_accessor language_code: ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "hi-IN" | "th-TH") + attr_accessor language_code: ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "th-TH" | "es-ES" | "ar-SA" | "pt-PT" | "ca-ES" | "ar-AE" | "hi-IN" | "zh-HK" | "nl-NL" | "no-NO" | "sv-SE" | "pl-PL" | "fi-FI" | "zh-TW" | "en-IN" | "en-IE" | "en-NZ" | "en-AB" | "en-ZA" | "en-WL" | "de-CH" | "af-ZA" | "eu-ES" | "hr-HR" | "cs-CZ" | "da-DK" | "fa-IR" | "gl-ES" | "el-GR" | "he-IL" | "id-ID" | "lv-LV" | "ms-MY" | "ro-RO" | "ru-RU" | "sr-RS" | "sk-SK" | "so-SO" | "tl-PH" | "uk-UA" | "vi-VN" | "zu-ZA") attr_accessor media_sample_rate_hertz: ::Integer attr_accessor media_encoding: ("pcm" | "ogg-opus" | "flac") attr_accessor vocabulary_name: ::String @@ -274,7 +274,7 @@ module Aws::TranscribeStreamingService end class StartStreamTranscriptionRequest - attr_accessor language_code: ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "hi-IN" | "th-TH") + attr_accessor language_code: ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "th-TH" | "es-ES" | "ar-SA" | "pt-PT" | "ca-ES" | "ar-AE" | "hi-IN" | "zh-HK" | "nl-NL" | "no-NO" | "sv-SE" | "pl-PL" | "fi-FI" | "zh-TW" | "en-IN" | "en-IE" | "en-NZ" | "en-AB" | "en-ZA" | "en-WL" | "de-CH" | "af-ZA" | "eu-ES" | "hr-HR" | "cs-CZ" | "da-DK" | "fa-IR" | "gl-ES" | "el-GR" | "he-IL" | "id-ID" | "lv-LV" | "ms-MY" | "ro-RO" | "ru-RU" | "sr-RS" | "sk-SK" | "so-SO" | "tl-PH" | "uk-UA" | "vi-VN" | "zu-ZA") attr_accessor media_sample_rate_hertz: ::Integer attr_accessor media_encoding: ("pcm" | "ogg-opus" | "flac") attr_accessor vocabulary_name: ::String @@ -293,7 +293,7 @@ module Aws::TranscribeStreamingService attr_accessor language_model_name: ::String attr_accessor identify_language: bool attr_accessor language_options: ::String - attr_accessor preferred_language: ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "hi-IN" | "th-TH") + attr_accessor preferred_language: ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "th-TH" | "es-ES" | "ar-SA" | "pt-PT" | "ca-ES" | "ar-AE" | "hi-IN" | "zh-HK" | "nl-NL" | "no-NO" | "sv-SE" | "pl-PL" | "fi-FI" | "zh-TW" | "en-IN" | "en-IE" | "en-NZ" | "en-AB" | "en-ZA" | "en-WL" | "de-CH" | "af-ZA" | "eu-ES" | "hr-HR" | "cs-CZ" | "da-DK" | "fa-IR" | "gl-ES" | "el-GR" | "he-IL" | "id-ID" | "lv-LV" | "ms-MY" | "ro-RO" | "ru-RU" | "sr-RS" | "sk-SK" | "so-SO" | "tl-PH" | "uk-UA" | "vi-VN" | "zu-ZA") attr_accessor identify_multiple_languages: bool attr_accessor vocabulary_names: ::String attr_accessor vocabulary_filter_names: ::String @@ -302,7 +302,7 @@ module Aws::TranscribeStreamingService class StartStreamTranscriptionResponse attr_accessor request_id: ::String - attr_accessor language_code: ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "hi-IN" | "th-TH") + attr_accessor language_code: ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "th-TH" | "es-ES" | "ar-SA" | "pt-PT" | "ca-ES" | "ar-AE" | "hi-IN" | "zh-HK" | "nl-NL" | "no-NO" | "sv-SE" | "pl-PL" | "fi-FI" | "zh-TW" | "en-IN" | "en-IE" | "en-NZ" | "en-AB" | "en-ZA" | "en-WL" | "de-CH" | "af-ZA" | "eu-ES" | "hr-HR" | "cs-CZ" | "da-DK" | "fa-IR" | "gl-ES" | "el-GR" | "he-IL" | "id-ID" | "lv-LV" | "ms-MY" | "ro-RO" | "ru-RU" | "sr-RS" | "sk-SK" | "so-SO" | "tl-PH" | "uk-UA" | "vi-VN" | "zu-ZA") attr_accessor media_sample_rate_hertz: ::Integer attr_accessor media_encoding: ("pcm" | "ogg-opus" | "flac") attr_accessor vocabulary_name: ::String @@ -321,7 +321,7 @@ module Aws::TranscribeStreamingService attr_accessor language_model_name: ::String attr_accessor identify_language: bool attr_accessor language_options: ::String - attr_accessor preferred_language: ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "hi-IN" | "th-TH") + attr_accessor preferred_language: ("en-US" | "en-GB" | "es-US" | "fr-CA" | "fr-FR" | "en-AU" | "it-IT" | "de-DE" | "pt-BR" | "ja-JP" | "ko-KR" | "zh-CN" | "th-TH" | "es-ES" | "ar-SA" | "pt-PT" | "ca-ES" | "ar-AE" | "hi-IN" | "zh-HK" | "nl-NL" | "no-NO" | "sv-SE" | "pl-PL" | "fi-FI" | "zh-TW" | "en-IN" | "en-IE" | "en-NZ" | "en-AB" | "en-ZA" | "en-WL" | "de-CH" | "af-ZA" | "eu-ES" | "hr-HR" | "cs-CZ" | "da-DK" | "fa-IR" | "gl-ES" | "el-GR" | "he-IL" | "id-ID" | "lv-LV" | "ms-MY" | "ro-RO" | "ru-RU" | "sr-RS" | "sk-SK" | "so-SO" | "tl-PH" | "uk-UA" | "vi-VN" | "zu-ZA") attr_accessor identify_multiple_languages: bool attr_accessor vocabulary_names: ::String attr_accessor vocabulary_filter_names: ::String