From 584e3941f3f20727fe913d4d4204d67ccea86f94 Mon Sep 17 00:00:00 2001 From: AWS SDK for Ruby Date: Thu, 2 Jun 2022 18:12:43 +0000 Subject: [PATCH] Updated API models and rebuilt service gems. --- .../2018-11-25/api-2.json | 8 +- .../2018-11-25/docs-2.json | 30 +- apis/codeartifact/2018-09-22/docs-2.json | 178 +-- apis/connect/2017-08-08/api-2.json | 561 +++++++- apis/connect/2017-08-08/docs-2.json | 376 +++++- apis/connect/2017-08-08/paginators-1.json | 6 + apis/kendra/2019-02-03/api-2.json | 97 +- apis/kendra/2019-02-03/docs-2.json | 92 +- apis/proton/2020-07-20/api-2.json | 390 +++++- apis/proton/2020-07-20/docs-2.json | 366 ++++-- apis/proton/2020-07-20/paginators-1.json | 16 + apis/proton/2020-07-20/waiters-2.json | 33 + apis/voice-id/2021-09-27/api-2.json | 23 +- apis/voice-id/2021-09-27/docs-2.json | 55 +- gems/aws-sdk-applicationinsights/CHANGELOG.md | 5 + gems/aws-sdk-applicationinsights/VERSION | 2 +- .../lib/aws-sdk-applicationinsights.rb | 2 +- .../lib/aws-sdk-applicationinsights/client.rb | 28 +- .../aws-sdk-applicationinsights/client_api.rb | 2 + .../lib/aws-sdk-applicationinsights/types.rb | 34 +- gems/aws-sdk-codeartifact/CHANGELOG.md | 5 + gems/aws-sdk-codeartifact/VERSION | 2 +- .../lib/aws-sdk-codeartifact.rb | 2 +- .../lib/aws-sdk-codeartifact/client.rb | 334 ++--- .../lib/aws-sdk-codeartifact/types.rb | 419 ++---- gems/aws-sdk-connect/CHANGELOG.md | 5 + gems/aws-sdk-connect/VERSION | 2 +- gems/aws-sdk-connect/lib/aws-sdk-connect.rb | 2 +- .../lib/aws-sdk-connect/client.rb | 530 +++++++- .../lib/aws-sdk-connect/client_api.rb | 316 ++++- .../lib/aws-sdk-connect/errors.rb | 21 + .../lib/aws-sdk-connect/types.rb | 1125 ++++++++++++++++- gems/aws-sdk-kendra/CHANGELOG.md | 5 + gems/aws-sdk-kendra/VERSION | 2 +- gems/aws-sdk-kendra/lib/aws-sdk-kendra.rb | 2 +- .../lib/aws-sdk-kendra/client.rb | 260 +++- .../lib/aws-sdk-kendra/client_api.rb | 56 + .../lib/aws-sdk-kendra/types.rb | 790 +++++++++++- gems/aws-sdk-proton/CHANGELOG.md | 5 + gems/aws-sdk-proton/VERSION | 2 +- gems/aws-sdk-proton/lib/aws-sdk-proton.rb | 2 +- .../lib/aws-sdk-proton/client.rb | 825 ++++++++++-- .../lib/aws-sdk-proton/client_api.rb | 271 +++- .../lib/aws-sdk-proton/types.rb | 977 ++++++++++++-- .../lib/aws-sdk-proton/waiters.rb | 91 ++ gems/aws-sdk-voiceid/CHANGELOG.md | 5 + gems/aws-sdk-voiceid/VERSION | 2 +- gems/aws-sdk-voiceid/lib/aws-sdk-voiceid.rb | 2 +- .../lib/aws-sdk-voiceid/client.rb | 46 +- .../lib/aws-sdk-voiceid/client_api.rb | 11 + .../lib/aws-sdk-voiceid/types.rb | 99 +- 51 files changed, 7500 insertions(+), 1020 deletions(-) diff --git a/apis/application-insights/2018-11-25/api-2.json b/apis/application-insights/2018-11-25/api-2.json index ebbfd6ca25a..1072fb248ac 100644 --- a/apis/application-insights/2018-11-25/api-2.json +++ b/apis/application-insights/2018-11-25/api-2.json @@ -530,7 +530,8 @@ "OpsItemSNSTopicArn":{"shape":"OpsItemSNSTopicArn"}, "Tags":{"shape":"TagList"}, "AutoConfigEnabled":{"shape":"AutoConfigEnabled"}, - "AutoCreate":{"shape":"AutoCreate"} + "AutoCreate":{"shape":"AutoCreate"}, + "GroupingType":{"shape":"GroupingType"} } }, "CreateApplicationResponse":{ @@ -799,6 +800,10 @@ "NOT_USEFUL" ] }, + "GroupingType":{ + "type":"string", + "enum":["ACCOUNT_BASED"] + }, "HealthEventArn":{"type":"string"}, "HealthEventDescription":{"type":"string"}, "HealthEventTypeCategory":{"type":"string"}, @@ -1144,6 +1149,7 @@ "SeverityLevel":{ "type":"string", "enum":[ + "Informative", "Low", "Medium", "High" diff --git a/apis/application-insights/2018-11-25/docs-2.json b/apis/application-insights/2018-11-25/docs-2.json index c1a1bb0445c..7c019f2f1d4 100644 --- a/apis/application-insights/2018-11-25/docs-2.json +++ b/apis/application-insights/2018-11-25/docs-2.json @@ -82,16 +82,16 @@ "AutoConfigEnabled": { "base": null, "refs": { - "ApplicationInfo$AutoConfigEnabled": null, - "CreateApplicationRequest$AutoConfigEnabled": null, - "UpdateApplicationRequest$AutoConfigEnabled": null, - "UpdateComponentConfigurationRequest$AutoConfigEnabled": null + "ApplicationInfo$AutoConfigEnabled": "

Indicates whether auto-configuration is turned on for this application.

", + "CreateApplicationRequest$AutoConfigEnabled": "

Indicates whether Application Insights automatically configures unmonitored resources in the resource group.

", + "UpdateApplicationRequest$AutoConfigEnabled": "

Turns auto-configuration on or off.

", + "UpdateComponentConfigurationRequest$AutoConfigEnabled": "

Automatically configures the component by applying the recommended configurations.

" } }, "AutoCreate": { "base": null, "refs": { - "CreateApplicationRequest$AutoCreate": null + "CreateApplicationRequest$AutoCreate": "

Configures all of the resources in the resource group by applying the recommended configurations.

" } }, "BadRequestException": { @@ -170,7 +170,7 @@ "DescribeComponentConfigurationRecommendationRequest$ComponentName": "

The name of the component.

", "DescribeComponentConfigurationRequest$ComponentName": "

The name of the component.

", "DescribeComponentRequest$ComponentName": "

The name of the component.

", - "ListProblemsRequest$ComponentName": null, + "ListProblemsRequest$ComponentName": "

The name of the component.

", "UpdateComponentConfigurationRequest$ComponentName": "

The name of the component.

" } }, @@ -381,7 +381,7 @@ "DiscoveryType": { "base": null, "refs": { - "ApplicationInfo$DiscoveryType": null + "ApplicationInfo$DiscoveryType": "

The method used by Application Insights to onboard your resources.

" } }, "EbsCause": { @@ -459,6 +459,12 @@ "Feedback$value": null } }, + "GroupingType": { + "base": null, + "refs": { + "CreateApplicationRequest$GroupingType": "

Application Insights can create applications based on a resource group or on an account. To create an account-based application using all of the resources in the account, set this parameter to ACCOUNT_BASED.

" + } + }, "HealthEventArn": { "base": null, "refs": { @@ -503,7 +509,7 @@ "LastRecurrenceTime": { "base": null, "refs": { - "Problem$LastRecurrenceTime": null + "Problem$LastRecurrenceTime": "

The last time that the problem reoccurred after its last resolution.

" } }, "LifeCycle": { @@ -803,7 +809,7 @@ "RecurringCount": { "base": null, "refs": { - "Problem$RecurringCount": null + "Problem$RecurringCount": "

The number of times that the same problem reoccurred after the first time it was resolved.

" } }, "RelatedObservations": { @@ -855,7 +861,7 @@ "ListLogPatternsRequest$ResourceGroupName": "

The name of the resource group.

", "ListLogPatternsResponse$ResourceGroupName": "

The name of the resource group.

", "ListProblemsRequest$ResourceGroupName": "

The name of the resource group.

", - "ListProblemsResponse$ResourceGroupName": null, + "ListProblemsResponse$ResourceGroupName": "

The name of the resource group.

", "Problem$ResourceGroupName": "

The name of the resource group affected by the problem.

", "UpdateApplicationRequest$ResourceGroupName": "

The name of the resource group.

", "UpdateComponentConfigurationRequest$ResourceGroupName": "

The name of the resource group.

", @@ -1003,10 +1009,10 @@ "base": null, "refs": { "ApplicationComponent$Tier": "

The stack tier of the application component.

", - "DescribeComponentConfigurationRecommendationRequest$Tier": "

The tier of the application component. Supported tiers include DOT_NET_CORE, DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT.

", + "DescribeComponentConfigurationRecommendationRequest$Tier": "

The tier of the application component.

", "DescribeComponentConfigurationResponse$Tier": "

The tier of the application component. Supported tiers include DOT_NET_CORE, DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT

", "DetectedWorkload$key": null, - "UpdateComponentConfigurationRequest$Tier": "

The tier of the application component. Supported tiers include DOT_NET_WORKER, DOT_NET_WEB, DOT_NET_CORE, SQL_SERVER, and DEFAULT.

" + "UpdateComponentConfigurationRequest$Tier": "

The tier of the application component.

" } }, "Title": { diff --git a/apis/codeartifact/2018-09-22/docs-2.json b/apis/codeartifact/2018-09-22/docs-2.json index 25fb61cb93d..1a3a293e092 100644 --- a/apis/codeartifact/2018-09-22/docs-2.json +++ b/apis/codeartifact/2018-09-22/docs-2.json @@ -1,40 +1,40 @@ { "version": "2.0", - "service": "

AWS CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, and pip. You can use CodeArtifact to share packages with development teams and pull packages. Packages can be pulled from both public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact repository and another repository, which effectively merges their contents from the point of view of a package manager client.

AWS CodeArtifact Components

Use the information in this guide to help you work with the following CodeArtifact components:

CodeArtifact supports these operations:

", + "service": "

CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to share packages with development teams and pull packages. Packages can be pulled from both public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact repository and another repository, which effectively merges their contents from the point of view of a package manager client.

CodeArtifact Components

Use the information in this guide to help you work with the following CodeArtifact components:

CodeArtifact supports these operations:

", "operations": { "AssociateExternalConnection": "

Adds an existing external connection to a repository. One external connection is allowed per repository.

A repository can have one or more upstream repositories, or an external connection.

", "CopyPackageVersions": "

Copies package versions from one repository to another repository in the same domain.

You must specify versions or versionRevisions. You cannot specify both.

", - "CreateDomain": "

Creates a domain. CodeArtifact domains make it easier to manage multiple repositories across an organization. You can use a domain to apply permissions across many repositories owned by different AWS accounts. An asset is stored only once in a domain, even if it's in multiple repositories.

Although you can have multiple domains, we recommend a single production domain that contains all published artifacts so that your development teams can find and share packages. You can use a second pre-production domain to test changes to the production domain configuration.

", + "CreateDomain": "

Creates a domain. CodeArtifact domains make it easier to manage multiple repositories across an organization. You can use a domain to apply permissions across many repositories owned by different Amazon Web Services accounts. An asset is stored only once in a domain, even if it's in multiple repositories.

Although you can have multiple domains, we recommend a single production domain that contains all published artifacts so that your development teams can find and share packages. You can use a second pre-production domain to test changes to the production domain configuration.

", "CreateRepository": "

Creates a repository.

", "DeleteDomain": "

Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories.

", "DeleteDomainPermissionsPolicy": "

Deletes the resource policy set on a domain.

", "DeletePackageVersions": "

Deletes one or more versions of a package. A deleted package version cannot be restored in your repository. If you want to remove a package version from your repository and be able to restore it later, set its status to Archived. Archived packages cannot be downloaded from a repository and don't show up with list package APIs (for example, ListackageVersions), but you can restore them using UpdatePackageVersionsStatus.

", "DeleteRepository": "

Deletes a repository.

", - "DeleteRepositoryPermissionsPolicy": "

Deletes the resource policy that is set on a repository. After a resource policy is deleted, the permissions allowed and denied by the deleted policy are removed. The effect of deleting a resource policy might not be immediate.

Use DeleteRepositoryPermissionsPolicy with caution. After a policy is deleted, AWS users, roles, and accounts lose permissions to perform the repository actions granted by the deleted policy.

", + "DeleteRepositoryPermissionsPolicy": "

Deletes the resource policy that is set on a repository. After a resource policy is deleted, the permissions allowed and denied by the deleted policy are removed. The effect of deleting a resource policy might not be immediate.

Use DeleteRepositoryPermissionsPolicy with caution. After a policy is deleted, Amazon Web Services users, roles, and accounts lose permissions to perform the repository actions granted by the deleted policy.

", "DescribeDomain": "

Returns a DomainDescription object that contains information about the requested domain.

", "DescribePackageVersion": "

Returns a PackageVersionDescription object that contains information about the requested package version.

", "DescribeRepository": "

Returns a RepositoryDescription object that contains detailed information about the requested repository.

", "DisassociateExternalConnection": "

Removes an existing external connection from a repository.

", "DisposePackageVersions": "

Deletes the assets in package versions and sets the package versions' status to Disposed. A disposed package version cannot be restored in your repository because its assets are deleted.

To view all disposed package versions in a repository, use ListPackageVersions and set the status parameter to Disposed.

To view information about a disposed package version, use DescribePackageVersion.

", - "GetAuthorizationToken": "

Generates a temporary authorization token for accessing repositories in the domain. This API requires the codeartifact:GetAuthorizationToken and sts:GetServiceBearerToken permissions. For more information about authorization tokens, see AWS CodeArtifact authentication and tokens.

CodeArtifact authorization tokens are valid for a period of 12 hours when created with the login command. You can call login periodically to refresh the token. When you create an authorization token with the GetAuthorizationToken API, you can set a custom authorization period, up to a maximum of 12 hours, with the durationSeconds parameter.

The authorization period begins after login or GetAuthorizationToken is called. If login or GetAuthorizationToken is called while assuming a role, the token lifetime is independent of the maximum session duration of the role. For example, if you call sts assume-role and specify a session duration of 15 minutes, then generate a CodeArtifact authorization token, the token will be valid for the full authorization period even though this is longer than the 15-minute session duration.

See Using IAM Roles for more information on controlling session duration.

", - "GetDomainPermissionsPolicy": "

Returns the resource policy attached to the specified domain.

The policy is a resource-based policy, not an identity-based policy. For more information, see Identity-based policies and resource-based policies in the AWS Identity and Access Management User Guide.

", + "GetAuthorizationToken": "

Generates a temporary authorization token for accessing repositories in the domain. This API requires the codeartifact:GetAuthorizationToken and sts:GetServiceBearerToken permissions. For more information about authorization tokens, see CodeArtifact authentication and tokens.

CodeArtifact authorization tokens are valid for a period of 12 hours when created with the login command. You can call login periodically to refresh the token. When you create an authorization token with the GetAuthorizationToken API, you can set a custom authorization period, up to a maximum of 12 hours, with the durationSeconds parameter.

The authorization period begins after login or GetAuthorizationToken is called. If login or GetAuthorizationToken is called while assuming a role, the token lifetime is independent of the maximum session duration of the role. For example, if you call sts assume-role and specify a session duration of 15 minutes, then generate a CodeArtifact authorization token, the token will be valid for the full authorization period even though this is longer than the 15-minute session duration.

See Using IAM Roles for more information on controlling session duration.

", + "GetDomainPermissionsPolicy": "

Returns the resource policy attached to the specified domain.

The policy is a resource-based policy, not an identity-based policy. For more information, see Identity-based policies and resource-based policies in the IAM User Guide.

", "GetPackageVersionAsset": "

Returns an asset (or file) that is in a package. For example, for a Maven package version, use GetPackageVersionAsset to download a JAR file, a POM file, or any other assets in the package version.

", - "GetPackageVersionReadme": "

Gets the readme file or descriptive text for a package version. For packages that do not contain a readme file, CodeArtifact extracts a description from a metadata file. For example, from the <description> element in the pom.xml file of a Maven package.

The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.

", - "GetRepositoryEndpoint": "

Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:

", + "GetPackageVersionReadme": "

Gets the readme file or descriptive text for a package version.

The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.

", + "GetRepositoryEndpoint": "

Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:

", "GetRepositoryPermissionsPolicy": "

Returns the resource policy that is set on a repository.

", - "ListDomains": "

Returns a list of DomainSummary objects for all domains owned by the AWS account that makes this call. Each returned DomainSummary object contains information about a domain.

", + "ListDomains": "

Returns a list of DomainSummary objects for all domains owned by the Amazon Web Services account that makes this call. Each returned DomainSummary object contains information about a domain.

", "ListPackageVersionAssets": "

Returns a list of AssetSummary objects for assets in a package version.

", "ListPackageVersionDependencies": "

Returns the direct dependencies for a package version. The dependencies are returned as PackageDependency objects. CodeArtifact extracts the dependencies for a package version from the metadata file for the package format (for example, the package.json file for npm packages and the pom.xml file for Maven). Any package version dependencies that are not listed in the configuration file are not returned.

", "ListPackageVersions": "

Returns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters.

", "ListPackages": "

Returns a list of PackageSummary objects for packages in a repository that match the request parameters.

", - "ListRepositories": "

Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified AWS account and that matches the input parameters.

", + "ListRepositories": "

Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified Amazon Web Services account and that matches the input parameters.

", "ListRepositoriesInDomain": "

Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified domain and that matches the input parameters.

", - "ListTagsForResource": "

Gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeArtifact.

", + "ListTagsForResource": "

Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.

", "PutDomainPermissionsPolicy": "

Sets a resource policy on a domain that specifies permissions to access it.

When you call PutDomainPermissionsPolicy, the resource policy on the domain is ignored when evaluting permissions. This ensures that the owner of a domain cannot lock themselves out of the domain, which would prevent them from being able to update the resource policy.

", "PutRepositoryPermissionsPolicy": "

Sets the resource policy on a repository that specifies permissions to access it.

When you call PutRepositoryPermissionsPolicy, the resource policy on the repository is ignored when evaluting permissions. This ensures that the owner of a repository cannot lock themselves out of the repository, which would prevent them from being able to update the resource policy.

", - "TagResource": "

Adds or updates tags for a resource in AWS CodeArtifact.

", - "UntagResource": "

Removes tags from a resource in AWS CodeArtifact.

", - "UpdatePackageVersionsStatus": "

Updates the status of one or more versions of a package.

", + "TagResource": "

Adds or updates tags for a resource in CodeArtifact.

", + "UntagResource": "

Removes tags from a resource in CodeArtifact.

", + "UpdatePackageVersionsStatus": "

Updates the status of one or more versions of a package. Using UpdatePackageVersionsStatus, you can update the status of package versions to Archived, Published, or Unlisted. To set the status of a package version to Disposed, use DisposePackageVersions.

", "UpdateRepository": "

Update the properties of a repository.

" }, "shapes": { @@ -46,49 +46,49 @@ "AccountId": { "base": null, "refs": { - "AssociateExternalConnectionRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "CopyPackageVersionsRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "CreateRepositoryRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "DeleteDomainPermissionsPolicyRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "DeleteDomainRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "DeletePackageVersionsRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "DeleteRepositoryPermissionsPolicyRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "DeleteRepositoryRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "DescribeDomainRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "DescribePackageVersionRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "DescribeRepositoryRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "DisassociateExternalConnectionRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "DisposePackageVersionsRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "DomainDescription$owner": "

The AWS account ID that owns the domain.

", - "DomainSummary$owner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "GetAuthorizationTokenRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "GetDomainPermissionsPolicyRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "GetPackageVersionAssetRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "GetPackageVersionReadmeRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "GetRepositoryEndpointRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain that contains the repository. It does not include dashes or spaces.

", - "GetRepositoryPermissionsPolicyRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "ListPackageVersionAssetsRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "ListPackageVersionDependenciesRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "ListPackageVersionsRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "ListPackagesRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "ListRepositoriesInDomainRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "ListRepositoriesInDomainRequest$administratorAccount": "

Filter the list of repositories to only include those that are managed by the AWS account ID.

", - "PutDomainPermissionsPolicyRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "PutRepositoryPermissionsPolicyRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "RepositoryDescription$administratorAccount": "

The 12-digit account number of the AWS account that manages the repository.

", - "RepositoryDescription$domainOwner": "

The 12-digit account number of the AWS account that owns the domain that contains the repository. It does not include dashes or spaces.

", - "RepositorySummary$administratorAccount": "

The AWS account ID that manages the repository.

", - "RepositorySummary$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "UpdatePackageVersionsStatusRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

", - "UpdateRepositoryRequest$domainOwner": "

The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

" + "AssociateExternalConnectionRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "CopyPackageVersionsRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "CreateRepositoryRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "DeleteDomainPermissionsPolicyRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "DeleteDomainRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "DeletePackageVersionsRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "DeleteRepositoryPermissionsPolicyRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "DeleteRepositoryRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "DescribeDomainRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "DescribePackageVersionRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "DescribeRepositoryRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "DisassociateExternalConnectionRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "DisposePackageVersionsRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "DomainDescription$owner": "

The Amazon Web Services account ID that owns the domain.

", + "DomainSummary$owner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "GetAuthorizationTokenRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "GetDomainPermissionsPolicyRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "GetPackageVersionAssetRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "GetPackageVersionReadmeRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "GetRepositoryEndpointRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces.

", + "GetRepositoryPermissionsPolicyRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "ListPackageVersionAssetsRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "ListPackageVersionDependenciesRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "ListPackageVersionsRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "ListPackagesRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "ListRepositoriesInDomainRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "ListRepositoriesInDomainRequest$administratorAccount": "

Filter the list of repositories to only include those that are managed by the Amazon Web Services account ID.

", + "PutDomainPermissionsPolicyRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "PutRepositoryPermissionsPolicyRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "RepositoryDescription$administratorAccount": "

The 12-digit account number of the Amazon Web Services account that manages the repository.

", + "RepositoryDescription$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces.

", + "RepositorySummary$administratorAccount": "

The Amazon Web Services account ID that manages the repository.

", + "RepositorySummary$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "UpdatePackageVersionsStatusRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

", + "UpdateRepositoryRequest$domainOwner": "

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

" } }, "Arn": { "base": null, "refs": { - "CreateDomainRequest$encryptionKey": "

The encryption key for the domain. This is used to encrypt content stored in a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key alias ARN. To specify an encryptionKey, your IAM role must have kms:DescribeKey and kms:CreateGrant permissions on the encryption key that is used. For more information, see DescribeKey in the AWS Key Management Service API Reference and AWS KMS API Permissions Reference in the AWS Key Management Service Developer Guide.

CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more information, see Using symmetric and asymmetric keys in the AWS Key Management Service Developer Guide.

", + "CreateDomainRequest$encryptionKey": "

The encryption key for the domain. This is used to encrypt content stored in a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key alias ARN. To specify an encryptionKey, your IAM role must have kms:DescribeKey and kms:CreateGrant permissions on the encryption key that is used. For more information, see DescribeKey in the Key Management Service API Reference and Key Management Service API Permissions Reference in the Key Management Service Developer Guide.

CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.

", "DomainDescription$arn": "

The Amazon Resource Name (ARN) of the domain.

", - "DomainDescription$encryptionKey": "

The ARN of an AWS Key Management Service (AWS KMS) key associated with a domain.

", + "DomainDescription$encryptionKey": "

The ARN of an Key Management Service (KMS) key associated with a domain.

", "DomainDescription$s3BucketArn": "

The Amazon Resource Name (ARN) of the Amazon S3 bucket that is used to store package assets in the domain.

", "DomainSummary$arn": "

The ARN of the domain.

", "DomainSummary$encryptionKey": "

The key used to encrypt the domain.

", @@ -312,7 +312,7 @@ "refs": { "AssociateExternalConnectionRequest$domain": "

The name of the domain that contains the repository.

", "CopyPackageVersionsRequest$domain": "

The name of the domain that contains the source and destination repositories.

", - "CreateDomainRequest$domain": "

The name of the domain to create. All domain names in an AWS Region that are in the same AWS account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.

", + "CreateDomainRequest$domain": "

The name of the domain to create. All domain names in an Amazon Web Services Region that are in the same Amazon Web Services account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.

", "CreateRepositoryRequest$domain": "

The name of the domain that contains the created repository.

", "DeleteDomainPermissionsPolicyRequest$domain": "

The name of the domain associated with the resource policy to be deleted.

", "DeleteDomainRequest$domain": "

The name of the domain to delete.

", @@ -348,8 +348,8 @@ "DomainStatus": { "base": null, "refs": { - "DomainDescription$status": "

The current status of a domain. The valid values are

", - "DomainSummary$status": "

A string that contains the status of the domain. The valid values are:

" + "DomainDescription$status": "

The current status of a domain.

", + "DomainSummary$status": "

A string that contains the status of the domain.

" } }, "DomainSummary": { @@ -373,7 +373,7 @@ "ExternalConnectionName": { "base": null, "refs": { - "AssociateExternalConnectionRequest$externalConnection": "

The name of the external connection to add to the repository. The following values are supported:

", + "AssociateExternalConnectionRequest$externalConnection": "

The name of the external connection to add to the repository. The following values are supported:

", "DisassociateExternalConnectionRequest$externalConnection": "

The name of the external connection to be removed from the repository.

", "RepositoryExternalConnectionInfo$externalConnectionName": "

The name of the external connection associated with a repository.

" } @@ -463,7 +463,7 @@ } }, "InternalServerException": { - "base": "

The operation did not succeed because of an error that occurred inside AWS CodeArtifact.

", + "base": "

The operation did not succeed because of an error that occurred inside CodeArtifact.

", "refs": { } }, @@ -622,25 +622,25 @@ "PackageFormat": { "base": null, "refs": { - "CopyPackageVersionsRequest$format": "

The format of the package that is copied. The valid package types are:

", - "DeletePackageVersionsRequest$format": "

The format of the package versions to delete. The valid values are:

", - "DescribePackageVersionRequest$format": "

A format that specifies the type of the requested package version. The valid values are:

", - "DisposePackageVersionsRequest$format": "

A format that specifies the type of package versions you want to dispose. The valid values are:

", - "GetPackageVersionAssetRequest$format": "

A format that specifies the type of the package version with the requested asset file. The valid values are:

", - "GetPackageVersionReadmeRequest$format": "

A format that specifies the type of the package version with the requested readme file. The valid values are:

", - "GetPackageVersionReadmeResult$format": "

The format of the package with the requested readme file. Valid format types are:

", - "GetRepositoryEndpointRequest$format": "

Returns which endpoint of a repository to return. A repository has one endpoint for each package format:

", - "ListPackageVersionAssetsRequest$format": "

The format of the package that contains the returned package version assets. The valid package types are:

", + "CopyPackageVersionsRequest$format": "

The format of the package that is copied.

", + "DeletePackageVersionsRequest$format": "

The format of the package versions to delete.

", + "DescribePackageVersionRequest$format": "

A format that specifies the type of the requested package version.

", + "DisposePackageVersionsRequest$format": "

A format that specifies the type of package versions you want to dispose.

", + "GetPackageVersionAssetRequest$format": "

A format that specifies the type of the package version with the requested asset file.

", + "GetPackageVersionReadmeRequest$format": "

A format that specifies the type of the package version with the requested readme file.

Although maven is listed as a valid value, CodeArtifact does not support displaying readme files for Maven packages.

", + "GetPackageVersionReadmeResult$format": "

The format of the package with the requested readme file.

", + "GetRepositoryEndpointRequest$format": "

Returns which endpoint of a repository to return. A repository has one endpoint for each package format.

", + "ListPackageVersionAssetsRequest$format": "

The format of the package that contains the returned package version assets.

", "ListPackageVersionAssetsResult$format": "

The format of the package that contains the returned package version assets.

", - "ListPackageVersionDependenciesRequest$format": "

The format of the package with the requested dependencies. The valid package types are:

", - "ListPackageVersionDependenciesResult$format": "

A format that specifies the type of the package that contains the returned dependencies. The valid values are:

", - "ListPackageVersionsRequest$format": "

The format of the returned packages. The valid package types are:

", - "ListPackageVersionsResult$format": "

A format of the package. Valid package format values are:

", - "ListPackagesRequest$format": "

The format of the packages. The valid package types are:

", - "PackageSummary$format": "

The format of the package. Valid values are:

", - "PackageVersionDescription$format": "

The format of the package version. The valid package formats are:

", - "RepositoryExternalConnectionInfo$packageFormat": "

The package format associated with a repository's external connection. The valid package formats are:

", - "UpdatePackageVersionsStatusRequest$format": "

A format that specifies the type of the package with the statuses to update. The valid values are:

" + "ListPackageVersionDependenciesRequest$format": "

The format of the package with the requested dependencies.

", + "ListPackageVersionDependenciesResult$format": "

A format that specifies the type of the package that contains the returned dependencies.

", + "ListPackageVersionsRequest$format": "

The format of the returned packages.

", + "ListPackageVersionsResult$format": "

A format of the package.

", + "ListPackagesRequest$format": "

The format of the packages.

", + "PackageSummary$format": "

The format of the package.

", + "PackageVersionDescription$format": "

The format of the package version.

", + "RepositoryExternalConnectionInfo$packageFormat": "

The package format associated with a repository's external connection. The valid package formats are:

", + "UpdatePackageVersionsStatusRequest$format": "

A format that specifies the type of the package with the statuses to update.

" } }, "PackageName": { @@ -788,12 +788,12 @@ "PackageVersionStatus": { "base": null, "refs": { - "DeletePackageVersionsRequest$expectedStatus": "

The expected status of the package version to delete. Valid values are:

", - "DisposePackageVersionsRequest$expectedStatus": "

The expected status of the package version to dispose. Valid values are:

", - "ListPackageVersionsRequest$status": "

A string that specifies the status of the package versions to include in the returned list. It can be one of the following:

", - "PackageVersionDescription$status": "

A string that contains the status of the package version. It can be one of the following:

", - "PackageVersionSummary$status": "

A string that contains the status of the package version. It can be one of the following:

", - "SuccessfulPackageVersionInfo$status": "

The status of a package version. Valid statuses are:

", + "DeletePackageVersionsRequest$expectedStatus": "

The expected status of the package version to delete.

", + "DisposePackageVersionsRequest$expectedStatus": "

The expected status of the package version to dispose.

", + "ListPackageVersionsRequest$status": "

A string that specifies the status of the package versions to include in the returned list.

", + "PackageVersionDescription$status": "

A string that contains the status of the package version.

", + "PackageVersionSummary$status": "

A string that contains the status of the package version. It can be one of the following:

", + "SuccessfulPackageVersionInfo$status": "

The status of a package version.

", "UpdatePackageVersionsStatusRequest$expectedStatus": "

The package version’s expected status before it is updated. If expectedStatus is provided, the package version's status is updated only if its status at the time UpdatePackageVersionsStatus is called matches expectedStatus.

", "UpdatePackageVersionsStatusRequest$targetStatus": "

The status you want to change the package version status to.

" } @@ -868,7 +868,7 @@ } }, "RepositoryDescription": { - "base": "

The details of a repository stored in AWS CodeArtifact. A CodeArtifact repository contains a set of package versions, each of which maps to a set of assets. Repositories are polyglot—a single repository can contain packages of any supported type. Each repository exposes endpoints for fetching and publishing packages using tools like the npm CLI, the Maven CLI (mvn), and pip. You can create up to 100 repositories per AWS account.

", + "base": "

The details of a repository stored in CodeArtifact. A CodeArtifact repository contains a set of package versions, each of which maps to a set of assets. Repositories are polyglot—a single repository can contain packages of any supported type. Each repository exposes endpoints for fetching and publishing packages using tools like the npm CLI, the Maven CLI (mvn), and pip. You can create up to 100 repositories per Amazon Web Services account.

", "refs": { "AssociateExternalConnectionResult$repository": "

Information about the connected repository after processing the request.

", "CreateRepositoryResult$repository": "

Information about the created repository after processing the request.

", @@ -942,7 +942,7 @@ } }, "ResourcePolicy": { - "base": "

An AWS CodeArtifact resource policy that contains a resource ARN, document details, and a revision.

", + "base": "

An CodeArtifact resource policy that contains a resource ARN, document details, and a revision.

", "refs": { "DeleteDomainPermissionsPolicyResult$policy": "

Information about the deleted resource policy after processing the request.

", "DeleteRepositoryPermissionsPolicyResult$policy": "

Information about the deleted policy after processing the request.

", @@ -955,9 +955,9 @@ "ResourceType": { "base": null, "refs": { - "ConflictException$resourceType": "

The type of AWS resource.

", - "ResourceNotFoundException$resourceType": "

The type of AWS resource.

", - "ServiceQuotaExceededException$resourceType": "

The type of AWS resource.

" + "ConflictException$resourceType": "

The type of Amazon Web Services resource.

", + "ResourceNotFoundException$resourceType": "

The type of Amazon Web Services resource.

", + "ServiceQuotaExceededException$resourceType": "

The type of Amazon Web Services resource.

" } }, "RetryAfterSeconds": { @@ -1013,13 +1013,13 @@ "base": null, "refs": { "CopyPackageVersionsResult$successfulVersions": "

A list of the package versions that were successfully copied to your repository.

", - "DeletePackageVersionsResult$successfulVersions": "

A list of the package versions that were successfully deleted.

", + "DeletePackageVersionsResult$successfulVersions": "

A list of the package versions that were successfully deleted. The status of every successful version will be Deleted.

", "DisposePackageVersionsResult$successfulVersions": "

A list of the package versions that were successfully disposed.

", "UpdatePackageVersionsStatusResult$successfulVersions": "

A list of PackageVersionError objects, one for each package version with a status that failed to update.

" } }, "Tag": { - "base": "

A tag is a key-value pair that can be used to manage, search for, or filter resources in AWS CodeArtifact.

", + "base": "

A tag is a key-value pair that can be used to manage, search for, or filter resources in CodeArtifact.

", "refs": { "TagList$member": null } @@ -1121,14 +1121,14 @@ "UpstreamRepositoryInfoList": { "base": null, "refs": { - "RepositoryDescription$upstreams": "

A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

" + "RepositoryDescription$upstreams": "

A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

" } }, "UpstreamRepositoryList": { "base": null, "refs": { - "CreateRepositoryRequest$upstreams": "

A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

", - "UpdateRepositoryRequest$upstreams": "

A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

" + "CreateRepositoryRequest$upstreams": "

A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

", + "UpdateRepositoryRequest$upstreams": "

A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

" } }, "ValidationException": { diff --git a/apis/connect/2017-08-08/api-2.json b/apis/connect/2017-08-08/api-2.json index 49c8b5a3f77..97de8b8a484 100644 --- a/apis/connect/2017-08-08/api-2.json +++ b/apis/connect/2017-08-08/api-2.json @@ -375,6 +375,23 @@ {"shape":"InternalServiceException"} ] }, + "CreateTaskTemplate":{ + "name":"CreateTaskTemplate", + "http":{ + "method":"PUT", + "requestUri":"/instance/{InstanceId}/task/template" + }, + "input":{"shape":"CreateTaskTemplateRequest"}, + "output":{"shape":"CreateTaskTemplateResponse"}, + "errors":[ + {"shape":"PropertyValidationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServiceException"} + ] + }, "CreateUseCase":{ "name":"CreateUseCase", "http":{ @@ -552,6 +569,22 @@ {"shape":"ResourceInUseException"} ] }, + "DeleteTaskTemplate":{ + "name":"DeleteTaskTemplate", + "http":{ + "method":"DELETE", + "requestUri":"/instance/{InstanceId}/task/template/{TaskTemplateId}" + }, + "input":{"shape":"DeleteTaskTemplateRequest"}, + "output":{"shape":"DeleteTaskTemplateResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ] + }, "DeleteUseCase":{ "name":"DeleteUseCase", "http":{ @@ -1083,6 +1116,22 @@ {"shape":"ResourceNotFoundException"} ] }, + "GetTaskTemplate":{ + "name":"GetTaskTemplate", + "http":{ + "method":"GET", + "requestUri":"/instance/{InstanceId}/task/template/{TaskTemplateId}" + }, + "input":{"shape":"GetTaskTemplateRequest"}, + "output":{"shape":"GetTaskTemplateResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ] + }, "ListAgentStatuses":{ "name":"ListAgentStatuses", "http":{ @@ -1494,6 +1543,22 @@ {"shape":"ThrottlingException"} ] }, + "ListTaskTemplates":{ + "name":"ListTaskTemplates", + "http":{ + "method":"GET", + "requestUri":"/instance/{InstanceId}/task/template" + }, + "input":{"shape":"ListTaskTemplatesRequest"}, + "output":{"shape":"ListTaskTemplatesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ] + }, "ListUseCases":{ "name":"ListUseCases", "http":{ @@ -1791,6 +1856,24 @@ {"shape":"ThrottlingException"} ] }, + "TransferContact":{ + "name":"TransferContact", + "http":{ + "method":"POST", + "requestUri":"/contact/transfer" + }, + "input":{"shape":"TransferContactRequest"}, + "output":{"shape":"TransferContactResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"IdempotencyException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ] + }, "UntagResource":{ "name":"UntagResource", "http":{ @@ -2200,6 +2283,23 @@ {"shape":"InternalServiceException"} ] }, + "UpdateTaskTemplate":{ + "name":"UpdateTaskTemplate", + "http":{ + "method":"POST", + "requestUri":"/instance/{InstanceId}/task/template/{TaskTemplateId}" + }, + "input":{"shape":"UpdateTaskTemplateRequest"}, + "output":{"shape":"UpdateTaskTemplateResponse"}, + "errors":[ + {"shape":"PropertyValidationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServiceException"} + ] + }, "UpdateUserHierarchy":{ "name":"UpdateUserHierarchy", "http":{ @@ -3253,6 +3353,43 @@ "SecurityProfileArn":{"shape":"ARN"} } }, + "CreateTaskTemplateRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Name", + "Fields" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "location":"uri", + "locationName":"InstanceId" + }, + "Name":{"shape":"TaskTemplateName"}, + "Description":{"shape":"TaskTemplateDescription"}, + "ContactFlowId":{"shape":"ContactFlowId"}, + "Constraints":{"shape":"TaskTemplateConstraints"}, + "Defaults":{"shape":"TaskTemplateDefaults"}, + "Status":{"shape":"TaskTemplateStatus"}, + "Fields":{"shape":"TaskTemplateFields"}, + "ClientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + } + } + }, + "CreateTaskTemplateResponse":{ + "type":"structure", + "required":[ + "Id", + "Arn" + ], + "members":{ + "Id":{"shape":"TaskTemplateId"}, + "Arn":{"shape":"TaskTemplateArn"} + } + }, "CreateUseCaseRequest":{ "type":"structure", "required":[ @@ -3439,6 +3576,13 @@ "type":"list", "member":{"shape":"CurrentMetric"} }, + "DateReference":{ + "type":"structure", + "members":{ + "Name":{"shape":"ReferenceKey"}, + "Value":{"shape":"ReferenceValue"} + } + }, "DefaultVocabulary":{ "type":"structure", "required":[ @@ -3593,6 +3737,30 @@ } } }, + "DeleteTaskTemplateRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "TaskTemplateId" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "location":"uri", + "locationName":"InstanceId" + }, + "TaskTemplateId":{ + "shape":"TaskTemplateId", + "location":"uri", + "locationName":"TaskTemplateId" + } + } + }, + "DeleteTaskTemplateResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteUseCaseRequest":{ "type":"structure", "required":[ @@ -4333,6 +4501,13 @@ "exception":true }, "Email":{"type":"string"}, + "EmailReference":{ + "type":"structure", + "members":{ + "Name":{"shape":"ReferenceKey"}, + "Value":{"shape":"ReferenceValue"} + } + }, "EncryptionConfig":{ "type":"structure", "required":[ @@ -4471,6 +4646,53 @@ "MetricResults":{"shape":"HistoricalMetricResults"} } }, + "GetTaskTemplateRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "TaskTemplateId" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "location":"uri", + "locationName":"InstanceId" + }, + "TaskTemplateId":{ + "shape":"TaskTemplateId", + "location":"uri", + "locationName":"TaskTemplateId" + }, + "SnapshotVersion":{ + "shape":"SnapshotVersion", + "location":"querystring", + "locationName":"snapshotVersion" + } + } + }, + "GetTaskTemplateResponse":{ + "type":"structure", + "required":[ + "Id", + "Arn", + "Name" + ], + "members":{ + "InstanceId":{"shape":"InstanceId"}, + "Id":{"shape":"TaskTemplateId"}, + "Arn":{"shape":"TaskTemplateArn"}, + "Name":{"shape":"TaskTemplateName"}, + "Description":{"shape":"TaskTemplateDescription"}, + "ContactFlowId":{"shape":"ContactFlowId"}, + "Constraints":{"shape":"TaskTemplateConstraints"}, + "Defaults":{"shape":"TaskTemplateDefaults"}, + "Fields":{"shape":"TaskTemplateFields"}, + "Status":{"shape":"TaskTemplateStatus"}, + "LastModifiedTime":{"shape":"timestamp"}, + "CreatedTime":{"shape":"timestamp"}, + "Tags":{"shape":"TagMap"} + } + }, "Grouping":{ "type":"string", "enum":[ @@ -4908,6 +5130,16 @@ "error":{"httpStatusCode":400}, "exception":true }, + "InvisibleFieldInfo":{ + "type":"structure", + "members":{ + "Id":{"shape":"TaskTemplateFieldIdentifier"} + } + }, + "InvisibleTaskTemplateFields":{ + "type":"list", + "member":{"shape":"InvisibleFieldInfo"} + }, "KeyId":{ "type":"string", "max":128, @@ -5812,6 +6044,45 @@ "tags":{"shape":"TagMap"} } }, + "ListTaskTemplatesRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "location":"uri", + "locationName":"InstanceId" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResult100", + "box":true, + "location":"querystring", + "locationName":"maxResults" + }, + "Status":{ + "shape":"TaskTemplateStatus", + "location":"querystring", + "locationName":"status" + }, + "Name":{ + "shape":"TaskTemplateName", + "location":"querystring", + "locationName":"name" + } + } + }, + "ListTaskTemplatesResponse":{ + "type":"structure", + "members":{ + "TaskTemplates":{"shape":"TaskTemplateList"}, + "NextToken":{"shape":"NextToken"} + } + }, "ListUseCasesRequest":{ "type":"structure", "required":[ @@ -5969,6 +6240,13 @@ "max":2500, "min":1 }, + "NumberReference":{ + "type":"structure", + "members":{ + "Name":{"shape":"ReferenceKey"}, + "Value":{"shape":"ReferenceValue"} + } + }, "Origin":{ "type":"string", "max":267 @@ -6402,6 +6680,44 @@ "type":"list", "member":{"shape":"PromptSummary"} }, + "PropertyValidationException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"Message"}, + "PropertyList":{"shape":"PropertyValidationExceptionPropertyList"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "PropertyValidationExceptionProperty":{ + "type":"structure", + "required":[ + "PropertyPath", + "Reason", + "Message" + ], + "members":{ + "PropertyPath":{"shape":"String"}, + "Reason":{"shape":"PropertyValidationExceptionReason"}, + "Message":{"shape":"Message"} + } + }, + "PropertyValidationExceptionPropertyList":{ + "type":"list", + "member":{"shape":"PropertyValidationExceptionProperty"} + }, + "PropertyValidationExceptionReason":{ + "type":"string", + "enum":[ + "INVALID_FORMAT", + "UNIQUE_CONSTRAINT_VIOLATED", + "REFERENCED_RESOURCE_NOT_FOUND", + "RESOURCE_NAME_ALREADY_EXISTS", + "REQUIRED_PROPERTY_MISSING", + "NOT_SUPPORTED" + ] + }, "PutUserStatusRequest":{ "type":"structure", "required":[ @@ -6587,6 +6903,16 @@ "max":50, "min":1 }, + "ReadOnlyFieldInfo":{ + "type":"structure", + "members":{ + "Id":{"shape":"TaskTemplateFieldIdentifier"} + } + }, + "ReadOnlyTaskTemplateFields":{ + "type":"list", + "member":{"shape":"ReadOnlyFieldInfo"} + }, "Reference":{ "type":"structure", "required":[ @@ -6614,7 +6940,11 @@ "type":"structure", "members":{ "Url":{"shape":"UrlReference"}, - "Attachment":{"shape":"AttachmentReference"} + "Attachment":{"shape":"AttachmentReference"}, + "String":{"shape":"StringReference"}, + "Number":{"shape":"NumberReference"}, + "Date":{"shape":"DateReference"}, + "Email":{"shape":"EmailReference"} }, "union":true }, @@ -6626,13 +6956,17 @@ "type":"string", "enum":[ "URL", - "ATTACHMENT" + "ATTACHMENT", + "NUMBER", + "STRING", + "DATE", + "EMAIL" ] }, "ReferenceTypes":{ "type":"list", "member":{"shape":"ReferenceType"}, - "max":2 + "max":6 }, "ReferenceValue":{ "type":"string", @@ -6656,6 +6990,16 @@ } } }, + "RequiredFieldInfo":{ + "type":"structure", + "members":{ + "Id":{"shape":"TaskTemplateFieldIdentifier"} + } + }, + "RequiredTaskTemplateFields":{ + "type":"list", + "member":{"shape":"RequiredFieldInfo"} + }, "ResourceConflictException":{ "type":"structure", "members":{ @@ -6957,6 +7301,11 @@ "error":{"httpStatusCode":402}, "exception":true }, + "SingleSelectOptions":{ + "type":"list", + "member":{"shape":"TaskTemplateSingleSelectOption"} + }, + "SnapshotVersion":{"type":"string"}, "SourceApplicationName":{ "type":"string", "max":100, @@ -7077,7 +7426,6 @@ "type":"structure", "required":[ "InstanceId", - "ContactFlowId", "Name" ], "members":{ @@ -7092,7 +7440,9 @@ "shape":"ClientToken", "idempotencyToken":true }, - "ScheduledTime":{"shape":"Timestamp"} + "ScheduledTime":{"shape":"Timestamp"}, + "TaskTemplateId":{"shape":"TaskTemplateId"}, + "QuickConnectId":{"shape":"QuickConnectId"} } }, "StartTaskContactResponse":{ @@ -7192,6 +7542,13 @@ "ComparisonType":{"shape":"StringComparisonType"} } }, + "StringReference":{ + "type":"structure", + "members":{ + "Name":{"shape":"ReferenceKey"}, + "Value":{"shape":"ReferenceValue"} + } + }, "SupportedMessagingContentType":{ "type":"string", "max":100, @@ -7272,6 +7629,131 @@ "type":"string", "max":256 }, + "TaskTemplateArn":{ + "type":"string", + "max":500, + "min":1 + }, + "TaskTemplateConstraints":{ + "type":"structure", + "members":{ + "RequiredFields":{"shape":"RequiredTaskTemplateFields"}, + "ReadOnlyFields":{"shape":"ReadOnlyTaskTemplateFields"}, + "InvisibleFields":{"shape":"InvisibleTaskTemplateFields"} + } + }, + "TaskTemplateDefaultFieldValue":{ + "type":"structure", + "members":{ + "Id":{"shape":"TaskTemplateFieldIdentifier"}, + "DefaultValue":{"shape":"TaskTemplateFieldValue"} + } + }, + "TaskTemplateDefaultFieldValueList":{ + "type":"list", + "member":{"shape":"TaskTemplateDefaultFieldValue"} + }, + "TaskTemplateDefaults":{ + "type":"structure", + "members":{ + "DefaultFieldValues":{"shape":"TaskTemplateDefaultFieldValueList"} + } + }, + "TaskTemplateDescription":{ + "type":"string", + "max":255, + "min":1 + }, + "TaskTemplateField":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{"shape":"TaskTemplateFieldIdentifier"}, + "Description":{"shape":"TaskTemplateFieldDescription"}, + "Type":{"shape":"TaskTemplateFieldType"}, + "SingleSelectOptions":{"shape":"SingleSelectOptions"} + } + }, + "TaskTemplateFieldDescription":{ + "type":"string", + "max":255, + "min":1 + }, + "TaskTemplateFieldIdentifier":{ + "type":"structure", + "members":{ + "Name":{"shape":"TaskTemplateFieldName"} + } + }, + "TaskTemplateFieldName":{ + "type":"string", + "max":100, + "min":1 + }, + "TaskTemplateFieldType":{ + "type":"string", + "enum":[ + "NAME", + "DESCRIPTION", + "SCHEDULED_TIME", + "QUICK_CONNECT", + "URL", + "NUMBER", + "TEXT", + "TEXT_AREA", + "DATE_TIME", + "BOOLEAN", + "SINGLE_SELECT", + "EMAIL" + ] + }, + "TaskTemplateFieldValue":{ + "type":"string", + "max":4096, + "min":0 + }, + "TaskTemplateFields":{ + "type":"list", + "member":{"shape":"TaskTemplateField"} + }, + "TaskTemplateId":{ + "type":"string", + "max":500, + "min":1 + }, + "TaskTemplateList":{ + "type":"list", + "member":{"shape":"TaskTemplateMetadata"} + }, + "TaskTemplateMetadata":{ + "type":"structure", + "members":{ + "Id":{"shape":"TaskTemplateId"}, + "Arn":{"shape":"TaskTemplateArn"}, + "Name":{"shape":"TaskTemplateName"}, + "Description":{"shape":"TaskTemplateDescription"}, + "Status":{"shape":"TaskTemplateStatus"}, + "LastModifiedTime":{"shape":"timestamp"}, + "CreatedTime":{"shape":"timestamp"} + } + }, + "TaskTemplateName":{ + "type":"string", + "max":100, + "min":1 + }, + "TaskTemplateSingleSelectOption":{ + "type":"string", + "max":100, + "min":1 + }, + "TaskTemplateStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "INACTIVE" + ] + }, "Threshold":{ "type":"structure", "members":{ @@ -7300,6 +7782,32 @@ "CAMPAIGN" ] }, + "TransferContactRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "ContactId", + "ContactFlowId" + ], + "members":{ + "InstanceId":{"shape":"InstanceId"}, + "ContactId":{"shape":"ContactId"}, + "QueueId":{"shape":"QueueId"}, + "UserId":{"shape":"AgentResourceId"}, + "ContactFlowId":{"shape":"ContactFlowId"}, + "ClientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + } + } + }, + "TransferContactResponse":{ + "type":"structure", + "members":{ + "ContactId":{"shape":"ContactId"}, + "ContactArn":{"shape":"ARN"} + } + }, "URI":{ "type":"string", "max":2000, @@ -7905,6 +8413,49 @@ } } }, + "UpdateTaskTemplateRequest":{ + "type":"structure", + "required":[ + "TaskTemplateId", + "InstanceId" + ], + "members":{ + "TaskTemplateId":{ + "shape":"TaskTemplateId", + "location":"uri", + "locationName":"TaskTemplateId" + }, + "InstanceId":{ + "shape":"InstanceId", + "location":"uri", + "locationName":"InstanceId" + }, + "Name":{"shape":"TaskTemplateName"}, + "Description":{"shape":"TaskTemplateDescription"}, + "ContactFlowId":{"shape":"ContactFlowId"}, + "Constraints":{"shape":"TaskTemplateConstraints"}, + "Defaults":{"shape":"TaskTemplateDefaults"}, + "Status":{"shape":"TaskTemplateStatus"}, + "Fields":{"shape":"TaskTemplateFields"} + } + }, + "UpdateTaskTemplateResponse":{ + "type":"structure", + "members":{ + "InstanceId":{"shape":"InstanceId"}, + "Id":{"shape":"TaskTemplateId"}, + "Arn":{"shape":"TaskTemplateArn"}, + "Name":{"shape":"TaskTemplateName"}, + "Description":{"shape":"TaskTemplateDescription"}, + "ContactFlowId":{"shape":"ContactFlowId"}, + "Constraints":{"shape":"TaskTemplateConstraints"}, + "Defaults":{"shape":"TaskTemplateDefaults"}, + "Fields":{"shape":"TaskTemplateFields"}, + "Status":{"shape":"TaskTemplateStatus"}, + "LastModifiedTime":{"shape":"timestamp"}, + "CreatedTime":{"shape":"timestamp"} + } + }, "UpdateUserHierarchyGroupNameRequest":{ "type":"structure", "required":[ diff --git a/apis/connect/2017-08-08/docs-2.json b/apis/connect/2017-08-08/docs-2.json index 975ec25fee0..7572ffd841e 100644 --- a/apis/connect/2017-08-08/docs-2.json +++ b/apis/connect/2017-08-08/docs-2.json @@ -23,6 +23,7 @@ "CreateQuickConnect": "

Creates a quick connect for the specified Amazon Connect instance.

", "CreateRoutingProfile": "

Creates a new routing profile.

", "CreateSecurityProfile": "

This API is in preview release for Amazon Connect and is subject to change.

Creates a security profile.

", + "CreateTaskTemplate": "

Creates a new task template in the specified Amazon Connect instance.

", "CreateUseCase": "

Creates a use case for an integration association.

", "CreateUser": "

Creates a user account for the specified Amazon Connect instance.

For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide.

", "CreateUserHierarchyGroup": "

Creates a new user hierarchy group.

", @@ -34,6 +35,7 @@ "DeleteIntegrationAssociation": "

Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.

", "DeleteQuickConnect": "

Deletes a quick connect.

", "DeleteSecurityProfile": "

This API is in preview release for Amazon Connect and is subject to change.

Deletes a security profile.

", + "DeleteTaskTemplate": "

Deletes the task template.

", "DeleteUseCase": "

Deletes a use case from an integration association.

", "DeleteUser": "

Deletes a user account from the specified Amazon Connect instance.

For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.

", "DeleteUserHierarchyGroup": "

Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.

", @@ -68,6 +70,7 @@ "GetCurrentMetricData": "

Gets the real-time metric data from the specified Amazon Connect instance.

For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.

", "GetFederationToken": "

Retrieves a token for federation.

This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:

Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect

", "GetMetricData": "

Gets historical metric data from the specified Amazon Connect instance.

For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

", + "GetTaskTemplate": "

Gets details about a specific task template in the specified Amazon Connect instance.

", "ListAgentStatuses": "

This API is in preview release for Amazon Connect and is subject to change.

Lists agent statuses.

", "ListApprovedOrigins": "

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all approved origins associated with the instance.

", "ListBots": "

This API is in preview release for Amazon Connect and is subject to change.

For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance.

", @@ -94,6 +97,7 @@ "ListSecurityProfilePermissions": "

This API is in preview release for Amazon Connect and is subject to change.

Lists the permissions granted to a security profile.

", "ListSecurityProfiles": "

Provides summary information about the security profiles for the specified Amazon Connect instance.

For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.

", "ListTagsForResource": "

Lists the tags for the specified resource.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

", + "ListTaskTemplates": "

Lists task templates for the specified Amazon Connect instance.

", "ListUseCases": "

Lists the use cases for the integration association.

", "ListUserHierarchyGroups": "

Provides summary information about the hierarchy groups for the specified Amazon Connect instance.

For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.

", "ListUsers": "

Provides summary information about the users for the specified Amazon Connect instance.

", @@ -112,7 +116,8 @@ "StopContactRecording": "

Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.

Only voice recordings are supported at this time.

", "StopContactStreaming": "

Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.

", "SuspendContactRecording": "

When a contact is being recorded, this API suspends recording the call. For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording.

The period of time that the recording is suspended is filled with silence in the final recording.

Only voice recordings are supported at this time.

", - "TagResource": "

Adds the specified tags to the specified resource.

The supported resource types are users, routing profiles, queues, quick connects, contact flows, agent status, hours of operation, and phone number.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

", + "TagResource": "

Adds the specified tags to the specified resource.

The supported resource types are users, routing profiles, queues, quick connects, contact flows, agent status, hours of operation, phone number, security profiles, and task templates.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

", + "TransferContact": "

Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the contact flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.

Note the following requirements:

", "UntagResource": "

Removes the specified tags from the specified resource.

", "UpdateAgentStatus": "

This API is in preview release for Amazon Connect and is subject to change.

Updates agent status.

", "UpdateContact": "

This API is in preview release for Amazon Connect and is subject to change.

Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.

You can add or update user-defined contact information for both ongoing and completed contacts.

", @@ -139,6 +144,7 @@ "UpdateRoutingProfileName": "

Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided.

", "UpdateRoutingProfileQueues": "

Updates the properties associated with a set of queues for a routing profile.

", "UpdateSecurityProfile": "

This API is in preview release for Amazon Connect and is subject to change.

Updates a security profile.

", + "UpdateTaskTemplate": "

Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.

", "UpdateUserHierarchy": "

Assigns the specified hierarchy group to the specified user.

", "UpdateUserHierarchyGroupName": "

Updates the name of the user hierarchy group.

", "UpdateUserHierarchyStructure": "

Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.

", @@ -210,6 +216,7 @@ "SecurityProfile$Arn": "

The Amazon Resource Name (ARN) for the secruity profile.

", "SecurityProfileSummary$Arn": "

The Amazon Resource Name (ARN) of the security profile.

", "TagResourceRequest$resourceArn": "

The Amazon Resource Name (ARN) of the resource.

", + "TransferContactResponse$ContactArn": "

The Amazon Resource Name (ARN) of the contact.

", "UntagResourceRequest$resourceArn": "

The Amazon Resource Name (ARN) of the resource.

", "UpdatePhoneNumberRequest$TargetArn": "

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.

", "UpdatePhoneNumberResponse$PhoneNumberArn": "

The Amazon Resource Name (ARN) of the phone number.

", @@ -255,7 +262,8 @@ "AgentResourceId": { "base": null, "refs": { - "AgentInfo$Id": "

The identifier of the agent who accepted the contact.

" + "AgentInfo$Id": "

The identifier of the agent who accepted the contact.

", + "TransferContactRequest$UserId": "

The identifier for the user.

" } }, "AgentStatus": { @@ -439,9 +447,9 @@ } }, "AttachmentReference": { - "base": "

Information about the attachment reference if the referenceType is ATTACHMENT. Otherwise, null.

", + "base": "

Information about a reference when the referenceType is ATTACHMENT. Otherwise, null.

", "refs": { - "ReferenceSummary$Attachment": "

Information about the attachment reference if the referenceType is ATTACHMENT. Otherwise, null.

" + "ReferenceSummary$Attachment": "

Information about the reference when the referenceType is ATTACHMENT. Otherwise, null.

" } }, "Attribute": { @@ -599,12 +607,14 @@ "ClaimPhoneNumberRequest$ClientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "CreateContactFlowModuleRequest$ClientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "CreateInstanceRequest$ClientToken": "

The idempotency token.

", + "CreateTaskTemplateRequest$ClientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "CreateVocabularyRequest$ClientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.

", "ReleasePhoneNumberRequest$ClientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "StartChatContactRequest$ClientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "StartContactStreamingRequest$ClientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "StartOutboundVoiceContactRequest$ClientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

", "StartTaskContactRequest$ClientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", + "TransferContactRequest$ClientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "UpdatePhoneNumberRequest$ClientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

" } }, @@ -667,16 +677,21 @@ "ContactFlow$Id": "

The identifier of the contact flow.

", "ContactFlowSummary$Id": "

The identifier of the contact flow.

", "CreateContactFlowResponse$ContactFlowId": "

The identifier of the contact flow.

", + "CreateTaskTemplateRequest$ContactFlowId": "

The identifier of the flow that runs by default when a task is created by referencing this template.

", "DeleteContactFlowRequest$ContactFlowId": "

The identifier of the contact flow.

", "DescribeContactFlowRequest$ContactFlowId": "

The identifier of the contact flow.

", + "GetTaskTemplateResponse$ContactFlowId": "

The identifier of the flow that runs by default when a task is created by referencing this template.

", "OutboundCallerConfig$OutboundFlowId": "

The outbound whisper flow to be used during an outbound call.

", "QueueQuickConnectConfig$ContactFlowId": "

The identifier of the contact flow.

", "StartChatContactRequest$ContactFlowId": "

The identifier of the contact flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

", "StartOutboundVoiceContactRequest$ContactFlowId": "

The identifier of the contact flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

", "StartTaskContactRequest$ContactFlowId": "

The identifier of the contact flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

", + "TransferContactRequest$ContactFlowId": "

The identifier of the contact flow.

", "UpdateContactFlowContentRequest$ContactFlowId": "

The identifier of the contact flow.

", "UpdateContactFlowMetadataRequest$ContactFlowId": "

The identifier of the contact flow.

", "UpdateContactFlowNameRequest$ContactFlowId": "

The identifier of the contact flow.

", + "UpdateTaskTemplateRequest$ContactFlowId": "

The identifier of the flow that runs by default when a task is created by referencing this template.

", + "UpdateTaskTemplateResponse$ContactFlowId": "

The identifier of the flow that runs by default when a task is created by referencing this template.

", "UserQuickConnectConfig$ContactFlowId": "

The identifier of the contact flow.

" } }, @@ -824,6 +839,8 @@ "StopContactStreamingRequest$ContactId": "

The identifier of the contact. This is the identifier of the contact that is associated with the first interaction with the contact center.

", "SuspendContactRecordingRequest$ContactId": "

The identifier of the contact.

", "SuspendContactRecordingRequest$InitialContactId": "

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

", + "TransferContactRequest$ContactId": "

The identifier of the contact in this instance of Amazon Connect

", + "TransferContactResponse$ContactId": "

The identifier of the contact in this instance of Amazon Connect

", "UpdateContactAttributesRequest$InitialContactId": "

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

", "UpdateContactRequest$ContactId": "

The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.

", "UpdateContactScheduleRequest$ContactId": "

The identifier of the contact.

" @@ -844,7 +861,7 @@ "base": null, "refs": { "StartTaskContactRequest$References": "

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

", - "UpdateContactRequest$References": "

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

" + "UpdateContactRequest$References": "

Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

" } }, "ControlPlaneTagFilter": { @@ -953,6 +970,16 @@ "refs": { } }, + "CreateTaskTemplateRequest": { + "base": null, + "refs": { + } + }, + "CreateTaskTemplateResponse": { + "base": null, + "refs": { + } + }, "CreateUseCaseRequest": { "base": null, "refs": { @@ -1042,6 +1069,12 @@ "GetCurrentMetricDataRequest$CurrentMetrics": "

The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.

AGENTS_AFTER_CONTACT_WORK

Unit: COUNT

Name in real-time metrics report: ACW

AGENTS_AVAILABLE

Unit: COUNT

Name in real-time metrics report: Available

AGENTS_ERROR

Unit: COUNT

Name in real-time metrics report: Error

AGENTS_NON_PRODUCTIVE

Unit: COUNT

Name in real-time metrics report: NPT (Non-Productive Time)

AGENTS_ON_CALL

Unit: COUNT

Name in real-time metrics report: On contact

AGENTS_ON_CONTACT

Unit: COUNT

Name in real-time metrics report: On contact

AGENTS_ONLINE

Unit: COUNT

Name in real-time metrics report: Online

AGENTS_STAFFED

Unit: COUNT

Name in real-time metrics report: Staffed

CONTACTS_IN_QUEUE

Unit: COUNT

Name in real-time metrics report: In queue

CONTACTS_SCHEDULED

Unit: COUNT

Name in real-time metrics report: Scheduled

OLDEST_CONTACT_AGE

Unit: SECONDS

When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.

When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:

{ \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" }, \"Value\": 24113.0 }

The actual OLDEST_CONTACT_AGE is 24 seconds.

Name in real-time metrics report: Oldest

SLOTS_ACTIVE

Unit: COUNT

Name in real-time metrics report: Active

SLOTS_AVAILABLE

Unit: COUNT

Name in real-time metrics report: Availability

" } }, + "DateReference": { + "base": "

Information about a reference when the referenceType is DATE. Otherwise, null.

", + "refs": { + "ReferenceSummary$Date": "

Information about a reference when the referenceType is DATE. Otherwise, null.

" + } + }, "DefaultVocabulary": { "base": "

Contains information about a default vocabulary.

", "refs": { @@ -1101,6 +1134,16 @@ "refs": { } }, + "DeleteTaskTemplateRequest": { + "base": null, + "refs": { + } + }, + "DeleteTaskTemplateResponse": { + "base": null, + "refs": { + } + }, "DeleteUseCaseRequest": { "base": null, "refs": { @@ -1408,6 +1451,12 @@ "UserIdentityInfo$Email": "

The email address. If you are using SAML for identity management and include this parameter, an error is returned.

" } }, + "EmailReference": { + "base": "

Information about a reference when the referenceType is EMAIL. Otherwise, null.

", + "refs": { + "ReferenceSummary$Email": "

Information about a reference when the referenceType is EMAIL. Otherwise, null.

" + } + }, "EncryptionConfig": { "base": "

The encryption configuration.

", "refs": { @@ -1482,6 +1531,16 @@ "refs": { } }, + "GetTaskTemplateRequest": { + "base": null, + "refs": { + } + }, + "GetTaskTemplateResponse": { + "base": null, + "refs": { + } + }, "Grouping": { "base": null, "refs": { @@ -1791,6 +1850,7 @@ "CreateQuickConnectRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "CreateRoutingProfileRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "CreateSecurityProfileRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "CreateTaskTemplateRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "CreateUseCaseRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "CreateUserHierarchyGroupRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "CreateUserRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", @@ -1803,6 +1863,7 @@ "DeleteIntegrationAssociationRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "DeleteQuickConnectRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "DeleteSecurityProfileRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "DeleteTaskTemplateRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "DeleteUseCaseRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "DeleteUserHierarchyGroupRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "DeleteUserRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", @@ -1836,6 +1897,8 @@ "GetCurrentMetricDataRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "GetFederationTokenRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "GetMetricDataRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "GetTaskTemplateRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "GetTaskTemplateResponse$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "Instance$Id": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "InstanceSummary$Id": "

The identifier of the instance.

", "IntegrationAssociationSummary$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", @@ -1862,6 +1925,7 @@ "ListSecurityKeysRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "ListSecurityProfilePermissionsRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "ListSecurityProfilesRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "ListTaskTemplatesRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "ListUseCasesRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "ListUserHierarchyGroupsRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "ListUsersRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", @@ -1880,6 +1944,7 @@ "StopContactRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "StopContactStreamingRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "SuspendContactRecordingRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "TransferContactRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "UpdateAgentStatusRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "UpdateContactAttributesRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "UpdateContactFlowContentRequest$InstanceId": "

The identifier of the Amazon Connect instance.

", @@ -1904,6 +1969,8 @@ "UpdateRoutingProfileNameRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "UpdateRoutingProfileQueuesRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "UpdateSecurityProfileRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "UpdateTaskTemplateRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "UpdateTaskTemplateResponse$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "UpdateUserHierarchyGroupNameRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "UpdateUserHierarchyRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "UpdateUserHierarchyStructureRequest$InstanceId": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", @@ -2019,6 +2086,18 @@ "refs": { } }, + "InvisibleFieldInfo": { + "base": "

A field that is invisible to an agent.

", + "refs": { + "InvisibleTaskTemplateFields$member": null + } + }, + "InvisibleTaskTemplateFields": { + "base": null, + "refs": { + "TaskTemplateConstraints$InvisibleFields": "

Lists the fields that are invisible to agents.

" + } + }, "KeyId": { "base": null, "refs": { @@ -2378,6 +2457,16 @@ "refs": { } }, + "ListTaskTemplatesRequest": { + "base": null, + "refs": { + } + }, + "ListTaskTemplatesResponse": { + "base": null, + "refs": { + } + }, "ListUseCasesRequest": { "base": "

Provides summary information about the use cases for the specified integration association.

", "refs": { @@ -2425,6 +2514,7 @@ "ListIntegrationAssociationsRequest$MaxResults": "

The maximum number of results to return per page.

", "ListQueueQuickConnectsRequest$MaxResults": "

The maximum number of results to return per page.

", "ListRoutingProfileQueuesRequest$MaxResults": "

The maximum number of results to return per page.

", + "ListTaskTemplatesRequest$MaxResults": "

The maximum number of results to return per page.

It is not expected that you set this.

", "ListUseCasesRequest$MaxResults": "

The maximum number of results to return per page.

", "SearchUsersRequest$MaxResults": "

The maximum number of results to return per page.

", "SearchVocabulariesRequest$MaxResults": "

The maximum number of results to return per page.

" @@ -2498,6 +2588,8 @@ "InvalidRequestException$Message": "

The message about the request.

", "LimitExceededException$Message": "

The message about the limit.

", "OutboundContactNotPermittedException$Message": "

The message about the contact.

", + "PropertyValidationException$Message": null, + "PropertyValidationExceptionProperty$Message": "

A message describing why the property is not valid.

", "ResourceConflictException$Message": null, "ResourceInUseException$Message": null, "ResourceNotFoundException$Message": "

The message about the resource.

", @@ -2573,6 +2665,8 @@ "ListSecurityProfilePermissionsResponse$NextToken": "

If there are additional results, this is the token for the next set of results.

", "ListSecurityProfilesRequest$NextToken": "

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", "ListSecurityProfilesResponse$NextToken": "

If there are additional results, this is the token for the next set of results.

", + "ListTaskTemplatesRequest$NextToken": "

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

It is not expected that you set this because the value returned in the previous response is always null.

", + "ListTaskTemplatesResponse$NextToken": "

If there are additional results, this is the token for the next set of results.

This is always returned as a null in the response.

", "ListUseCasesRequest$NextToken": "

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", "ListUseCasesResponse$NextToken": "

If there are additional results, this is the token for the next set of results.

", "ListUserHierarchyGroupsRequest$NextToken": "

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", @@ -2588,6 +2682,12 @@ "SearchUsersResponse$NextToken": "

If there are additional results, this is the token for the next set of results.

" } }, + "NumberReference": { + "base": "

Information about a reference when the referenceType is NUMBER. Otherwise, null.

", + "refs": { + "ReferenceSummary$Number": "

Information about a reference when the referenceType is NUMBER. Otherwise, null.

" + } + }, "Origin": { "base": null, "refs": { @@ -2847,6 +2947,29 @@ "ListPromptsResponse$PromptSummaryList": "

Information about the prompts.

" } }, + "PropertyValidationException": { + "base": "

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

Contains information about why a property is not valid.

", + "refs": { + "PropertyValidationExceptionPropertyList$member": null + } + }, + "PropertyValidationExceptionPropertyList": { + "base": null, + "refs": { + "PropertyValidationException$PropertyList": null + } + }, + "PropertyValidationExceptionReason": { + "base": null, + "refs": { + "PropertyValidationExceptionProperty$Reason": "

Why the property is not valid.

" + } + }, "PutUserStatusRequest": { "base": null, "refs": { @@ -2890,6 +3013,7 @@ "RoutingProfileQueueConfigSummary$QueueId": "

The identifier for the queue.

", "RoutingProfileQueueReference$QueueId": "

The identifier for the queue.

", "StartOutboundVoiceContactRequest$QueueId": "

The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.

", + "TransferContactRequest$QueueId": "

The identifier for the queue.

", "UpdateQueueHoursOfOperationRequest$QueueId": "

The identifier for the queue.

", "UpdateQueueMaxContactsRequest$QueueId": "

The identifier for the queue.

", "UpdateQueueNameRequest$QueueId": "

The identifier for the queue.

", @@ -2999,6 +3123,7 @@ "QuickConnect$QuickConnectId": "

The identifier for the quick connect.

", "QuickConnectSummary$Id": "

The identifier for the quick connect.

", "QuickConnectsList$member": null, + "StartTaskContactRequest$QuickConnectId": "

The identifier for the quick connect.

", "UpdateQuickConnectConfigRequest$QuickConnectId": "

The identifier for the quick connect.

", "UpdateQuickConnectNameRequest$QuickConnectId": "

The identifier for the quick connect.

" } @@ -3047,8 +3172,20 @@ "DisassociateQueueQuickConnectsRequest$QuickConnectIds": "

The quick connects to disassociate from the queue.

" } }, + "ReadOnlyFieldInfo": { + "base": "

Indicates a field that is read-only to an agent.

", + "refs": { + "ReadOnlyTaskTemplateFields$member": null + } + }, + "ReadOnlyTaskTemplateFields": { + "base": null, + "refs": { + "TaskTemplateConstraints$ReadOnlyFields": "

Lists the fields that are read-only to agents, and cannot be edited.

" + } + }, "Reference": { - "base": "

A link that an agent selects to complete a given task. You can have up to 4,096 UTF-8 bytes across all references for a contact.

", + "base": "

Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.

", "refs": { "ContactReferences$value": null } @@ -3058,13 +3195,17 @@ "refs": { "AttachmentReference$Name": "

Identifier of the attachment reference.

", "ContactReferences$key": null, + "DateReference$Name": "

Identifier of the date reference.

", + "EmailReference$Name": "

Identifier of the email reference.

", + "NumberReference$Name": "

Identifier of the number reference.

", + "StringReference$Name": "

Identifier of the string reference.

", "UrlReference$Name": "

Identifier of the URL reference.

" } }, "ReferenceStatus": { "base": null, "refs": { - "AttachmentReference$Status": "

Status of an attachment reference type.

" + "AttachmentReference$Status": "

Status of the attachment reference type.

" } }, "ReferenceSummary": { @@ -3082,7 +3223,7 @@ "ReferenceType": { "base": null, "refs": { - "Reference$Type": "

The type of the reference. Only URL type can be added or updated on a contact.

", + "Reference$Type": "

The type of the reference.

", "ReferenceTypes$member": null } }, @@ -3095,8 +3236,12 @@ "ReferenceValue": { "base": null, "refs": { - "AttachmentReference$Value": "

Contains the location path of the attachment reference.

", + "AttachmentReference$Value": "

The location path of the attachment reference.

", + "DateReference$Value": "

A valid date.

", + "EmailReference$Value": "

A valid email address.

", + "NumberReference$Value": "

A valid number.

", "Reference$Value": "

A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

", + "StringReference$Value": "

A valid string.

", "UrlReference$Value": "

A valid URL.

" } }, @@ -3105,6 +3250,18 @@ "refs": { } }, + "RequiredFieldInfo": { + "base": "

Information about a required field.

", + "refs": { + "RequiredTaskTemplateFields$member": null + } + }, + "RequiredTaskTemplateFields": { + "base": null, + "refs": { + "TaskTemplateConstraints$RequiredFields": "

Lists the fields that are required to be filled by agents.

" + } + }, "ResourceConflictException": { "base": "

A resource already has that name.

", "refs": { @@ -3352,6 +3509,18 @@ "refs": { } }, + "SingleSelectOptions": { + "base": null, + "refs": { + "TaskTemplateField$SingleSelectOptions": "

A list of options for a single select field.

" + } + }, + "SnapshotVersion": { + "base": null, + "refs": { + "GetTaskTemplateRequest$SnapshotVersion": "

The system generated version of a task template that is associated with a task, when the task is created.

" + } + }, "SourceApplicationName": { "base": null, "refs": { @@ -3470,6 +3639,7 @@ "refs": { "HierarchyGroupCondition$Value": "

The value in the hierarchy group condition.

", "InstanceStatusReason$Message": "

The message.

", + "PropertyValidationExceptionProperty$PropertyPath": "

The full property path.

", "StringCondition$FieldName": "

The name of the field in the string condition.

", "StringCondition$Value": "

The value of the string.

", "TagCondition$TagKey": "

The tag key in the tag condition.

", @@ -3488,6 +3658,12 @@ "UserSearchCriteria$StringCondition": "

A leaf node condition which can be used to specify a string condition.

" } }, + "StringReference": { + "base": "

Information about a reference when the referenceType is STRING. Otherwise, null.

", + "refs": { + "ReferenceSummary$String": "

Information about a reference when the referenceType is STRING. Otherwise, null.

" + } + }, "SupportedMessagingContentType": { "base": null, "refs": { @@ -3558,6 +3734,7 @@ "CreateUserHierarchyGroupRequest$Tags": "

The tags used to organize, track, or control access for this resource.

", "CreateUserRequest$Tags": "

One or more tags.

", "CreateVocabularyRequest$Tags": "

The tags used to organize, track, or control access for this resource.

", + "GetTaskTemplateResponse$Tags": "

The tags used to organize, track, or control access for this resource.

", "HierarchyGroup$Tags": "

The tags used to organize, track, or control access for this resource.

", "HoursOfOperation$Tags": "

The tags used to organize, track, or control access for this resource.

", "ListTagsForResourceResponse$tags": "

Information about the tags.

", @@ -3588,6 +3765,157 @@ "TagMap$value": null } }, + "TaskTemplateArn": { + "base": null, + "refs": { + "CreateTaskTemplateResponse$Arn": "

The Amazon Resource Name (ARN) for the task template resource.

", + "GetTaskTemplateResponse$Arn": "

The Amazon Resource Name (ARN).

", + "TaskTemplateMetadata$Arn": "

The Amazon Resource Name (ARN) of the task template.

", + "UpdateTaskTemplateResponse$Arn": "

The Amazon Resource Name (ARN) for the task template resource.

" + } + }, + "TaskTemplateConstraints": { + "base": "

Describes constraints that apply to the template fields.

", + "refs": { + "CreateTaskTemplateRequest$Constraints": "

Constraints that are applicable to the fields listed.

", + "GetTaskTemplateResponse$Constraints": "

Constraints that are applicable to the fields listed.

", + "UpdateTaskTemplateRequest$Constraints": "

Constraints that are applicable to the fields listed.

", + "UpdateTaskTemplateResponse$Constraints": "

Constraints that are applicable to the fields listed.

" + } + }, + "TaskTemplateDefaultFieldValue": { + "base": "

Describes a default field and its corresponding value.

", + "refs": { + "TaskTemplateDefaultFieldValueList$member": null + } + }, + "TaskTemplateDefaultFieldValueList": { + "base": null, + "refs": { + "TaskTemplateDefaults$DefaultFieldValues": "

Default value for the field.

" + } + }, + "TaskTemplateDefaults": { + "base": "

Describes default values for fields on a template.

", + "refs": { + "CreateTaskTemplateRequest$Defaults": "

The default values for fields when a task is created by referencing this template.

", + "GetTaskTemplateResponse$Defaults": "

The default values for fields when a task is created by referencing this template.

", + "UpdateTaskTemplateRequest$Defaults": "

The default values for fields when a task is created by referencing this template.

", + "UpdateTaskTemplateResponse$Defaults": "

The default values for fields when a task is created by referencing this template.

" + } + }, + "TaskTemplateDescription": { + "base": null, + "refs": { + "CreateTaskTemplateRequest$Description": "

The description of the task template.

", + "GetTaskTemplateResponse$Description": "

The description of the task template.

", + "TaskTemplateMetadata$Description": "

The description of the task template.

", + "UpdateTaskTemplateRequest$Description": "

The description of the task template.

", + "UpdateTaskTemplateResponse$Description": "

The description of the task template.

" + } + }, + "TaskTemplateField": { + "base": "

Describes a single task template field.

", + "refs": { + "TaskTemplateFields$member": null + } + }, + "TaskTemplateFieldDescription": { + "base": null, + "refs": { + "TaskTemplateField$Description": "

The description of the field.

" + } + }, + "TaskTemplateFieldIdentifier": { + "base": "

The identifier of the task template field.

", + "refs": { + "InvisibleFieldInfo$Id": "

Identifier of the invisible field.

", + "ReadOnlyFieldInfo$Id": "

Identifier of the read-only field.

", + "RequiredFieldInfo$Id": "

The unique identifier for the field.

", + "TaskTemplateDefaultFieldValue$Id": "

Identifier of a field.

", + "TaskTemplateField$Id": "

The unique identifier for the field.

" + } + }, + "TaskTemplateFieldName": { + "base": null, + "refs": { + "TaskTemplateFieldIdentifier$Name": "

The name of the task template field.

" + } + }, + "TaskTemplateFieldType": { + "base": null, + "refs": { + "TaskTemplateField$Type": "

Indicates the type of field.

" + } + }, + "TaskTemplateFieldValue": { + "base": null, + "refs": { + "TaskTemplateDefaultFieldValue$DefaultValue": "

Default value for the field.

" + } + }, + "TaskTemplateFields": { + "base": null, + "refs": { + "CreateTaskTemplateRequest$Fields": "

Fields that are part of the template.

", + "GetTaskTemplateResponse$Fields": "

Fields that are part of the template.

", + "UpdateTaskTemplateRequest$Fields": "

Fields that are part of the template.

", + "UpdateTaskTemplateResponse$Fields": "

Fields that are part of the template.

" + } + }, + "TaskTemplateId": { + "base": null, + "refs": { + "CreateTaskTemplateResponse$Id": "

The identifier of the task template resource.

", + "DeleteTaskTemplateRequest$TaskTemplateId": "

A unique identifier for the task template.

", + "GetTaskTemplateRequest$TaskTemplateId": "

A unique identifier for the task template.

", + "GetTaskTemplateResponse$Id": "

A unique identifier for the task template.

", + "StartTaskContactRequest$TaskTemplateId": "

A unique identifier for the task template.

", + "TaskTemplateMetadata$Id": "

A unique identifier for the task template.

", + "UpdateTaskTemplateRequest$TaskTemplateId": "

A unique identifier for the task template.

", + "UpdateTaskTemplateResponse$Id": "

The identifier of the task template resource.

" + } + }, + "TaskTemplateList": { + "base": null, + "refs": { + "ListTaskTemplatesResponse$TaskTemplates": "

Provides details about a list of task templates belonging to an instance.

" + } + }, + "TaskTemplateMetadata": { + "base": "

Contains summary information about the task template.

", + "refs": { + "TaskTemplateList$member": null + } + }, + "TaskTemplateName": { + "base": null, + "refs": { + "CreateTaskTemplateRequest$Name": "

The name of the task template.

", + "GetTaskTemplateResponse$Name": "

The name of the task template.

", + "ListTaskTemplatesRequest$Name": "

The name of the task template.

", + "TaskTemplateMetadata$Name": "

The name of the task template.

", + "UpdateTaskTemplateRequest$Name": "

The name of the task template.

", + "UpdateTaskTemplateResponse$Name": "

The name of the task template.

" + } + }, + "TaskTemplateSingleSelectOption": { + "base": null, + "refs": { + "SingleSelectOptions$member": null + } + }, + "TaskTemplateStatus": { + "base": null, + "refs": { + "CreateTaskTemplateRequest$Status": "

Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

", + "GetTaskTemplateResponse$Status": "

Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

", + "ListTaskTemplatesRequest$Status": "

Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

", + "TaskTemplateMetadata$Status": "

Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

", + "UpdateTaskTemplateRequest$Status": "

Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

", + "UpdateTaskTemplateResponse$Status": "

Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

" + } + }, "Threshold": { "base": "

Contains information about the threshold for service level metrics.

", "refs": { @@ -3628,6 +3956,16 @@ "StartOutboundVoiceContactRequest$TrafficType": "

Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is GENERAL. Use CAMPAIGN if EnableAnswerMachineDetection is set to true. For all other cases, use GENERAL.

" } }, + "TransferContactRequest": { + "base": null, + "refs": { + } + }, + "TransferContactResponse": { + "base": null, + "refs": { + } + }, "URI": { "base": null, "refs": { @@ -3820,6 +4158,16 @@ "refs": { } }, + "UpdateTaskTemplateRequest": { + "base": null, + "refs": { + } + }, + "UpdateTaskTemplateResponse": { + "base": null, + "refs": { + } + }, "UpdateUserHierarchyGroupNameRequest": { "base": null, "refs": { @@ -3858,7 +4206,7 @@ "UrlReference": { "base": "

The URL reference.

", "refs": { - "ReferenceSummary$Url": "

Information about the URL reference if the referenceType is URL. Otherwise, null.

" + "ReferenceSummary$Url": "

Information about the reference when the referenceType is URL. Otherwise, null.

" } }, "UseCase": { @@ -4115,8 +4463,14 @@ "GetCurrentMetricDataResponse$DataSnapshotTime": "

The time at which the metrics were retrieved and cached for pagination.

", "GetMetricDataRequest$StartTime": "

The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.

The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.

", "GetMetricDataRequest$EndTime": "

The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

The time range between the start and end time must be less than 24 hours.

", + "GetTaskTemplateResponse$LastModifiedTime": "

The timestamp when the task template was last modified.

", + "GetTaskTemplateResponse$CreatedTime": "

The timestamp when the task template was created.

", "QueueInfo$EnqueueTimestamp": "

The timestamp when the contact was added to the queue.

", - "SecurityKey$CreationTime": "

When the security key was created.

" + "SecurityKey$CreationTime": "

When the security key was created.

", + "TaskTemplateMetadata$LastModifiedTime": "

The timestamp when the task template was last modified.

", + "TaskTemplateMetadata$CreatedTime": "

The timestamp when the task template was created.

", + "UpdateTaskTemplateResponse$LastModifiedTime": "

The timestamp when the task template was last modified.

", + "UpdateTaskTemplateResponse$CreatedTime": "

The timestamp when the task template was created.

" } } } diff --git a/apis/connect/2017-08-08/paginators-1.json b/apis/connect/2017-08-08/paginators-1.json index 6083a3ffd9c..43a530db5ed 100644 --- a/apis/connect/2017-08-08/paginators-1.json +++ b/apis/connect/2017-08-08/paginators-1.json @@ -159,6 +159,12 @@ "output_token": "NextToken", "result_key": "SecurityProfileSummaryList" }, + "ListTaskTemplates": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "TaskTemplates" + }, "ListUseCases": { "input_token": "NextToken", "limit_key": "MaxResults", diff --git a/apis/kendra/2019-02-03/api-2.json b/apis/kendra/2019-02-03/api-2.json index 80cd65f5c8d..813cca53de1 100644 --- a/apis/kendra/2019-02-03/api-2.json +++ b/apis/kendra/2019-02-03/api-2.json @@ -1703,7 +1703,8 @@ "SlackConfiguration":{"shape":"SlackConfiguration"}, "BoxConfiguration":{"shape":"BoxConfiguration"}, "QuipConfiguration":{"shape":"QuipConfiguration"}, - "JiraConfiguration":{"shape":"JiraConfiguration"} + "JiraConfiguration":{"shape":"JiraConfiguration"}, + "GitHubConfiguration":{"shape":"GitHubConfiguration"} } }, "DataSourceDateFieldFormat":{ @@ -1879,7 +1880,8 @@ "SLACK", "BOX", "QUIP", - "JIRA" + "JIRA", + "GITHUB" ] }, "DataSourceVpcConfiguration":{ @@ -2840,6 +2842,46 @@ "NextToken":{"shape":"NextToken"} } }, + "GitHubConfiguration":{ + "type":"structure", + "required":["SecretArn"], + "members":{ + "SaaSConfiguration":{"shape":"SaaSConfiguration"}, + "OnPremiseConfiguration":{"shape":"OnPremiseConfiguration"}, + "Type":{"shape":"Type"}, + "SecretArn":{"shape":"SecretArn"}, + "UseChangeLog":{"shape":"Boolean"}, + "GitHubDocumentCrawlProperties":{"shape":"GitHubDocumentCrawlProperties"}, + "RepositoryFilter":{"shape":"RepositoryNames"}, + "InclusionFolderNamePatterns":{"shape":"StringList"}, + "InclusionFileTypePatterns":{"shape":"StringList"}, + "InclusionFileNamePatterns":{"shape":"StringList"}, + "ExclusionFolderNamePatterns":{"shape":"StringList"}, + "ExclusionFileTypePatterns":{"shape":"StringList"}, + "ExclusionFileNamePatterns":{"shape":"StringList"}, + "VpcConfiguration":{"shape":"DataSourceVpcConfiguration"}, + "GitHubRepositoryConfigurationFieldMappings":{"shape":"DataSourceToIndexFieldMappingList"}, + "GitHubCommitConfigurationFieldMappings":{"shape":"DataSourceToIndexFieldMappingList"}, + "GitHubIssueDocumentConfigurationFieldMappings":{"shape":"DataSourceToIndexFieldMappingList"}, + "GitHubIssueCommentConfigurationFieldMappings":{"shape":"DataSourceToIndexFieldMappingList"}, + "GitHubIssueAttachmentConfigurationFieldMappings":{"shape":"DataSourceToIndexFieldMappingList"}, + "GitHubPullRequestCommentConfigurationFieldMappings":{"shape":"DataSourceToIndexFieldMappingList"}, + "GitHubPullRequestDocumentConfigurationFieldMappings":{"shape":"DataSourceToIndexFieldMappingList"}, + "GitHubPullRequestDocumentAttachmentConfigurationFieldMappings":{"shape":"DataSourceToIndexFieldMappingList"} + } + }, + "GitHubDocumentCrawlProperties":{ + "type":"structure", + "members":{ + "CrawlRepositoryDocuments":{"shape":"Boolean"}, + "CrawlIssue":{"shape":"Boolean"}, + "CrawlIssueComment":{"shape":"Boolean"}, + "CrawlIssueCommentAttachment":{"shape":"Boolean"}, + "CrawlPullRequest":{"shape":"Boolean"}, + "CrawlPullRequestComment":{"shape":"Boolean"}, + "CrawlPullRequestCommentAttachment":{"shape":"Boolean"} + } + }, "GoogleDriveConfiguration":{ "type":"structure", "required":["SecretArn"], @@ -3531,6 +3573,19 @@ "min":1 }, "ObjectBoolean":{"type":"boolean"}, + "OnPremiseConfiguration":{ + "type":"structure", + "required":[ + "HostUrl", + "OrganizationName", + "SslCertificateS3Path" + ], + "members":{ + "HostUrl":{"shape":"Url"}, + "OrganizationName":{"shape":"OrganizationName"}, + "SslCertificateS3Path":{"shape":"S3Path"} + } + }, "OneDriveConfiguration":{ "type":"structure", "required":[ @@ -3580,6 +3635,12 @@ "min":12, "pattern":"d-[0-9a-fA-F]{10}" }, + "OrganizationName":{ + "type":"string", + "max":60, + "min":1, + "pattern":"^[A-Za-z0-9_.-]+$" + }, "Persona":{ "type":"string", "enum":[ @@ -3880,6 +3941,16 @@ "NOT_RELEVANT" ] }, + "RepositoryName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[A-Za-z0-9_.-]+$" + }, + "RepositoryNames":{ + "type":"list", + "member":{"shape":"RepositoryName"} + }, "ResourceAlreadyExistException":{ "type":"structure", "members":{ @@ -3953,6 +4024,17 @@ "Key":{"shape":"S3ObjectKey"} } }, + "SaaSConfiguration":{ + "type":"structure", + "required":[ + "OrganizationName", + "HostUrl" + ], + "members":{ + "OrganizationName":{"shape":"OrganizationName"}, + "HostUrl":{"shape":"Url"} + } + }, "SalesforceChatterFeedConfiguration":{ "type":"structure", "required":["DocumentDataFieldName"], @@ -4444,6 +4526,10 @@ "max":2048, "min":1 }, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, "SubmitFeedbackRequest":{ "type":"structure", "required":[ @@ -4662,6 +4748,13 @@ "max":5000, "min":0 }, + "Type":{ + "type":"string", + "enum":[ + "SAAS", + "ON_PREMISE" + ] + }, "UntagResourceRequest":{ "type":"structure", "required":[ diff --git a/apis/kendra/2019-02-03/docs-2.json b/apis/kendra/2019-02-03/docs-2.json index b9ec58fd832..76fb92a25e9 100644 --- a/apis/kendra/2019-02-03/docs-2.json +++ b/apis/kendra/2019-02-03/docs-2.json @@ -257,6 +257,14 @@ "ConfluenceSpaceConfiguration$CrawlArchivedSpaces": "

Specifies whether Amazon Kendra should index archived spaces.

", "ContentSourceConfiguration$DirectPutContent": "

TRUE to use documents you indexed directly using the BatchPutDocument API.

", "DocumentAttributeTarget$TargetDocumentAttributeValueDeletion": "

TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE. To create a target value (TargetDocumentAttributeValue), set this to FALSE.

", + "GitHubConfiguration$UseChangeLog": "

TRUE to use the GitHub change log to determine which documents require updating in the index. Depending on the GitHub change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in GitHub.

", + "GitHubDocumentCrawlProperties$CrawlRepositoryDocuments": "

TRUE to index all files with a repository.

", + "GitHubDocumentCrawlProperties$CrawlIssue": "

TRUE to index all issues within a repository.

", + "GitHubDocumentCrawlProperties$CrawlIssueComment": "

TRUE to index all comments on issues.

", + "GitHubDocumentCrawlProperties$CrawlIssueCommentAttachment": "

TRUE to include all comment attachments for issues.

", + "GitHubDocumentCrawlProperties$CrawlPullRequest": "

TRUE to index all pull requests within a repository.

", + "GitHubDocumentCrawlProperties$CrawlPullRequestComment": "

TRUE to index all comments on pull requests.

", + "GitHubDocumentCrawlProperties$CrawlPullRequestCommentAttachment": "

TRUE to include all comment attachments for pull requests.

", "Highlight$TopAnswer": "

Indicates whether the response is the best response. True if this is the best response; otherwise, false.

", "InlineCustomDocumentEnrichmentConfiguration$DocumentContentDeletion": "

TRUE to delete content if the condition used for the target attribute is met.

", "JiraConfiguration$UseChangeLog": "

Specify to use the change log option to update your index.

", @@ -790,6 +798,14 @@ "BoxConfiguration$WebLinkFieldMappings": "

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Box web links to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Box fields. For more information, see Mapping data source fields. The Box field names must exist in your Box custom metadata.

", "ColumnConfiguration$FieldMappings": "

An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex API.

", "FsxConfiguration$FieldMappings": "

A list of DataSourceToIndexFieldMapping objects that map Amazon FSx data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Amazon FSx fields. For more information, see Mapping data source fields. The Amazon FSx data source field names must exist in your Amazon FSx custom metadata.

", + "GitHubConfiguration$GitHubRepositoryConfigurationFieldMappings": "

A list of DataSourceToIndexFieldMapping objects that map GitHub repository attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

", + "GitHubConfiguration$GitHubCommitConfigurationFieldMappings": "

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub commits to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

", + "GitHubConfiguration$GitHubIssueDocumentConfigurationFieldMappings": "

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub issues to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

", + "GitHubConfiguration$GitHubIssueCommentConfigurationFieldMappings": "

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub issue comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

", + "GitHubConfiguration$GitHubIssueAttachmentConfigurationFieldMappings": "

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub issue attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

", + "GitHubConfiguration$GitHubPullRequestCommentConfigurationFieldMappings": "

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub pull request comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

", + "GitHubConfiguration$GitHubPullRequestDocumentConfigurationFieldMappings": "

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub pull requests to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

", + "GitHubConfiguration$GitHubPullRequestDocumentAttachmentConfigurationFieldMappings": "

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub pull request attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

", "GoogleDriveConfiguration$FieldMappings": "

Maps Google Drive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Google Drive fields. For more information, see Mapping data source fields. The Google Drive data source field names must exist in your Google Drive custom metadata.

", "JiraConfiguration$AttachmentFieldMappings": "

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.

", "JiraConfiguration$CommentFieldMappings": "

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.

", @@ -827,6 +843,7 @@ "ConfluenceConfiguration$VpcConfiguration": "

Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC.

", "DatabaseConfiguration$VpcConfiguration": null, "FsxConfiguration$VpcConfiguration": "

Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.

", + "GitHubConfiguration$VpcConfiguration": "

Configuration information of an Amazon Virtual Private Cloud to connect to your GitHub. For more information, see Configuring a VPC.

", "JiraConfiguration$VpcConfiguration": "

Configuration information for an Amazon Virtual Private Cloud to connect to your Jira. Your Jira account must reside inside your VPC.

", "QuipConfiguration$VpcConfiguration": "

Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see Configuring a VPC.

", "SharePointConfiguration$VpcConfiguration": null, @@ -1135,7 +1152,7 @@ "BatchDeleteDocumentResponseFailedDocument$Id": "

The identifier of the document that couldn't be removed from the index.

", "BatchGetDocumentStatusResponseError$DocumentId": "

The unique identifier of the document whose status could not be retrieved.

", "BatchPutDocumentResponseFailedDocument$Id": "

The unique identifier of the document.

", - "Document$Id": "

A unique identifier of the document in the index.

", + "Document$Id": "

A unique identifier of the document in the index.

Note, each document ID must be unique per index. You cannot create a data source to index your documents with their unique IDs and then use the BatchPutDocument API to index the same documents, or vice versa. You can delete a data source and then use the BatchPutDocument API to index the same documents, or vice versa.

", "DocumentIdList$member": null, "DocumentInfo$DocumentId": "

The unique identifier of the document.

", "QueryResultItem$DocumentId": "

The unique identifier for the document.

", @@ -1594,6 +1611,18 @@ "refs": { } }, + "GitHubConfiguration": { + "base": "

Provides the configuration information to connect to GitHub as your data source.

", + "refs": { + "DataSourceConfiguration$GitHubConfiguration": "

Provides the configuration information to connect to GitHub as your data source.

" + } + }, + "GitHubDocumentCrawlProperties": { + "base": "

Provides the configuration information to include certain types of GitHub content. You can configure to index repository files only, or also include issues and pull requests, comments, and comment attachments.

", + "refs": { + "GitHubConfiguration$GitHubDocumentCrawlProperties": "

Configuration information to include certain types of GitHub content. You can configure to index repository files only, or also include issues and pull requests, comments, and comment attachments.

" + } + }, "GoogleDriveConfiguration": { "base": "

Provides the configuration information to connect to Google Drive as your data source.

", "refs": { @@ -1919,7 +1948,7 @@ } }, "JiraConfiguration": { - "base": null, + "base": "

Provides the configuration information to connect to Jira as your data source.

", "refs": { "DataSourceConfiguration$JiraConfiguration": "

Provides the configuration information to connect to Jira as your data source.

" } @@ -1951,7 +1980,7 @@ "KmsKeyId": { "base": null, "refs": { - "ServerSideEncryptionConfiguration$KmsKeyId": "

The identifier of the KMScustomer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.

" + "ServerSideEncryptionConfiguration$KmsKeyId": "

The identifier of the KMS key. Amazon Kendra doesn't support asymmetric keys.

" } }, "LambdaArn": { @@ -2287,6 +2316,12 @@ "UpdateQuerySuggestionsConfigRequest$IncludeQueriesWithoutUserInformation": "

TRUE to include queries without user information (i.e. all queries, irrespective of the user), otherwise FALSE to only include queries with user information.

If you pass user information to Amazon Kendra along with the queries, you can set this flag to FALSE and instruct Amazon Kendra to only consider queries with user information.

If you set to FALSE, Amazon Kendra only considers queries searched at least MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for suggestions.

If you set to TRUE, Amazon Kendra ignores all user information and learns from all queries.

" } }, + "OnPremiseConfiguration": { + "base": "

Provides the configuration information to connect to GitHub Enterprise Server (on premises).

", + "refs": { + "GitHubConfiguration$OnPremiseConfiguration": "

Configuration information to connect to GitHub Enterprise Server (on premises).

" + } + }, "OneDriveConfiguration": { "base": "

Provides the configuration information to connect to OneDrive as your data source.

", "refs": { @@ -2323,6 +2358,13 @@ "WorkDocsConfiguration$OrganizationId": "

The identifier of the directory corresponding to your Amazon WorkDocs site repository.

You can find the organization ID in the Directory Service by going to Active Directory, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.

" } }, + "OrganizationName": { + "base": null, + "refs": { + "OnPremiseConfiguration$OrganizationName": "

The name of the organization of the GitHub Enterprise Server (in-premise) account you want to connect to. You can find your organization name by logging into GitHub desktop and selecting Your organizations under your profile picture dropdown.

", + "SaaSConfiguration$OrganizationName": "

The name of the organization of the GitHub Enterprise Cloud (SaaS) account you want to connect to. You can find your organization name by logging into GitHub desktop and selecting Your organizations under your profile picture dropdown.

" + } + }, "Persona": { "base": null, "refs": { @@ -2564,6 +2606,18 @@ "RelevanceFeedback$RelevanceValue": "

Whether to document was relevant or not relevant to the search.

" } }, + "RepositoryName": { + "base": null, + "refs": { + "RepositoryNames$member": null + } + }, + "RepositoryNames": { + "base": null, + "refs": { + "GitHubConfiguration$RepositoryFilter": "

A list of names of the specific repositories you want to index.

" + } + }, "ResourceAlreadyExistException": { "base": "

", "refs": { @@ -2652,12 +2706,19 @@ "DescribeThesaurusResponse$SourceS3Path": null, "Document$S3Path": null, "GroupMembers$S3PathforGroupMembers": "

If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.

You can download this example S3 file that uses the correct format for listing group members. Note, dataSourceId is optional. The value of type for a group is always GROUP and for a user it is always USER.

", + "OnPremiseConfiguration$SslCertificateS3Path": "

Information required to find a specific file in an Amazon S3 bucket.

", "OneDriveUsers$OneDriveUserS3Path": "

The S3 bucket location of a file containing a list of users whose documents should be indexed.

", "SharePointConfiguration$SslCertificateS3Path": null, "UpdateQuerySuggestionsBlockListRequest$SourceS3Path": "

The S3 path where your block list text file sits in S3.

If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.

If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.

", "UpdateThesaurusRequest$SourceS3Path": null } }, + "SaaSConfiguration": { + "base": "

Provides the configuration information to connect to GitHub Enterprise Cloud (SaaS).

", + "refs": { + "GitHubConfiguration$SaaSConfiguration": "

Configuration information to connect to GitHub Enterprise Cloud (SaaS).

" + } + }, "SalesforceChatterFeedConfiguration": { "base": "

The configuration information for syncing a Salesforce chatter feed. The contents of the object comes from the Salesforce FeedItem table.

", "refs": { @@ -2782,8 +2843,9 @@ "ConfluenceConfiguration$SecretArn": "

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Confluence server. The secret must contain a JSON structure with the following keys:

", "ConnectionConfiguration$SecretArn": "

The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about Secrets Manager, see What Is Secrets Manager in the Secrets Manager user guide.

", "FsxConfiguration$SecretArn": "

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Amazon FSx file system. Windows is currently the only supported type. The secret must contain a JSON structure with the following keys:

", + "GitHubConfiguration$SecretArn": "

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your GitHub. The secret must contain a JSON structure with the following keys:

", "GoogleDriveConfiguration$SecretArn": "

The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the credentials required to connect to Google Drive. For more information, see Using a Google Workspace Drive data source.

", - "JiraConfiguration$SecretArn": "

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Jira data source. The secret must contain a JSON structure with the following keys:

", + "JiraConfiguration$SecretArn": "

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Jira data source. The secret must contain a JSON structure with the following keys:

", "OneDriveConfiguration$SecretArn": "

The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the user name and password to connect to OneDrive. The user namd should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.

", "ProxyConfiguration$Credentials": "

Your secret ARN, which you can create in Secrets Manager

The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.

", "QuipConfiguration$SecretArn": "

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are required to connect to your Quip. The secret must contain a JSON structure with the following keys:

", @@ -2818,7 +2880,7 @@ } }, "ServerSideEncryptionConfiguration": { - "base": "

Provides the identifier of the KMScustomer master key (CMK) used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

", + "base": "

Provides the identifier of the KMS key used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric keys.

", "refs": { "CreateIndexRequest$ServerSideEncryptionConfiguration": "

The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

", "DescribeIndexResponse$ServerSideEncryptionConfiguration": "

The identifier of the KMScustomer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.

" @@ -3039,10 +3101,22 @@ "StartDataSourceSyncJobResponse$ExecutionId": "

Identifies a particular synchronization job.

", "Status$FailureCode": "

Indicates the source of the error.

", "Status$FailureReason": "

Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.

", + "StringList$member": null, "SuggestionTextWithHighlights$Text": "

The query suggestion text to display to the user.

", "TextWithHighlights$Text": "

The text to display to the user.

" } }, + "StringList": { + "base": null, + "refs": { + "GitHubConfiguration$InclusionFolderNamePatterns": "

A list of regular expression patterns to include certain folder names in your GitHub repository or repositories. Folder names that match the patterns are included in the index. Folder names that don't match the patterns are excluded from the index. If a folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the folder isn't included in the index.

", + "GitHubConfiguration$InclusionFileTypePatterns": "

A list of regular expression patterns to include certain file types in your GitHub repository or repositories. File types that match the patterns are included in the index. File types that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

", + "GitHubConfiguration$InclusionFileNamePatterns": "

A list of regular expression patterns to include certain file names in your GitHub repository or repositories. File names that match the patterns are included in the index. File names that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

", + "GitHubConfiguration$ExclusionFolderNamePatterns": "

A list of regular expression patterns to exclude certain folder names in your GitHub repository or repositories. Folder names that match the patterns are excluded from the index. Folder names that don't match the patterns are included in the index. If a folder matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence and the folder isn't included in the index.

", + "GitHubConfiguration$ExclusionFileTypePatterns": "

A list of regular expression patterns to exclude certain file types in your GitHub repository or repositories. File types that match the patterns are excluded from the index. File types that don't match the patterns are included in the index. If a file matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

", + "GitHubConfiguration$ExclusionFileNamePatterns": "

A list of regular expression patterns to exclude certain file names in your GitHub repository or repositories. File names that match the patterns are excluded from the index. File names that don't match the patterns are included in the index. If a file matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

" + } + }, "SubmitFeedbackRequest": { "base": null, "refs": { @@ -3296,6 +3370,12 @@ "Facet$MaxResults": "

Maximum number of facet values per facet. The default is 10. You can use this to limit the number of facet values to less than 10. If you want to increase the default, contact Support.

" } }, + "Type": { + "base": null, + "refs": { + "GitHubConfiguration$Type": "

The type of GitHub service you want to connect to—GitHub Enterprise Cloud (SaaS) or GitHub Enterprise Server (on premises).

" + } + }, "UntagResourceRequest": { "base": null, "refs": { @@ -3341,7 +3421,9 @@ "refs": { "ConfluenceConfiguration$ServerUrl": "

The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/. You can also use an IP address, for example, https://192.168.1.113/.

", "JwtTokenTypeConfiguration$URL": "

The signing key URL.

", + "OnPremiseConfiguration$HostUrl": "

The GitHub host URL or API endpoint URL. For example, https://on-prem-host-url/api/v3/

", "QueryResultItem$DocumentURI": "

The URI of the original location of the document.

", + "SaaSConfiguration$HostUrl": "

The GitHub host URL or API endpoint URL. For example, https://api.github.com.

", "SalesforceConfiguration$ServerUrl": "

The instance URL for the Salesforce site that you want to index.

", "SharePointUrlList$member": null } diff --git a/apis/proton/2020-07-20/api-2.json b/apis/proton/2020-07-20/api-2.json index 62659abe27e..c92cd855df9 100644 --- a/apis/proton/2020-07-20/api-2.json +++ b/apis/proton/2020-07-20/api-2.json @@ -31,6 +31,23 @@ ], "idempotent":true }, + "CancelComponentDeployment":{ + "name":"CancelComponentDeployment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelComponentDeploymentInput"}, + "output":{"shape":"CancelComponentDeploymentOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ] + }, "CancelEnvironmentDeployment":{ "name":"CancelEnvironmentDeployment", "http":{ @@ -82,6 +99,25 @@ {"shape":"InternalServerException"} ] }, + "CreateComponent":{ + "name":"CreateComponent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateComponentInput"}, + "output":{"shape":"CreateComponentOutput"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "idempotent":true + }, "CreateEnvironment":{ "name":"CreateEnvironment", "http":{ @@ -248,6 +284,24 @@ ], "idempotent":true }, + "DeleteComponent":{ + "name":"DeleteComponent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteComponentInput"}, + "output":{"shape":"DeleteComponentOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "idempotent":true + }, "DeleteEnvironment":{ "name":"DeleteEnvironment", "http":{ @@ -426,6 +480,22 @@ {"shape":"InternalServerException"} ] }, + "GetComponent":{ + "name":"GetComponent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetComponentInput"}, + "output":{"shape":"GetComponentOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ] + }, "GetEnvironment":{ "name":"GetEnvironment", "http":{ @@ -618,6 +688,53 @@ {"shape":"InternalServerException"} ] }, + "ListComponentOutputs":{ + "name":"ListComponentOutputs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListComponentOutputsInput"}, + "output":{"shape":"ListComponentOutputsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ] + }, + "ListComponentProvisionedResources":{ + "name":"ListComponentProvisionedResources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListComponentProvisionedResourcesInput"}, + "output":{"shape":"ListComponentProvisionedResourcesOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ] + }, + "ListComponents":{ + "name":"ListComponents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListComponentsInput"}, + "output":{"shape":"ListComponentsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ] + }, "ListEnvironmentAccountConnections":{ "name":"ListEnvironmentAccountConnections", "http":{ @@ -973,6 +1090,24 @@ {"shape":"InternalServerException"} ] }, + "UpdateComponent":{ + "name":"UpdateComponent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateComponentInput"}, + "output":{"shape":"UpdateComponentOutput"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ] + }, "UpdateEnvironment":{ "name":"UpdateEnvironment", "http":{ @@ -1185,6 +1320,20 @@ "type":"string", "pattern":"^\\d{12}$" }, + "CancelComponentDeploymentInput":{ + "type":"structure", + "required":["componentName"], + "members":{ + "componentName":{"shape":"ResourceName"} + } + }, + "CancelComponentDeploymentOutput":{ + "type":"structure", + "required":["component"], + "members":{ + "component":{"shape":"Component"} + } + }, "CancelEnvironmentDeploymentInput":{ "type":"structure", "required":["environmentName"], @@ -1269,6 +1418,68 @@ "type":"list", "member":{"shape":"CompatibleEnvironmentTemplate"} }, + "Component":{ + "type":"structure", + "required":[ + "arn", + "createdAt", + "deploymentStatus", + "environmentName", + "lastModifiedAt", + "name" + ], + "members":{ + "arn":{"shape":"ComponentArn"}, + "createdAt":{"shape":"Timestamp"}, + "deploymentStatus":{"shape":"DeploymentStatus"}, + "deploymentStatusMessage":{"shape":"StatusMessage"}, + "description":{"shape":"Description"}, + "environmentName":{"shape":"ResourceName"}, + "lastDeploymentAttemptedAt":{"shape":"Timestamp"}, + "lastDeploymentSucceededAt":{"shape":"Timestamp"}, + "lastModifiedAt":{"shape":"Timestamp"}, + "name":{"shape":"ResourceName"}, + "serviceInstanceName":{"shape":"ResourceName"}, + "serviceName":{"shape":"ResourceName"}, + "serviceSpec":{"shape":"SpecContents"} + } + }, + "ComponentArn":{"type":"string"}, + "ComponentDeploymentUpdateType":{ + "type":"string", + "enum":[ + "NONE", + "CURRENT_VERSION" + ] + }, + "ComponentSummary":{ + "type":"structure", + "required":[ + "arn", + "createdAt", + "deploymentStatus", + "environmentName", + "lastModifiedAt", + "name" + ], + "members":{ + "arn":{"shape":"ComponentArn"}, + "createdAt":{"shape":"Timestamp"}, + "deploymentStatus":{"shape":"DeploymentStatus"}, + "deploymentStatusMessage":{"shape":"StatusMessage"}, + "environmentName":{"shape":"ResourceName"}, + "lastDeploymentAttemptedAt":{"shape":"Timestamp"}, + "lastDeploymentSucceededAt":{"shape":"Timestamp"}, + "lastModifiedAt":{"shape":"Timestamp"}, + "name":{"shape":"ResourceName"}, + "serviceInstanceName":{"shape":"ResourceName"}, + "serviceName":{"shape":"ResourceName"} + } + }, + "ComponentSummaryList":{ + "type":"list", + "member":{"shape":"ComponentSummary"} + }, "ConflictException":{ "type":"structure", "required":["message"], @@ -1277,6 +1488,32 @@ }, "exception":true }, + "CreateComponentInput":{ + "type":"structure", + "required":[ + "manifest", + "name", + "templateFile" + ], + "members":{ + "description":{"shape":"Description"}, + "environmentName":{"shape":"ResourceName"}, + "manifest":{"shape":"TemplateManifestContents"}, + "name":{"shape":"ResourceName"}, + "serviceInstanceName":{"shape":"ResourceName"}, + "serviceName":{"shape":"ResourceName"}, + "serviceSpec":{"shape":"SpecContents"}, + "tags":{"shape":"TagList"}, + "templateFile":{"shape":"TemplateFileContents"} + } + }, + "CreateComponentOutput":{ + "type":"structure", + "required":["component"], + "members":{ + "component":{"shape":"Component"} + } + }, "CreateEnvironmentAccountConnectionInput":{ "type":"structure", "required":[ @@ -1289,6 +1526,7 @@ "shape":"ClientToken", "idempotencyToken":true }, + "componentRoleArn":{"shape":"Arn"}, "environmentName":{"shape":"ResourceName"}, "managementAccountId":{"shape":"AwsAccountId"}, "roleArn":{"shape":"Arn"}, @@ -1311,6 +1549,7 @@ "templateName" ], "members":{ + "componentRoleArn":{"shape":"Arn"}, "description":{"shape":"Description"}, "environmentAccountConnectionId":{"shape":"EnvironmentAccountConnectionId"}, "name":{"shape":"ResourceName"}, @@ -1459,6 +1698,7 @@ "description":{"shape":"Description"}, "majorVersion":{"shape":"TemplateVersionPart"}, "source":{"shape":"TemplateVersionSourceInput"}, + "supportedComponentSources":{"shape":"ServiceTemplateSupportedComponentSourceInputList"}, "tags":{"shape":"TagList"}, "templateName":{"shape":"ResourceName"} } @@ -1494,6 +1734,19 @@ "templateSyncConfig":{"shape":"TemplateSyncConfig"} } }, + "DeleteComponentInput":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{"shape":"ResourceName"} + } + }, + "DeleteComponentOutput":{ + "type":"structure", + "members":{ + "component":{"shape":"Component"} + } + }, "DeleteEnvironmentAccountConnectionInput":{ "type":"structure", "required":["id"], @@ -1689,6 +1942,7 @@ ], "members":{ "arn":{"shape":"EnvironmentArn"}, + "componentRoleArn":{"shape":"Arn"}, "createdAt":{"shape":"Timestamp"}, "deploymentStatus":{"shape":"DeploymentStatus"}, "deploymentStatusMessage":{"shape":"StatusMessage"}, @@ -1722,6 +1976,7 @@ ], "members":{ "arn":{"shape":"EnvironmentAccountConnectionArn"}, + "componentRoleArn":{"shape":"Arn"}, "environmentAccountId":{"shape":"AwsAccountId"}, "environmentName":{"shape":"ResourceName"}, "id":{"shape":"EnvironmentAccountConnectionId"}, @@ -1771,6 +2026,7 @@ ], "members":{ "arn":{"shape":"EnvironmentAccountConnectionArn"}, + "componentRoleArn":{"shape":"Arn"}, "environmentAccountId":{"shape":"AwsAccountId"}, "environmentName":{"shape":"ResourceName"}, "id":{"shape":"EnvironmentAccountConnectionId"}, @@ -1801,6 +2057,7 @@ ], "members":{ "arn":{"shape":"EnvironmentArn"}, + "componentRoleArn":{"shape":"Arn"}, "createdAt":{"shape":"Timestamp"}, "deploymentStatus":{"shape":"DeploymentStatus"}, "deploymentStatusMessage":{"shape":"StatusMessage"}, @@ -1955,6 +2212,19 @@ "accountSettings":{"shape":"AccountSettings"} } }, + "GetComponentInput":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{"shape":"ResourceName"} + } + }, + "GetComponentOutput":{ + "type":"structure", + "members":{ + "component":{"shape":"Component"} + } + }, "GetEnvironmentAccountConnectionInput":{ "type":"structure", "required":["id"], @@ -2174,6 +2444,56 @@ "fault":true, "retryable":{"throttling":false} }, + "ListComponentOutputsInput":{ + "type":"structure", + "required":["componentName"], + "members":{ + "componentName":{"shape":"ResourceName"}, + "nextToken":{"shape":"EmptyNextToken"} + } + }, + "ListComponentOutputsOutput":{ + "type":"structure", + "required":["outputs"], + "members":{ + "nextToken":{"shape":"EmptyNextToken"}, + "outputs":{"shape":"OutputsList"} + } + }, + "ListComponentProvisionedResourcesInput":{ + "type":"structure", + "required":["componentName"], + "members":{ + "componentName":{"shape":"ResourceName"}, + "nextToken":{"shape":"EmptyNextToken"} + } + }, + "ListComponentProvisionedResourcesOutput":{ + "type":"structure", + "required":["provisionedResources"], + "members":{ + "nextToken":{"shape":"EmptyNextToken"}, + "provisionedResources":{"shape":"ProvisionedResourceList"} + } + }, + "ListComponentsInput":{ + "type":"structure", + "members":{ + "environmentName":{"shape":"ResourceName"}, + "maxResults":{"shape":"MaxPageResults"}, + "nextToken":{"shape":"NextToken"}, + "serviceInstanceName":{"shape":"ResourceName"}, + "serviceName":{"shape":"ResourceName"} + } + }, + "ListComponentsOutput":{ + "type":"structure", + "required":["components"], + "members":{ + "components":{"shape":"ComponentSummaryList"}, + "nextToken":{"shape":"NextToken"} + } + }, "ListEnvironmentAccountConnectionsInput":{ "type":"structure", "required":["requestedBy"], @@ -2485,7 +2805,7 @@ "outputs":{"shape":"NotifyResourceDeploymentStatusChangeInputOutputsList"}, "resourceArn":{"shape":"Arn"}, "status":{"shape":"ResourceDeploymentStatus"}, - "statusMessage":{"shape":"SyntheticNotifyResourceDeploymentStatusChangeInputString"} + "statusMessage":{"shape":"NotifyResourceDeploymentStatusChangeInputStatusMessageString"} } }, "NotifyResourceDeploymentStatusChangeInputOutputsList":{ @@ -2494,6 +2814,12 @@ "max":50, "min":0 }, + "NotifyResourceDeploymentStatusChangeInputStatusMessageString":{ + "type":"string", + "max":5000, + "min":0, + "sensitive":true + }, "NotifyResourceDeploymentStatusChangeOutput":{ "type":"structure", "members":{ @@ -2729,6 +3055,12 @@ "min":1, "pattern":"^[0-9A-Za-z]+[0-9A-Za-z_\\-]*$" }, + "ResourceNameOrEmpty":{ + "type":"string", + "max":100, + "min":0, + "pattern":"(^$)|^[0-9A-Za-z]+[0-9A-Za-z_\\-]*$" + }, "ResourceNotFoundException":{ "type":"structure", "required":["message"], @@ -3042,6 +3374,14 @@ "type":"list", "member":{"shape":"ServiceTemplateSummary"} }, + "ServiceTemplateSupportedComponentSourceInputList":{ + "type":"list", + "member":{"shape":"ServiceTemplateSupportedComponentSourceType"} + }, + "ServiceTemplateSupportedComponentSourceType":{ + "type":"string", + "enum":["DIRECTLY_DEFINED"] + }, "ServiceTemplateVersion":{ "type":"structure", "required":[ @@ -3066,6 +3406,7 @@ "schema":{"shape":"TemplateSchema"}, "status":{"shape":"TemplateVersionStatus"}, "statusMessage":{"shape":"StatusMessage"}, + "supportedComponentSources":{"shape":"ServiceTemplateSupportedComponentSourceInputList"}, "templateName":{"shape":"ResourceName"} } }, @@ -3118,12 +3459,6 @@ "type":"string", "enum":["TEMPLATE_SYNC"] }, - "SyntheticNotifyResourceDeploymentStatusChangeInputString":{ - "type":"string", - "max":5000, - "min":0, - "sensitive":true - }, "Tag":{ "type":"structure", "required":[ @@ -3173,6 +3508,18 @@ "max":256, "min":0 }, + "TemplateFileContents":{ + "type":"string", + "max":51200, + "min":1, + "sensitive":true + }, + "TemplateManifestContents":{ + "type":"string", + "max":1024, + "min":1, + "sensitive":true + }, "TemplateSchema":{ "type":"string", "max":51200, @@ -3266,13 +3613,34 @@ "accountSettings":{"shape":"AccountSettings"} } }, - "UpdateEnvironmentAccountConnectionInput":{ + "UpdateComponentInput":{ "type":"structure", "required":[ - "id", - "roleArn" + "deploymentType", + "name" ], "members":{ + "deploymentType":{"shape":"ComponentDeploymentUpdateType"}, + "description":{"shape":"Description"}, + "name":{"shape":"ResourceName"}, + "serviceInstanceName":{"shape":"ResourceNameOrEmpty"}, + "serviceName":{"shape":"ResourceNameOrEmpty"}, + "serviceSpec":{"shape":"SpecContents"}, + "templateFile":{"shape":"TemplateFileContents"} + } + }, + "UpdateComponentOutput":{ + "type":"structure", + "required":["component"], + "members":{ + "component":{"shape":"Component"} + } + }, + "UpdateEnvironmentAccountConnectionInput":{ + "type":"structure", + "required":["id"], + "members":{ + "componentRoleArn":{"shape":"Arn"}, "id":{"shape":"EnvironmentAccountConnectionId"}, "roleArn":{"shape":"Arn"} } @@ -3291,6 +3659,7 @@ "name" ], "members":{ + "componentRoleArn":{"shape":"Arn"}, "deploymentType":{"shape":"DeploymentUpdateType"}, "description":{"shape":"Description"}, "environmentAccountConnectionId":{"shape":"EnvironmentAccountConnectionId"}, @@ -3437,6 +3806,7 @@ "majorVersion":{"shape":"TemplateVersionPart"}, "minorVersion":{"shape":"TemplateVersionPart"}, "status":{"shape":"TemplateVersionStatus"}, + "supportedComponentSources":{"shape":"ServiceTemplateSupportedComponentSourceInputList"}, "templateName":{"shape":"ResourceName"} } }, diff --git a/apis/proton/2020-07-20/docs-2.json b/apis/proton/2020-07-20/docs-2.json index 4a56e7f5940..00aa11c2eb5 100644 --- a/apis/proton/2020-07-20/docs-2.json +++ b/apis/proton/2020-07-20/docs-2.json @@ -3,9 +3,11 @@ "service": "

This is the Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the actions and data types for the Proton service.

The documentation for each action shows the Query API request parameters and the XML response.

Alternatively, you can use the Amazon Web Services CLI to access an API. For more information, see the Amazon Web Services Command Line Interface User Guide.

The Proton service is a two-pronged automation framework. Administrators create service templates to provide standardized infrastructure and deployment tooling for serverless and container based applications. Developers, in turn, select from the available service templates to automate their application or service deployments.

Because administrators define the infrastructure and tooling that Proton deploys and manages, they need permissions to use all of the listed API operations.

When developers select a specific infrastructure and tooling set, Proton deploys their applications. To monitor their applications that are running on Proton, developers need permissions to the service create, list, update and delete API operations and the service instance list and update API operations.

To learn more about Proton administration, see the Proton Administrator Guide.

To learn more about deploying serverless and containerized applications on Proton, see the Proton User Guide.

Ensuring Idempotency

When you make a mutating API request, the request typically returns a result before the asynchronous workflows of the operation are complete. Operations might also time out or encounter other server issues before they're complete, even if the request already returned a result. This might make it difficult to determine whether the request succeeded. Moreover, you might need to retry the request multiple times to ensure that the operation completes successfully. However, if the original request and the subsequent retries are successful, the operation occurs multiple times. This means that you might create more resources than you intended.

Idempotency ensures that an API request action completes no more than one time. With an idempotent request, if the original request action completes successfully, any subsequent retries complete successfully without performing any further actions. However, the result might contain updated information, such as the current creation status.

The following lists of APIs are grouped according to methods that ensure idempotency.

Idempotent create APIs with a client token

The API actions in this list support idempotency with the use of a client token. The corresponding Amazon Web Services CLI commands also support idempotency using a client token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request. We recommend that you don't reuse the same client token for other API requests. If you don’t provide a client token for these APIs, a default client token is automatically provided by SDKs.

Given a request action that has succeeded:

If you retry the request using the same client token and the same parameters, the retry succeeds without performing any further actions other than returning the original resource detail data in the response.

If you retry the request using the same client token, but one or more of the parameters are different, the retry throws a ValidationException with an IdempotentParameterMismatch error.

Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new resource is created.

If the original resource is deleted and you retry the request, a new resource is created.

Idempotent create APIs with a client token:

Idempotent create APIs

Given a request action that has succeeded:

If you retry the request with an API from this group, and the original resource hasn't been modified, the retry succeeds without performing any further actions other than returning the original resource detail data in the response.

If the original resource has been modified, the retry throws a ConflictException.

If you retry with different input parameters, the retry throws a ValidationException with an IdempotentParameterMismatch error.

Idempotent create APIs:

Idempotent delete APIs

Given a request action that has succeeded:

When you retry the request with an API from this group and the resource was deleted, its metadata is returned in the response.

If you retry and the resource doesn't exist, the response is empty.

In both cases, the retry succeeds.

Idempotent delete APIs:

Asynchronous idempotent delete APIs

Given a request action that has succeeded:

If you retry the request with an API from this group, if the original request delete operation status is DELETE_IN_PROGRESS, the retry returns the resource detail data in the response without performing any further actions.

If the original request delete operation is complete, a retry returns an empty response.

Asynchronous idempotent delete APIs:

", "operations": { "AcceptEnvironmentAccountConnection": "

In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.

For more information, see Environment account connections in the Proton Administrator guide.

", + "CancelComponentDeployment": "

Attempts to cancel a component deployment (for a component that is in the IN_PROGRESS deployment status).

For more information about components, see Proton components in the Proton Administrator Guide.

", "CancelEnvironmentDeployment": "

Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is IN_PROGRESS. For more information, see Update an environment in the Proton Administrator guide.

The following list includes potential cancellation scenarios.

", "CancelServiceInstanceDeployment": "

Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is IN_PROGRESS. For more information, see Update a service instance in the Proton Administrator guide or the Proton User guide.

The following list includes potential cancellation scenarios.

", "CancelServicePipelineDeployment": "

Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is IN_PROGRESS. For more information, see Update a service pipeline in the Proton Administrator guide or the Proton User guide.

The following list includes potential cancellation scenarios.

", + "CreateComponent": "

Create an Proton component. A component is an infrastructure extension for a service instance.

For more information about components, see Proton components in the Proton Administrator Guide.

", "CreateEnvironment": "

Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can be shared across services.

You can provision environments using the following methods:

For more information, see Environments and Provisioning methods in the Proton Administrator Guide.

", "CreateEnvironmentAccountConnection": "

Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment account from a management account.

An environment account connection is a secure bi-directional connection between a management account and an environment account that maintains authorization and permissions. For more information, see Environment account connections in the Proton Administrator guide.

", "CreateEnvironmentTemplate": "

Create an environment template for Proton. For more information, see Environment Templates in the Proton Administrator Guide.

You can create an environment template in one of the two following ways:

", @@ -15,28 +17,33 @@ "CreateServiceTemplate": "

Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CI/CD service pipeline. Developers, in turn, select the service template from Proton. If the selected service template includes a service pipeline definition, they provide a link to their source code repository. Proton then deploys and manages the infrastructure defined by the selected service template. For more information, see Service Templates in the Proton Administrator Guide.

", "CreateServiceTemplateVersion": "

Create a new major or minor version of a service template. A major version of a service template is a version that isn't backward compatible. A minor version of a service template is a version that's backward compatible within its major version.

", "CreateTemplateSyncConfig": "

Set up a template to create new template versions automatically. When a commit is pushed to your registered repository, Proton checks for changes to your repository template bundles. If it detects a template bundle change, a new major or minor version of its template is created, if the version doesn’t already exist. For more information, see Template sync configurations in the Proton Administrator Guide.

", + "DeleteComponent": "

Delete an Proton component resource.

For more information about components, see Proton components in the Proton Administrator Guide.

", "DeleteEnvironment": "

Delete an environment.

", "DeleteEnvironmentAccountConnection": "

In an environment account, delete an environment account connection.

After you delete an environment account connection that’s in use by an Proton environment, Proton can’t manage the environment infrastructure resources until a new environment account connection is accepted for the environment account and associated environment. You're responsible for cleaning up provisioned resources that remain without an environment connection.

For more information, see Environment account connections in the Proton Administrator guide.

", "DeleteEnvironmentTemplate": "

If no other major or minor versions of an environment template exist, delete the environment template.

", "DeleteEnvironmentTemplateVersion": "

If no other minor versions of an environment template exist, delete a major version of the environment template if it's not the Recommended version. Delete the Recommended version of the environment template if no other major versions or minor versions of the environment template exist. A major version of an environment template is a version that's not backward compatible.

Delete a minor version of an environment template if it isn't the Recommended version. Delete a Recommended minor version of the environment template if no other minor versions of the environment template exist. A minor version of an environment template is a version that's backward compatible.

", "DeleteRepository": "

De-register and unlink your repository.

", - "DeleteService": "

Delete a service.

", + "DeleteService": "

Delete a service, with its instances and pipeline.

You can't delete a service if it has any service instances that have components attached to them.

For more information about components, see Proton components in the Proton Administrator Guide.

", "DeleteServiceTemplate": "

If no other major or minor versions of the service template exist, delete the service template.

", "DeleteServiceTemplateVersion": "

If no other minor versions of a service template exist, delete a major version of the service template if it's not the Recommended version. Delete the Recommended version of the service template if no other major versions or minor versions of the service template exist. A major version of a service template is a version that isn't backwards compatible.

Delete a minor version of a service template if it's not the Recommended version. Delete a Recommended minor version of the service template if no other minor versions of the service template exist. A minor version of a service template is a version that's backwards compatible.

", "DeleteTemplateSyncConfig": "

Delete a template sync configuration.

", "GetAccountSettings": "

Get detail data for the Proton pipeline service role.

", - "GetEnvironment": "

Get detail data for an environment.

", - "GetEnvironmentAccountConnection": "

In an environment account, view the detail data for an environment account connection.

For more information, see Environment account connections in the Proton Administrator guide.

", - "GetEnvironmentTemplate": "

Get detail data for an environment template.

", - "GetEnvironmentTemplateVersion": "

View detail data for a major or minor version of an environment template.

", + "GetComponent": "

Get detailed data for a component.

For more information about components, see Proton components in the Proton Administrator Guide.

", + "GetEnvironment": "

Get detailed data for an environment.

", + "GetEnvironmentAccountConnection": "

In an environment account, get the detailed data for an environment account connection.

For more information, see Environment account connections in the Proton Administrator guide.

", + "GetEnvironmentTemplate": "

Get detailed data for an environment template.

", + "GetEnvironmentTemplateVersion": "

Get detailed data for a major or minor version of an environment template.

", "GetRepository": "

Get detail data for a repository.

", "GetRepositorySyncStatus": "

Get the sync status of a repository used for Proton template sync. For more information about template sync, see .

A repository sync status isn't tied to the Proton Repository resource (or any other Proton resource). Therefore, tags on an Proton Repository resource have no effect on this action. Specifically, you can't use these tags to control access to this action using Attribute-based access control (ABAC).

For more information about ABAC, see ABAC in the Proton Administrator Guide.

", - "GetService": "

Get detail data for a service.

", - "GetServiceInstance": "

Get detail data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.

", - "GetServiceTemplate": "

Get detail data for a service template.

", - "GetServiceTemplateVersion": "

View detail data for a major or minor version of a service template.

", + "GetService": "

Get detailed data for a service.

", + "GetServiceInstance": "

Get detailed data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.

", + "GetServiceTemplate": "

Get detailed data for a service template.

", + "GetServiceTemplateVersion": "

Get detailed data for a major or minor version of a service template.

", "GetTemplateSyncConfig": "

Get detail data for a template sync configuration.

", "GetTemplateSyncStatus": "

Get the status of a template sync.

", + "ListComponentOutputs": "

Get a list of component Infrastructure as Code (IaC) outputs.

For more information about components, see Proton components in the Proton Administrator Guide.

", + "ListComponentProvisionedResources": "

List provisioned resources for a component with details.

For more information about components, see Proton components in the Proton Administrator Guide.

", + "ListComponents": "

List components with summary data. You can filter the result list by environment, service, or a single service instance.

For more information about components, see Proton components in the Proton Administrator Guide.

", "ListEnvironmentAccountConnections": "

View a list of environment account connections.

For more information, see Environment account connections in the Proton Administrator guide.

", "ListEnvironmentOutputs": "

List the infrastructure as code outputs for your environment.

", "ListEnvironmentProvisionedResources": "

List the provisioned resources for your environment.

", @@ -45,10 +52,10 @@ "ListEnvironments": "

List environments with detail data summaries.

", "ListRepositories": "

List repositories with detail data.

", "ListRepositorySyncDefinitions": "

List repository sync definitions with detail data.

", - "ListServiceInstanceOutputs": "

View a list service instance infrastructure as code outputs with detail data.

", + "ListServiceInstanceOutputs": "

Get a list service of instance Infrastructure as Code (IaC) outputs.

", "ListServiceInstanceProvisionedResources": "

List provisioned resources for a service instance with details.

", - "ListServiceInstances": "

List service instances with summaries of detail data.

", - "ListServicePipelineOutputs": "

View a list service pipeline infrastructure as code outputs with detail.

", + "ListServiceInstances": "

List service instances with summary data.

", + "ListServicePipelineOutputs": "

Get a list of service pipeline Infrastructure as Code (IaC) outputs.

", "ListServicePipelineProvisionedResources": "

List provisioned resources for a service and pipeline with details.

", "ListServiceTemplateVersions": "

List major or minor versions of a service template with detail data.

", "ListServiceTemplates": "

List service templates with detail data.

", @@ -59,12 +66,13 @@ "TagResource": "

Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton resource.

For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.

", "UntagResource": "

Remove a customer tag from a resource. A tag is a key-value pair of metadata associated with an Proton resource.

For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.

", "UpdateAccountSettings": "

Update the Proton service pipeline role or repository settings.

", + "UpdateComponent": "

Update a component.

There are a few modes for updating a component. The deploymentType field defines the mode.

You can't update a component while its deployment status, or the deployment status of a service instance attached to it, is IN_PROGRESS.

For more information about components, see Proton components in the Proton Administrator Guide.

", "UpdateEnvironment": "

Update an environment.

If the environment is associated with an environment account connection, don't update or include the protonServiceRoleArn and provisioningRepository parameter to update or connect to an environment account connection.

You can only update to a new environment account connection if that connection was created in the same environment account that the current environment account connection was created in. The account connection must also be associated with the current environment.

If the environment isn't associated with an environment account connection, don't update or include the environmentAccountConnectionId parameter. You can't update or connect the environment to an environment account connection if it isn't already associated with an environment connection.

You can update either the environmentAccountConnectionId or protonServiceRoleArn parameter and value. You can’t update both.

If the environment was configured for Amazon Web Services-managed provisioning, omit the provisioningRepository parameter.

If the environment was configured for self-managed provisioning, specify the provisioningRepository parameter and omit the protonServiceRoleArn and environmentAccountConnectionId parameters.

For more information, see Environments and Provisioning methods in the Proton Administrator Guide.

There are four modes for updating an environment. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type.

MINOR_VERSION

In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

MAJOR_VERSION

In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that's higher than the major version in use and a minor version.

", "UpdateEnvironmentAccountConnection": "

In an environment account, update an environment account connection to use a new IAM role.

For more information, see Environment account connections in the Proton Administrator guide.

", "UpdateEnvironmentTemplate": "

Update an environment template.

", "UpdateEnvironmentTemplateVersion": "

Update a major or minor version of an environment template.

", - "UpdateService": "

Edit a service description or use a spec to add and delete service instances.

Existing service instances and the service pipeline can't be edited using this API. They can only be deleted.

Use the description parameter to modify the description.

Edit the spec parameter to add or delete instances.

", - "UpdateServiceInstance": "

Update a service instance.

There are four modes for updating a service instance. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type.

MINOR_VERSION

In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

MAJOR_VERSION

In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that's higher than the major version in use and a minor version.

", + "UpdateService": "

Edit a service description or use a spec to add and delete service instances.

Existing service instances and the service pipeline can't be edited using this API. They can only be deleted.

Use the description parameter to modify the description.

Edit the spec parameter to add or delete instances.

You can't delete a service instance (remove it from the spec) if it has an attached component.

For more information about components, see Proton components in the Proton Administrator Guide.

", + "UpdateServiceInstance": "

Update a service instance.

There are a few modes for updating a service instance. The deploymentType field defines the mode.

You can't update a service instance while its deployment status, or the deployment status of a component attached to it, is IN_PROGRESS.

For more information about components, see Proton components in the Proton Administrator Guide.

", "UpdateServicePipeline": "

Update the service pipeline.

There are four modes for updating a service pipeline. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment-type.

MINOR_VERSION

In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can specify a different minor version of the current major version in use.

MAJOR_VERSION

In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template by default. You can specify a different major version that's higher than the major version in use and a minor version.

", "UpdateServiceTemplate": "

Update a service template.

", "UpdateServiceTemplateVersion": "

Update a major or minor version of a service template.

", @@ -96,16 +104,22 @@ "Arn": { "base": null, "refs": { + "CreateEnvironmentAccountConnectionInput$componentRoleArn": "

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.

You must specify componentRoleArn to allow directly defined components to be associated with any environments running in this account.

For more information about components, see Proton components in the Proton Administrator Guide.

", "CreateEnvironmentAccountConnectionInput$roleArn": "

The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. Proton uses this role to provision infrastructure resources in the associated environment account.

", + "CreateEnvironmentInput$componentRoleArn": "

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

You must specify componentRoleArn to allow directly defined components to be associated with this environment.

For more information about components, see Proton components in the Proton Administrator Guide.

", "CreateEnvironmentInput$protonServiceRoleArn": "

The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.

To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.

", "CreateEnvironmentTemplateInput$encryptionKey": "

A customer provided encryption key that Proton uses to encrypt data.

", "CreateRepositoryInput$connectionArn": "

The Amazon Resource Name (ARN) of your Amazon Web Services CodeStar connection. For more information, see Setting up for Proton in the Proton Administrator Guide.

", "CreateRepositoryInput$encryptionKey": "

The ARN of your customer Amazon Web Services Key Management Service (Amazon Web Services KMS) key.

", "CreateServiceInput$repositoryConnectionArn": "

The Amazon Resource Name (ARN) of the repository connection. For more information, see Set up repository connection in the Proton Administrator Guide and Setting up with Proton in the Proton User Guide. Don't include this parameter if your service template doesn't include a service pipeline.

", "CreateServiceTemplateInput$encryptionKey": "

A customer provided encryption key that's used to encrypt data.

", + "Environment$componentRoleArn": "

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.

For more information about components, see Proton components in the Proton Administrator Guide.

", "Environment$protonServiceRoleArn": "

The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.

", + "EnvironmentAccountConnection$componentRoleArn": "

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.

The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.

For more information about components, see Proton components in the Proton Administrator Guide.

", "EnvironmentAccountConnection$roleArn": "

The IAM service role that's associated with the environment account connection.

", + "EnvironmentAccountConnectionSummary$componentRoleArn": "

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.

The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.

For more information about components, see Proton components in the Proton Administrator Guide.

", "EnvironmentAccountConnectionSummary$roleArn": "

The IAM service role that's associated with the environment account connection.

", + "EnvironmentSummary$componentRoleArn": "

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.

For more information about components, see Proton components in the Proton Administrator Guide.

", "EnvironmentSummary$protonServiceRoleArn": "

The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.

", "EnvironmentTemplate$encryptionKey": "

The customer provided encryption key for the environment template.

", "ListTagsForResourceInput$resourceArn": "

The Amazon Resource Name (ARN) of the resource for the listed tags.

", @@ -117,7 +131,9 @@ "ServiceTemplate$encryptionKey": "

The customer provided service template encryption key that's used to encrypt data.

", "TagResourceInput$resourceArn": "

The Amazon Resource Name (ARN) of the Proton resource to apply customer tags to.

", "UntagResourceInput$resourceArn": "

The Amazon Resource Name (ARN) of the resource to remove customer tags from.

", + "UpdateEnvironmentAccountConnectionInput$componentRoleArn": "

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.

The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.

For more information about components, see Proton components in the Proton Administrator Guide.

", "UpdateEnvironmentAccountConnectionInput$roleArn": "

The Amazon Resource Name (ARN) of the IAM service role that's associated with the environment account connection to update.

", + "UpdateEnvironmentInput$componentRoleArn": "

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.

For more information about components, see Proton components in the Proton Administrator Guide.

", "UpdateEnvironmentInput$protonServiceRoleArn": "

The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.

" } }, @@ -133,6 +149,16 @@ "EnvironmentSummary$environmentAccountId": "

The ID of the environment account that the environment infrastructure resources are provisioned in.

" } }, + "CancelComponentDeploymentInput": { + "base": null, + "refs": { + } + }, + "CancelComponentDeploymentOutput": { + "base": null, + "refs": { + } + }, "CancelEnvironmentDeploymentInput": { "base": null, "refs": { @@ -186,8 +212,8 @@ "CompatibleEnvironmentTemplateInputList": { "base": null, "refs": { - "CreateServiceTemplateVersionInput$compatibleEnvironmentTemplates": "

An array of compatible environment template objects for the new version of a service template.

", - "UpdateServiceTemplateVersionInput$compatibleEnvironmentTemplates": "

An array of compatible environment names for a service template major or minor version to update.

" + "CreateServiceTemplateVersionInput$compatibleEnvironmentTemplates": "

An array of environment template objects that are compatible with the new service template version. A service instance based on this service template version can run in environments based on compatible templates.

", + "UpdateServiceTemplateVersionInput$compatibleEnvironmentTemplates": "

An array of environment template objects that are compatible with this service template version. A service instance based on this service template version can run in environments based on compatible templates.

" } }, "CompatibleEnvironmentTemplateList": { @@ -196,11 +222,56 @@ "ServiceTemplateVersion$compatibleEnvironmentTemplates": "

An array of compatible environment template names for the major version of a service template.

" } }, + "Component": { + "base": "

Detailed data of an Proton component resource.

For more information about components, see Proton components in the Proton Administrator Guide.

", + "refs": { + "CancelComponentDeploymentOutput$component": "

The detailed data of the component with the deployment that is being canceled.

", + "CreateComponentOutput$component": "

The detailed data of the created component.

", + "DeleteComponentOutput$component": "

The detailed data of the component being deleted.

", + "GetComponentOutput$component": "

The detailed data of the requested component.

", + "UpdateComponentOutput$component": "

The detailed data of the updated component.

" + } + }, + "ComponentArn": { + "base": null, + "refs": { + "Component$arn": "

The Amazon Resource Name (ARN) of the component.

", + "ComponentSummary$arn": "

The Amazon Resource Name (ARN) of the component.

" + } + }, + "ComponentDeploymentUpdateType": { + "base": null, + "refs": { + "UpdateComponentInput$deploymentType": "

The deployment type. It defines the mode for updating a component, as follows:

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. You can only specify description in this mode.

CURRENT_VERSION

In this mode, the component is deployed and updated with the new serviceSpec, templateSource, and/or type that you provide. Only requested parameters are updated.

" + } + }, + "ComponentSummary": { + "base": "

Summary data of an Proton component resource.

For more information about components, see Proton components in the Proton Administrator Guide.

", + "refs": { + "ComponentSummaryList$member": null + } + }, + "ComponentSummaryList": { + "base": null, + "refs": { + "ListComponentsOutput$components": "

An array of components with summary data.

" + } + }, "ConflictException": { "base": "

The request couldn't be made due to a conflicting operation or resource.

", "refs": { } }, + "CreateComponentInput": { + "base": null, + "refs": { + } + }, + "CreateComponentOutput": { + "base": null, + "refs": { + } + }, "CreateEnvironmentAccountConnectionInput": { "base": null, "refs": { @@ -291,6 +362,16 @@ "refs": { } }, + "DeleteComponentInput": { + "base": null, + "refs": { + } + }, + "DeleteComponentOutput": { + "base": null, + "refs": { + } + }, "DeleteEnvironmentAccountConnectionInput": { "base": null, "refs": { @@ -390,6 +471,8 @@ "DeploymentStatus": { "base": null, "refs": { + "Component$deploymentStatus": "

The component deployment status.

", + "ComponentSummary$deploymentStatus": "

The component deployment status.

", "Environment$deploymentStatus": "

The environment deployment status.

", "EnvironmentSummary$deploymentStatus": "

The environment deployment status.

", "ServiceInstance$deploymentStatus": "

The service instance deployment status.

", @@ -401,13 +484,15 @@ "base": null, "refs": { "UpdateEnvironmentInput$deploymentType": "

There are four modes for updating an environment. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment-type.

MINOR_VERSION

In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

MAJOR_VERSION

In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).

", - "UpdateServiceInstanceInput$deploymentType": "

The deployment type.

There are four modes for updating a service instance. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment-type.

MINOR_VERSION

In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

MAJOR_VERSION

In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that's higher than the major version in use and a minor version.

", + "UpdateServiceInstanceInput$deploymentType": "

The deployment type. It defines the mode for updating a service instance, as follows:

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment type.

MINOR_VERSION

In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

MAJOR_VERSION

In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that's higher than the major version in use and a minor version.

", "UpdateServicePipelineInput$deploymentType": "

The deployment type.

There are four modes for updating a service pipeline. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment-type.

MINOR_VERSION

In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can specify a different minor version of the current major version in use.

MAJOR_VERSION

In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that's higher than the major version in use and a minor version.

" } }, "Description": { "base": null, "refs": { + "Component$description": "

A description of the component.

", + "CreateComponentInput$description": "

An optional customer-provided description of the component.

", "CreateEnvironmentInput$description": "

A description of the environment that's being created and deployed.

", "CreateEnvironmentTemplateInput$description": "

A description of the environment template.

", "CreateEnvironmentTemplateVersionInput$description": "

A description of the new version of an environment template.

", @@ -420,12 +505,13 @@ "EnvironmentTemplateSummary$description": "

A description of the environment template.

", "EnvironmentTemplateVersion$description": "

A description of the minor version of an environment template.

", "EnvironmentTemplateVersionSummary$description": "

A description of the version of an environment template.

", - "Service$description": "

A description of a service.

", + "Service$description": "

A description of the service.

", "ServiceSummary$description": "

A description of the service.

", "ServiceTemplate$description": "

A description of the service template.

", "ServiceTemplateSummary$description": "

A description of the service template.

", "ServiceTemplateVersion$description": "

A description of the version of a service template.

", "ServiceTemplateVersionSummary$description": "

A description of the version of a service template.

", + "UpdateComponentInput$description": "

An optional customer-provided description of the component.

", "UpdateEnvironmentInput$description": "

A description of the environment update.

", "UpdateEnvironmentTemplateInput$description": "

A description of the environment template update.

", "UpdateEnvironmentTemplateVersionInput$description": "

A description of environment template version to update.

", @@ -450,6 +536,10 @@ "EmptyNextToken": { "base": null, "refs": { + "ListComponentOutputsInput$nextToken": "

A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.

", + "ListComponentOutputsOutput$nextToken": "

A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.

", + "ListComponentProvisionedResourcesInput$nextToken": "

A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.

", + "ListComponentProvisionedResourcesOutput$nextToken": "

A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the current requested list of provisioned resources.

", "ListEnvironmentOutputsInput$nextToken": "

A token that indicates the location of the next environment output in the array of environment outputs, after the list of environment outputs that was previously requested.

", "ListEnvironmentOutputsOutput$nextToken": "

A token that indicates the location of the next environment output in the array of environment outputs, after the current requested list of environment outputs.

", "ListEnvironmentProvisionedResourcesInput$nextToken": "

A token that indicates the location of the next environment provisioned resource in the array of environment provisioned resources, after the list of environment provisioned resources that was previously requested.

", @@ -467,22 +557,22 @@ } }, "Environment": { - "base": "

The environment detail data. An Proton environment is a set resources shared across an Proton service.

", + "base": "

Detailed data of an Proton environment resource. An Proton environment is a set of resources shared across Proton services.

", "refs": { "CancelEnvironmentDeploymentOutput$environment": "

The environment summary data that's returned by Proton.

", "CreateEnvironmentOutput$environment": "

The environment detail data that's returned by Proton.

", - "DeleteEnvironmentOutput$environment": "

The environment detail data that's returned by Proton.

", - "GetEnvironmentOutput$environment": "

The environment detail data that's returned by Proton.

", + "DeleteEnvironmentOutput$environment": "

The detailed data of the environment being deleted.

", + "GetEnvironmentOutput$environment": "

The detailed data of the requested environment.

", "UpdateEnvironmentOutput$environment": "

The environment detail data that's returned by Proton.

" } }, "EnvironmentAccountConnection": { - "base": "

The environment account connection detail data.

", + "base": "

Detailed data of an Proton environment account connection resource.

", "refs": { "AcceptEnvironmentAccountConnectionOutput$environmentAccountConnection": "

The environment account connection data that's returned by Proton.

", "CreateEnvironmentAccountConnectionOutput$environmentAccountConnection": "

The environment account connection detail data that's returned by Proton.

", - "DeleteEnvironmentAccountConnectionOutput$environmentAccountConnection": "

The environment account connection detail data that's returned by Proton.

", - "GetEnvironmentAccountConnectionOutput$environmentAccountConnection": "

The environment account connection detail data that's returned by Proton.

", + "DeleteEnvironmentAccountConnectionOutput$environmentAccountConnection": "

The detailed data of the environment account connection being deleted.

", + "GetEnvironmentAccountConnectionOutput$environmentAccountConnection": "

The detailed data of the requested environment account connection.

", "RejectEnvironmentAccountConnectionOutput$environmentAccountConnection": "

The environment connection account detail data that's returned by Proton.

", "UpdateEnvironmentAccountConnectionOutput$environmentAccountConnection": "

The environment account connection detail data that's returned by Proton.

" } @@ -504,7 +594,7 @@ "EnvironmentAccountConnection$id": "

The ID of the environment account connection.

", "EnvironmentAccountConnectionSummary$id": "

The ID of the environment account connection.

", "EnvironmentSummary$environmentAccountConnectionId": "

The ID of the environment account connection that the environment is associated with.

", - "GetEnvironmentAccountConnectionInput$id": "

The ID of the environment account connection.

", + "GetEnvironmentAccountConnectionInput$id": "

The ID of the environment account connection that you want to get the detailed data for.

", "RejectEnvironmentAccountConnectionInput$id": "

The ID of the environment account connection to reject.

", "UpdateEnvironmentAccountConnectionInput$id": "

The ID of the environment account connection to update.

", "UpdateEnvironmentInput$environmentAccountConnectionId": "

The ID of the environment account connection.

You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.

" @@ -531,7 +621,7 @@ } }, "EnvironmentAccountConnectionSummary": { - "base": "

A summary of the environment account connection detail data.

", + "base": "

Summary data of an Proton environment account connection resource.

", "refs": { "EnvironmentAccountConnectionSummaryList$member": null } @@ -550,7 +640,7 @@ } }, "EnvironmentSummary": { - "base": "

A summary of the environment detail data.

", + "base": "

Summary data of an Proton environment resource. An Proton environment is a set of resources shared across Proton services.

", "refs": { "EnvironmentSummaryList$member": null } @@ -565,8 +655,8 @@ "base": "

The environment template data.

", "refs": { "CreateEnvironmentTemplateOutput$environmentTemplate": "

The environment template detail data that's returned by Proton.

", - "DeleteEnvironmentTemplateOutput$environmentTemplate": "

The environment template detail data that's returned by Proton.

", - "GetEnvironmentTemplateOutput$environmentTemplate": "

The environment template detail data that's returned by Proton.

", + "DeleteEnvironmentTemplateOutput$environmentTemplate": "

The detailed data of the environment template being deleted.

", + "GetEnvironmentTemplateOutput$environmentTemplate": "

The detailed data of the requested environment template.

", "UpdateEnvironmentTemplateOutput$environmentTemplate": "

The environment template detail data that's returned by Proton.

" } }, @@ -605,8 +695,8 @@ "base": "

The environment template version data.

", "refs": { "CreateEnvironmentTemplateVersionOutput$environmentTemplateVersion": "

The environment template detail data that's returned by Proton.

", - "DeleteEnvironmentTemplateVersionOutput$environmentTemplateVersion": "

The environment template version detail data that's returned by Proton.

", - "GetEnvironmentTemplateVersionOutput$environmentTemplateVersion": "

The environment template version detail data that's returned by Proton.

", + "DeleteEnvironmentTemplateVersionOutput$environmentTemplateVersion": "

The detailed data of the environment template version being deleted.

", + "GetEnvironmentTemplateVersionOutput$environmentTemplateVersion": "

The detailed data of the requested environment template version.

", "UpdateEnvironmentTemplateVersionOutput$environmentTemplateVersion": "

The environment template version detail data that's returned by Proton.

" } }, @@ -660,6 +750,16 @@ "refs": { } }, + "GetComponentInput": { + "base": null, + "refs": { + } + }, + "GetComponentOutput": { + "base": null, + "refs": { + } + }, "GetEnvironmentAccountConnectionInput": { "base": null, "refs": { @@ -800,6 +900,36 @@ "refs": { } }, + "ListComponentOutputsInput": { + "base": null, + "refs": { + } + }, + "ListComponentOutputsOutput": { + "base": null, + "refs": { + } + }, + "ListComponentProvisionedResourcesInput": { + "base": null, + "refs": { + } + }, + "ListComponentProvisionedResourcesOutput": { + "base": null, + "refs": { + } + }, + "ListComponentsInput": { + "base": null, + "refs": { + } + }, + "ListComponentsOutput": { + "base": null, + "refs": { + } + }, "ListEnvironmentAccountConnectionsInput": { "base": null, "refs": { @@ -973,6 +1103,7 @@ "MaxPageResults": { "base": null, "refs": { + "ListComponentsInput$maxResults": "

The maximum number of components to list.

", "ListEnvironmentAccountConnectionsInput$maxResults": "

The maximum number of environment account connections to list.

", "ListEnvironmentTemplateVersionsInput$maxResults": "

The maximum number of major or minor versions of an environment template to list.

", "ListEnvironmentTemplatesInput$maxResults": "

The maximum number of environment templates to list.

", @@ -988,6 +1119,8 @@ "NextToken": { "base": null, "refs": { + "ListComponentsInput$nextToken": "

A token that indicates the location of the next component in the array of components, after the list of components that was previously requested.

", + "ListComponentsOutput$nextToken": "

A token that indicates the location of the next component in the array of components, after the current requested list of components.

", "ListEnvironmentAccountConnectionsInput$nextToken": "

A token that indicates the location of the next environment account connection in the array of environment account connections, after the list of environment account connections that was previously requested.

", "ListEnvironmentAccountConnectionsOutput$nextToken": "

A token that indicates the location of the next environment account connection in the array of environment account connections, after the current requested list of environment account connections.

", "ListEnvironmentTemplateVersionsInput$nextToken": "

A token that indicates the location of the next major or minor version in the array of major or minor versions of an environment template, after the list of major or minor versions that was previously requested.

", @@ -1019,6 +1152,12 @@ "NotifyResourceDeploymentStatusChangeInput$outputs": "

The provisioned resource state change detail data that's returned by Proton.

" } }, + "NotifyResourceDeploymentStatusChangeInputStatusMessageString": { + "base": null, + "refs": { + "NotifyResourceDeploymentStatusChangeInput$statusMessage": "

The deployment status message for your provisioned resource.

" + } + }, "NotifyResourceDeploymentStatusChangeOutput": { "base": null, "refs": { @@ -1046,9 +1185,10 @@ "OutputsList": { "base": null, "refs": { + "ListComponentOutputsOutput$outputs": "

An array of component Infrastructure as Code (IaC) outputs.

", "ListEnvironmentOutputsOutput$outputs": "

An array of environment outputs with detail data.

", - "ListServiceInstanceOutputsOutput$outputs": "

An array of service instance infrastructure as code outputs.

", - "ListServicePipelineOutputsOutput$outputs": "

An array of outputs.

" + "ListServiceInstanceOutputsOutput$outputs": "

An array of service instance Infrastructure as Code (IaC) outputs.

", + "ListServicePipelineOutputsOutput$outputs": "

An array of service pipeline Infrastructure as Code (IaC) outputs.

" } }, "PipelineRoleArn": { @@ -1079,6 +1219,7 @@ "ProvisionedResourceList": { "base": null, "refs": { + "ListComponentProvisionedResourcesOutput$provisionedResources": "

An array of provisioned resources for a component.

", "ListEnvironmentProvisionedResourcesOutput$provisionedResources": "

An array of environment provisioned resources.

", "ListServiceInstanceProvisionedResourcesOutput$provisionedResources": "

An array of provisioned resources for a service instance.

", "ListServicePipelineProvisionedResourcesOutput$provisionedResources": "

An array of provisioned resources for a service and pipeline.

" @@ -1114,7 +1255,7 @@ } }, "Repository": { - "base": "

Detail date for a repository that has been registered with Proton.

", + "base": "

Detailed data of a repository that has been registered with Proton.

", "refs": { "CreateRepositoryOutput$repository": "

The repository detail data that's returned by Proton.

", "DeleteRepositoryOutput$repository": "

The repository detail data that's returned by Proton.

", @@ -1188,7 +1329,7 @@ } }, "RepositorySummary": { - "base": "

A summary of detail data for a registered repository.

", + "base": "

Summary data of a repository that has been registered with Proton.

", "refs": { "RepositorySummaryList$member": null } @@ -1244,12 +1385,25 @@ "ResourceName": { "base": null, "refs": { + "CancelComponentDeploymentInput$componentName": "

The name of the component with the deployment to cancel.

", "CancelEnvironmentDeploymentInput$environmentName": "

The name of the environment with the deployment to cancel.

", "CancelServiceInstanceDeploymentInput$serviceInstanceName": "

The name of the service instance with the deployment to cancel.

", "CancelServiceInstanceDeploymentInput$serviceName": "

The name of the service with the service instance deployment to cancel.

", "CancelServicePipelineDeploymentInput$serviceName": "

The name of the service with the service pipeline deployment to cancel.

", "CompatibleEnvironmentTemplate$templateName": "

The compatible environment template name.

", "CompatibleEnvironmentTemplateInput$templateName": "

The compatible environment template name.

", + "Component$environmentName": "

The name of the Proton environment that this component is associated with.

", + "Component$name": "

The name of the component.

", + "Component$serviceInstanceName": "

The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

", + "Component$serviceName": "

The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.

", + "ComponentSummary$environmentName": "

The name of the Proton environment that this component is associated with.

", + "ComponentSummary$name": "

The name of the component.

", + "ComponentSummary$serviceInstanceName": "

The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

", + "ComponentSummary$serviceName": "

The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.

", + "CreateComponentInput$environmentName": "

The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify serviceInstanceName and serviceName.

", + "CreateComponentInput$name": "

The customer-provided name of the component.

", + "CreateComponentInput$serviceInstanceName": "

The name of the service instance that you want to attach this component to. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.

", + "CreateComponentInput$serviceName": "

The name of the service that serviceInstanceName is associated with. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.

", "CreateEnvironmentAccountConnectionInput$environmentName": "

The name of the Proton environment that's created in the associated management account.

", "CreateEnvironmentInput$name": "

The name of the environment.

", "CreateEnvironmentInput$templateName": "

The name of the environment template. For more information, see Environment Templates in the Proton Administrator Guide.

", @@ -1260,6 +1414,7 @@ "CreateServiceTemplateInput$name": "

The name of the service template.

", "CreateServiceTemplateVersionInput$templateName": "

The name of the service template.

", "CreateTemplateSyncConfigInput$templateName": "

The name of your registered template.

", + "DeleteComponentInput$name": "

The name of the component to delete.

", "DeleteEnvironmentInput$name": "

The name of the environment to delete.

", "DeleteEnvironmentTemplateInput$name": "

The name of the environment template to delete.

", "DeleteEnvironmentTemplateVersionInput$templateName": "

The name of the environment template.

", @@ -1278,27 +1433,33 @@ "EnvironmentTemplateSummary$name": "

The name of the environment template.

", "EnvironmentTemplateVersion$templateName": "

The name of the version of an environment template.

", "EnvironmentTemplateVersionSummary$templateName": "

The name of the environment template.

", - "GetEnvironmentInput$name": "

The name of the environment that you want to get the detail data for.

", - "GetEnvironmentTemplateInput$name": "

The name of the environment template that you want to get the detail data for.

", - "GetEnvironmentTemplateVersionInput$templateName": "

The name of the environment template.

", - "GetServiceInput$name": "

The name of the service that you want to get the detail data for.

", - "GetServiceInstanceInput$name": "

The name of a service instance that you want to get the detail data for.

", + "GetComponentInput$name": "

The name of the component that you want to get the detailed data for.

", + "GetEnvironmentInput$name": "

The name of the environment that you want to get the detailed data for.

", + "GetEnvironmentTemplateInput$name": "

The name of the environment template that you want to get the detailed data for.

", + "GetEnvironmentTemplateVersionInput$templateName": "

The name of the environment template a version of which you want to get detailed data for..

", + "GetServiceInput$name": "

The name of the service that you want to get the detailed data for.

", + "GetServiceInstanceInput$name": "

The name of a service instance that you want to get the detailed data for.

", "GetServiceInstanceInput$serviceName": "

The name of the service that the service instance belongs to.

", - "GetServiceTemplateInput$name": "

The name of the service template that you want to get detail data for.

", - "GetServiceTemplateVersionInput$templateName": "

The name of the service template.

", + "GetServiceTemplateInput$name": "

The name of the service template that you want to get detailed data for.

", + "GetServiceTemplateVersionInput$templateName": "

The name of the service template a version of which you want to get detailed data for.

", "GetTemplateSyncConfigInput$templateName": "

The template name.

", "GetTemplateSyncStatusInput$templateName": "

The template name.

", + "ListComponentOutputsInput$componentName": "

The name of the component whose outputs you want.

", + "ListComponentProvisionedResourcesInput$componentName": "

The name of the component whose provisioned resources you want.

", + "ListComponentsInput$environmentName": "

The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.

", + "ListComponentsInput$serviceInstanceName": "

The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.

", + "ListComponentsInput$serviceName": "

The name of a service for result list filtering. Proton returns components attached to service instances of the service.

", "ListEnvironmentAccountConnectionsInput$environmentName": "

The environment name that's associated with each listed environment account connection.

", "ListEnvironmentOutputsInput$environmentName": "

The environment name.

", "ListEnvironmentProvisionedResourcesInput$environmentName": "

The environment name.

", "ListEnvironmentTemplateVersionsInput$templateName": "

The name of the environment template.

", - "ListServiceInstanceOutputsInput$serviceInstanceName": "

The service instance name.

", - "ListServiceInstanceOutputsInput$serviceName": "

The service name.

", - "ListServiceInstanceProvisionedResourcesInput$serviceInstanceName": "

The service instance name.

", - "ListServiceInstanceProvisionedResourcesInput$serviceName": "

The service name.

", + "ListServiceInstanceOutputsInput$serviceInstanceName": "

The name of the service instance whose outputs you want.

", + "ListServiceInstanceOutputsInput$serviceName": "

The name of the service that serviceInstanceName is associated to.

", + "ListServiceInstanceProvisionedResourcesInput$serviceInstanceName": "

The name of the service instance whose provisioned resources you want.

", + "ListServiceInstanceProvisionedResourcesInput$serviceName": "

The name of the service that serviceInstanceName is associated to.

", "ListServiceInstancesInput$serviceName": "

The name of the service that the service instance belongs to.

", - "ListServicePipelineOutputsInput$serviceName": "

The service name.

", - "ListServicePipelineProvisionedResourcesInput$serviceName": "

The service name.

", + "ListServicePipelineOutputsInput$serviceName": "

The name of the service whose pipeline's outputs you want.

", + "ListServicePipelineProvisionedResourcesInput$serviceName": "

The name of the service whose pipeline's provisioned resources you want.

", "ListServiceTemplateVersionsInput$templateName": "

The name of the service template.

", "Service$name": "

The name of the service.

", "Service$templateName": "

The name of the service template.

", @@ -1318,6 +1479,7 @@ "ServiceTemplateVersion$templateName": "

The name of the version of a service template.

", "ServiceTemplateVersionSummary$templateName": "

The name of the service template.

", "TemplateSyncConfig$templateName": "

The template name.

", + "UpdateComponentInput$name": "

The name of the component to update.

", "UpdateEnvironmentInput$name": "

The name of the environment to update.

", "UpdateEnvironmentTemplateInput$name": "

The name of the environment template to update.

", "UpdateEnvironmentTemplateVersionInput$templateName": "

The name of the environment template.

", @@ -1330,6 +1492,13 @@ "UpdateTemplateSyncConfigInput$templateName": "

The synced template name.

" } }, + "ResourceNameOrEmpty": { + "base": null, + "refs": { + "UpdateComponentInput$serviceInstanceName": "

The name of the service instance that you want to attach this component to. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

", + "UpdateComponentInput$serviceName": "

The name of the service that serviceInstanceName is associated with. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

" + } + }, "ResourceNotFoundException": { "base": "

The requested resource wasn't found.

", "refs": { @@ -1393,11 +1562,11 @@ } }, "Service": { - "base": "

The service detail data.

", + "base": "

Detailed data of an Proton service resource.

", "refs": { "CreateServiceOutput$service": "

The service detail data that's returned by Proton.

", - "DeleteServiceOutput$service": "

The service detail data that's returned by Proton.

", - "GetServiceOutput$service": "

The service detail data that's returned by Proton.

", + "DeleteServiceOutput$service": "

The detailed data of the service being deleted.

", + "GetServiceOutput$service": "

The detailed data of the requested service.

", "UpdateServiceOutput$service": "

The service detail data that's returned by Proton.

" } }, @@ -1409,10 +1578,10 @@ } }, "ServiceInstance": { - "base": "

The service instance detail data.

", + "base": "

Detailed data of an Proton service instance resource.

", "refs": { "CancelServiceInstanceDeploymentOutput$serviceInstance": "

The service instance summary data that's returned by Proton.

", - "GetServiceInstanceOutput$serviceInstance": "

The service instance detail data that's returned by Proton.

", + "GetServiceInstanceOutput$serviceInstance": "

The detailed data of the requested service instance.

", "UpdateServiceInstanceOutput$serviceInstance": "

The service instance summary data that's returned by Proton.

" } }, @@ -1424,7 +1593,7 @@ } }, "ServiceInstanceSummary": { - "base": "

A summary of the service instance detail data.

", + "base": "

Summary data of an Proton service instance resource.

", "refs": { "ServiceInstanceSummaryList$member": null } @@ -1432,11 +1601,11 @@ "ServiceInstanceSummaryList": { "base": null, "refs": { - "ListServiceInstancesOutput$serviceInstances": "

An array of service instances with summaries of detail data.

" + "ListServiceInstancesOutput$serviceInstances": "

An array of service instances with summary data.

" } }, "ServicePipeline": { - "base": "

The service pipeline detail data.

", + "base": "

Detailed data of an Proton service instance pipeline resource.

", "refs": { "CancelServicePipelineDeploymentOutput$pipeline": "

The service pipeline detail data that's returned by Proton.

", "Service$pipeline": "

The service pipeline detail data.

", @@ -1456,7 +1625,7 @@ } }, "ServiceSummary": { - "base": "

A summary of the service detail data.

", + "base": "

Summary data of an Proton service resource.

", "refs": { "ServiceSummaryList$member": null } @@ -1468,11 +1637,11 @@ } }, "ServiceTemplate": { - "base": "

The service template detail data.

", + "base": "

Detailed data of an Proton service template resource.

", "refs": { "CreateServiceTemplateOutput$serviceTemplate": "

The service template detail data that's returned by Proton.

", - "DeleteServiceTemplateOutput$serviceTemplate": "

The service template detail data that's returned by Proton.

", - "GetServiceTemplateOutput$serviceTemplate": "

The service template detail data that's returned by Proton.

", + "DeleteServiceTemplateOutput$serviceTemplate": "

The detailed data of the service template being deleted.

", + "GetServiceTemplateOutput$serviceTemplate": "

The detailed data of the requested service template.

", "UpdateServiceTemplateOutput$serviceTemplate": "

The service template detail data that's returned by Proton.

" } }, @@ -1484,7 +1653,7 @@ } }, "ServiceTemplateSummary": { - "base": "

The service template summary data.

", + "base": "

Summary data of an Proton service template resource.

", "refs": { "ServiceTemplateSummaryList$member": null } @@ -1495,12 +1664,26 @@ "ListServiceTemplatesOutput$templates": "

An array of service templates with detail data.

" } }, + "ServiceTemplateSupportedComponentSourceInputList": { + "base": null, + "refs": { + "CreateServiceTemplateVersionInput$supportedComponentSources": "

An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.

For more information about components, see Proton components in the Proton Administrator Guide.

", + "ServiceTemplateVersion$supportedComponentSources": "

An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.

For more information about components, see Proton components in the Proton Administrator Guide.

", + "UpdateServiceTemplateVersionInput$supportedComponentSources": "

An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.

A change to supportedComponentSources doesn't impact existing component attachments to instances based on this template version. A change only affects later associations.

For more information about components, see Proton components in the Proton Administrator Guide.

" + } + }, + "ServiceTemplateSupportedComponentSourceType": { + "base": null, + "refs": { + "ServiceTemplateSupportedComponentSourceInputList$member": null + } + }, "ServiceTemplateVersion": { - "base": "

The version of a service template detail data.

", + "base": "

Detailed data of an Proton service template version resource.

", "refs": { "CreateServiceTemplateVersionOutput$serviceTemplateVersion": "

The service template version summary of detail data that's returned by Proton.

", - "DeleteServiceTemplateVersionOutput$serviceTemplateVersion": "

The service template version detail data that's returned by Proton.

", - "GetServiceTemplateVersionOutput$serviceTemplateVersion": "

The service template version detail data that's returned by Proton.

", + "DeleteServiceTemplateVersionOutput$serviceTemplateVersion": "

The detailed data of the service template version being deleted.

", + "GetServiceTemplateVersionOutput$serviceTemplateVersion": "

The detailed data of the requested service template version.

", "UpdateServiceTemplateVersionOutput$serviceTemplateVersion": "

The service template version detail data that's returned by Proton.

" } }, @@ -1512,7 +1695,7 @@ } }, "ServiceTemplateVersionSummary": { - "base": "

A summary of the service template version detail data.

", + "base": "

Summary data of an Proton service template version resource.

", "refs": { "ServiceTemplateVersionSummaryList$member": null } @@ -1526,12 +1709,15 @@ "SpecContents": { "base": null, "refs": { + "Component$serviceSpec": "

The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.

", + "CreateComponentInput$serviceSpec": "

The service spec that you want the component to use to access service inputs. Set this only when you attach the component to a service instance.

", "CreateEnvironmentInput$spec": "

A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton Administrator Guide.

", "CreateServiceInput$spec": "

A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. Don’t include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For more information, see Create a service in the Proton Administrator Guide and Create a service in the Proton User Guide.

", "Environment$spec": "

The environment spec.

", "Service$spec": "

The formatted specification that defines the service.

", "ServiceInstance$spec": "

The service spec that was used to create the service instance.

", "ServicePipeline$spec": "

The service spec that was used to create the service pipeline.

", + "UpdateComponentInput$serviceSpec": "

The service spec that you want the component to use to access service inputs. Set this only when the component is attached to a service instance.

", "UpdateEnvironmentInput$spec": "

The formatted specification that defines the update.

", "UpdateServiceInput$spec": "

Lists the service instances to add and the existing service instances to remain. Omit the existing service instances to delete from the list. Don't include edits to the existing service instances or pipeline. For more information, see Edit a service in the Proton Administrator Guide or the Proton User Guide.

", "UpdateServiceInstanceInput$spec": "

The formatted specification that defines the service instance update.

", @@ -1541,12 +1727,14 @@ "StatusMessage": { "base": null, "refs": { + "Component$deploymentStatusMessage": "

The message associated with the component deployment status.

", + "ComponentSummary$deploymentStatusMessage": "

The message associated with the component deployment status.

", "Environment$deploymentStatusMessage": "

An environment deployment status message.

", "EnvironmentSummary$deploymentStatusMessage": "

An environment deployment status message.

", "EnvironmentTemplateVersion$statusMessage": "

The status message of the version of an environment template.

", "EnvironmentTemplateVersionSummary$statusMessage": "

The status message of the version of an environment template.

", "Service$statusMessage": "

A service status message.

", - "ServiceInstance$deploymentStatusMessage": "

A service instance deployment status message.

", + "ServiceInstance$deploymentStatusMessage": "

The message associated with the service instance deployment status.

", "ServiceInstanceSummary$deploymentStatusMessage": "

A service instance deployment status message.

", "ServicePipeline$deploymentStatusMessage": "

A service pipeline deployment status message.

", "ServiceSummary$statusMessage": "

A service status message.

", @@ -1587,12 +1775,6 @@ "ListRepositorySyncDefinitionsInput$syncType": "

The sync type. The only supported value is TEMPLATE_SYNC.

" } }, - "SyntheticNotifyResourceDeploymentStatusChangeInputString": { - "base": null, - "refs": { - "NotifyResourceDeploymentStatusChangeInput$statusMessage": "

The deployment status message for your provisioned resource.

" - } - }, "Tag": { "base": "

A description of a resource tag.

", "refs": { @@ -1615,6 +1797,7 @@ "TagList": { "base": null, "refs": { + "CreateComponentInput$tags": "

An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.

For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.

", "CreateEnvironmentAccountConnectionInput$tags": "

An optional list of metadata items that you can associate with the Proton environment account connection. A tag is a key-value pair.

For more information, see Proton resources and tagging in the Proton Administrator Guide.

", "CreateEnvironmentInput$tags": "

An optional list of metadata items that you can associate with the Proton environment. A tag is a key-value pair.

For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.

", "CreateEnvironmentTemplateInput$tags": "

An optional list of metadata items that you can associate with the Proton environment template. A tag is a key-value pair.

For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.

", @@ -1643,6 +1826,19 @@ "Tag$value": "

The value of the resource tag.

" } }, + "TemplateFileContents": { + "base": null, + "refs": { + "CreateComponentInput$templateFile": "

A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

Components support a single IaC file, even if you use Terraform as your template language.

", + "UpdateComponentInput$templateFile": "

A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

Components support a single IaC file, even if you use Terraform as your template language.

" + } + }, + "TemplateManifestContents": { + "base": null, + "refs": { + "CreateComponentInput$manifest": "

A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.

" + } + }, "TemplateSchema": { "base": null, "refs": { @@ -1696,10 +1892,10 @@ "EnvironmentTemplateVersionSummary$majorVersion": "

The latest major version that's associated with the version of an environment template.

", "EnvironmentTemplateVersionSummary$minorVersion": "

The version of an environment template.

", "EnvironmentTemplateVersionSummary$recommendedMinorVersion": "

The recommended minor version of the environment template.

", - "GetEnvironmentTemplateVersionInput$majorVersion": "

To view environment template major version detail data, include major Version.

", - "GetEnvironmentTemplateVersionInput$minorVersion": "

To view environment template minor version detail data, include minorVersion.

", - "GetServiceTemplateVersionInput$majorVersion": "

To view service template major version detail data, include major Version.

", - "GetServiceTemplateVersionInput$minorVersion": "

To view service template minor version detail data, include minorVersion.

", + "GetEnvironmentTemplateVersionInput$majorVersion": "

To get environment template major version detail data, include major Version.

", + "GetEnvironmentTemplateVersionInput$minorVersion": "

To get environment template minor version detail data, include minorVersion.

", + "GetServiceTemplateVersionInput$majorVersion": "

To get service template major version detail data, include major Version.

", + "GetServiceTemplateVersionInput$minorVersion": "

To get service template minor version detail data, include minorVersion.

", "GetTemplateSyncStatusInput$templateVersion": "

The template major version.

", "ListEnvironmentTemplateVersionsInput$majorVersion": "

To view a list of minor of versions under a major version of an environment template, include major Version.

To view a list of major versions of an environment template, exclude major Version.

", "ListServiceTemplateVersionsInput$majorVersion": "

To view a list of minor of versions under a major version of a service template, include major Version.

To view a list of major versions of a service template, exclude major Version.

", @@ -1753,6 +1949,14 @@ "Timestamp": { "base": null, "refs": { + "Component$createdAt": "

The time when the component was created.

", + "Component$lastDeploymentAttemptedAt": "

The time when a deployment of the component was last attempted.

", + "Component$lastDeploymentSucceededAt": "

The time when the component was last deployed successfully.

", + "Component$lastModifiedAt": "

The time when the component was last modified.

", + "ComponentSummary$createdAt": "

The time when the component was created.

", + "ComponentSummary$lastDeploymentAttemptedAt": "

The time when a deployment of the component was last attempted.

", + "ComponentSummary$lastDeploymentSucceededAt": "

The time when the component was last deployed successfully.

", + "ComponentSummary$lastModifiedAt": "

The time when the component was last modified.

", "Environment$createdAt": "

The time when the environment was created.

", "Environment$lastDeploymentAttemptedAt": "

The time when a deployment of the environment was last attempted.

", "Environment$lastDeploymentSucceededAt": "

The time when the environment was last deployed successfully.

", @@ -1818,6 +2022,16 @@ "refs": { } }, + "UpdateComponentInput": { + "base": null, + "refs": { + } + }, + "UpdateComponentOutput": { + "base": null, + "refs": { + } + }, "UpdateEnvironmentAccountConnectionInput": { "base": null, "refs": { diff --git a/apis/proton/2020-07-20/paginators-1.json b/apis/proton/2020-07-20/paginators-1.json index 9c1f3579042..457a6a8bd4d 100644 --- a/apis/proton/2020-07-20/paginators-1.json +++ b/apis/proton/2020-07-20/paginators-1.json @@ -1,5 +1,21 @@ { "pagination": { + "ListComponentOutputs": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "outputs" + }, + "ListComponentProvisionedResources": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "provisionedResources" + }, + "ListComponents": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "components" + }, "ListEnvironmentAccountConnections": { "input_token": "nextToken", "output_token": "nextToken", diff --git a/apis/proton/2020-07-20/waiters-2.json b/apis/proton/2020-07-20/waiters-2.json index babd5af180b..f99a6fe345b 100644 --- a/apis/proton/2020-07-20/waiters-2.json +++ b/apis/proton/2020-07-20/waiters-2.json @@ -1,6 +1,39 @@ { "version" : 2, "waiters" : { + "ComponentDeleted" : { + "description" : "Wait until a Component is deleted. Use this after invoking DeleteComponent", + "delay" : 5, + "maxAttempts" : 999, + "operation" : "GetComponent", + "acceptors" : [ { + "matcher" : "error", + "state" : "success", + "expected" : "ResourceNotFoundException" + }, { + "matcher" : "path", + "argument" : "component.deploymentStatus", + "state" : "failure", + "expected" : "DELETE_FAILED" + } ] + }, + "ComponentDeployed" : { + "description" : "Wait until a Component is deployed. Use this after invoking CreateComponent or UpdateComponent", + "delay" : 5, + "maxAttempts" : 999, + "operation" : "GetComponent", + "acceptors" : [ { + "matcher" : "path", + "argument" : "component.deploymentStatus", + "state" : "success", + "expected" : "SUCCEEDED" + }, { + "matcher" : "path", + "argument" : "component.deploymentStatus", + "state" : "failure", + "expected" : "FAILED" + } ] + }, "EnvironmentDeployed" : { "description" : "Wait until an Environment is deployed. Use this after invoking CreateEnvironment or UpdateEnvironment", "delay" : 5, diff --git a/apis/voice-id/2021-09-27/api-2.json b/apis/voice-id/2021-09-27/api-2.json index d566d6de832..6c40cb77228 100644 --- a/apis/voice-id/2021-09-27/api-2.json +++ b/apis/voice-id/2021-09-27/api-2.json @@ -58,6 +58,7 @@ "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, + {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} @@ -170,6 +171,7 @@ "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, + {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} @@ -434,7 +436,8 @@ "ENROLLMENT_ALREADY_EXISTS", "SPEAKER_NOT_SET", "SPEAKER_OPTED_OUT", - "CONCURRENT_CHANGES" + "CONCURRENT_CHANGES", + "DOMAIN_LOCKED_FROM_ENCRYPTION_UPDATES" ] }, "CreateDomainRequest":{ @@ -594,6 +597,7 @@ "DomainStatus":{"shape":"DomainStatus"}, "Name":{"shape":"DomainName"}, "ServerSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, + "ServerSideEncryptionUpdateDetails":{"shape":"ServerSideEncryptionUpdateDetails"}, "UpdatedAt":{"shape":"Timestamp"} } }, @@ -632,6 +636,7 @@ "DomainStatus":{"shape":"DomainStatus"}, "Name":{"shape":"DomainName"}, "ServerSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, + "ServerSideEncryptionUpdateDetails":{"shape":"ServerSideEncryptionUpdateDetails"}, "UpdatedAt":{"shape":"Timestamp"} } }, @@ -1036,6 +1041,22 @@ "KmsKeyId":{"shape":"KmsKeyId"} } }, + "ServerSideEncryptionUpdateDetails":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "OldKmsKeyId":{"shape":"KmsKeyId"}, + "UpdateStatus":{"shape":"ServerSideEncryptionUpdateStatus"} + } + }, + "ServerSideEncryptionUpdateStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] + }, "ServiceQuotaExceededException":{ "type":"structure", "members":{ diff --git a/apis/voice-id/2021-09-27/docs-2.json b/apis/voice-id/2021-09-27/docs-2.json index 83e0f0a1645..b160003bd77 100644 --- a/apis/voice-id/2021-09-27/docs-2.json +++ b/apis/voice-id/2021-09-27/docs-2.json @@ -3,9 +3,9 @@ "service": "

Amazon Connect Voice ID provides real-time caller authentication and fraud screening. This guide describes the APIs used for this service.

", "operations": { "CreateDomain": "

Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.

", - "DeleteDomain": "

Deletes the specified domain from the Amazon Connect Voice ID system.

", - "DeleteFraudster": "

Deletes the specified fraudster from the Amazon Connect Voice ID system.

", - "DeleteSpeaker": "

Deletes the specified speaker from the Amazon Connect Voice ID system.

", + "DeleteDomain": "

Deletes the specified domain from Voice ID.

", + "DeleteFraudster": "

Deletes the specified fraudster from Voice ID.

", + "DeleteSpeaker": "

Deletes the specified speaker from Voice ID.

", "DescribeDomain": "

Describes the specified domain.

", "DescribeFraudster": "

Describes the specified fraudster.

", "DescribeFraudsterRegistrationJob": "

Describes the specified fraudster registration job.

", @@ -17,10 +17,10 @@ "ListSpeakerEnrollmentJobs": "

Lists all the speaker enrollment jobs in the domain with the specified JobStatus. If JobStatus is not provided, this lists all jobs with all possible speaker enrollment job statuses.

", "ListSpeakers": "

Lists all speakers in a specified domain.

", "ListTagsForResource": "

Lists all tags associated with a specified Voice ID resource.

", - "OptOutSpeaker": "

Opts out a speaker from Voice ID system. A speaker can be opted out regardless of whether or not they already exist in the system. If they don't yet exist, a new speaker is created in an opted out state. If they already exist, their existing status is overridden and they are opted out. Enrollment and evaluation authentication requests are rejected for opted out speakers, and opted out speakers have no voice embeddings stored in the system.

", + "OptOutSpeaker": "

Opts out a speaker from Voice ID. A speaker can be opted out regardless of whether or not they already exist in Voice ID. If they don't yet exist, a new speaker is created in an opted out state. If they already exist, their existing status is overridden and they are opted out. Enrollment and evaluation authentication requests are rejected for opted out speakers, and opted out speakers have no voice embeddings stored in Voice ID.

", "StartFraudsterRegistrationJob": "

Starts a new batch fraudster registration job using provided details.

", "StartSpeakerEnrollmentJob": "

Starts a new batch speaker enrollment job using specified details.

", - "TagResource": "

Tags an Amazon Connect Voice ID resource with the provided list of tags.

", + "TagResource": "

Tags a Voice ID resource with the provided list of tags.

", "UntagResource": "

Removes specified tags from a specified Amazon Connect Voice ID resource.

", "UpdateDomain": "

Updates the specified domain. This API has clobber behavior, and clears and replaces all attributes. If an optional field, such as 'Description' is not provided, it is removed from the domain.

" }, @@ -251,7 +251,7 @@ "base": "

Contains configurations defining enrollment behavior for the batch job.

", "refs": { "SpeakerEnrollmentJob$EnrollmentConfig": "

The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the FraudDetectionConfig to use.

", - "StartSpeakerEnrollmentJobRequest$EnrollmentConfig": "

The enrollment config that contains details such as the action to take when a speaker is already enrolled in the Voice ID system or when a speaker is identified as a fraudster.

" + "StartSpeakerEnrollmentJobRequest$EnrollmentConfig": "

The enrollment config that contains details such as the action to take when a speaker is already enrolled in Voice ID or when a speaker is identified as a fraudster.

" } }, "EnrollmentJobFraudDetectionConfig": { @@ -425,7 +425,7 @@ "JobName": { "base": null, "refs": { - "FraudsterRegistrationJob$JobName": "

The client-provied name for the fraudster registration job.

", + "FraudsterRegistrationJob$JobName": "

The client-provided name for the fraudster registration job.

", "FraudsterRegistrationJobSummary$JobName": "

The client-provied name for the fraudster registration job.

", "SpeakerEnrollmentJob$JobName": "

The client-provided name for the speaker enrollment job.

", "SpeakerEnrollmentJobSummary$JobName": "

The client-provided name for the speaker enrollment job.

", @@ -446,7 +446,8 @@ "base": null, "refs": { "OutputDataConfig$KmsKeyId": "

the identifier of the KMS key you want Voice ID to use to encrypt the output file of the fraudster registration job.

", - "ServerSideEncryptionConfiguration$KmsKeyId": "

The identifier of the KMS Key you want Voice ID to use to encrypt your data.

" + "ServerSideEncryptionConfiguration$KmsKeyId": "

The identifier of the KMS key you want Voice ID to use to encrypt your data.

", + "ServerSideEncryptionUpdateDetails$OldKmsKeyId": "

The previous KMS key ID the domain was encrypted with, before ServerSideEncryptionConfiguration was updated to a new KMS key ID.

" } }, "KnownFraudsterRisk": { @@ -541,14 +542,14 @@ "OutputDataConfig": { "base": "

The configuration containing output file information for a batch job.

", "refs": { - "FraudsterRegistrationJob$OutputDataConfig": "

The output data config containing the S3 location where you want Voice ID to write your job output file; you must also include a KMS Key ID in order to encrypt the file.

", - "SpeakerEnrollmentJob$OutputDataConfig": "

The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS Key ID to encrypt the file.

", - "StartFraudsterRegistrationJobRequest$OutputDataConfig": "

The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS Key ID to encrypt the file.

", - "StartSpeakerEnrollmentJobRequest$OutputDataConfig": "

The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS Key ID to encrypt the file.

" + "FraudsterRegistrationJob$OutputDataConfig": "

The output data config containing the S3 location where you want Voice ID to write your job output file; you must also include a KMS key iD in order to encrypt the file.

", + "SpeakerEnrollmentJob$OutputDataConfig": "

The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS key ID to encrypt the file.

", + "StartFraudsterRegistrationJobRequest$OutputDataConfig": "

The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS key ID to encrypt the file.

", + "StartSpeakerEnrollmentJobRequest$OutputDataConfig": "

The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS key ID to encrypt the file.

" } }, "RegistrationConfig": { - "base": "

The configuration definining the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster during a batch fraudster registration job.

", + "base": "

The configuration defining the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster during a batch fraudster registration job.

", "refs": { "FraudsterRegistrationJob$RegistrationConfig": "

The registration config containing details such as the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster.

", "StartFraudsterRegistrationJobRequest$RegistrationConfig": "

The registration config containing details such as the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster.

" @@ -569,7 +570,7 @@ "base": null, "refs": { "InputDataConfig$S3Uri": "

The S3 location for the input manifest file that contains the list of individual enrollment or registration job requests.

", - "OutputDataConfig$S3Uri": "

The S3 path of the folder to which Voice ID writes the job output file, which has a *.out extension. For example, if the input file name is input-file.json and the output folder path is s3://output-bucket/output-folder, the full output file path is s3://output-bucket/output-folder/job-Id/input-file.json.out.

" + "OutputDataConfig$S3Uri": "

The S3 path of the folder where Voice ID writes the job output file. It has a *.out extension. For example, if the input file name is input-file.json and the output folder path is s3://output-bucket/output-folder, the full output file path is s3://output-bucket/output-folder/job-Id/input-file.json.out.

" } }, "Score": { @@ -585,12 +586,25 @@ } }, "ServerSideEncryptionConfiguration": { - "base": "

The configuration containing information about the customer-managed KMS Key used for encrypting customer data.

", + "base": "

The configuration containing information about the customer managed key used for encrypting customer data.

", "refs": { - "CreateDomainRequest$ServerSideEncryptionConfiguration": "

The configuration, containing the KMS Key Identifier, to be used by Voice ID for the server-side encryption of your data. Refer to Amazon Connect VoiceID encryption at rest for more details on how the KMS Key is used.

", - "Domain$ServerSideEncryptionConfiguration": "

The server-side encryption configuration containing the KMS Key Identifier you want Voice ID to use to encrypt your data.

", - "DomainSummary$ServerSideEncryptionConfiguration": "

The server-side encryption configuration containing the KMS Key Identifier you want Voice ID to use to encrypt your data..

", - "UpdateDomainRequest$ServerSideEncryptionConfiguration": "

The configuration, containing the KMS Key Identifier, to be used by Voice ID for the server-side encryption of your data. Note that all the existing data in the domain are still encrypted using the existing key, only the data added to domain after updating the key is encrypted using the new key.

" + "CreateDomainRequest$ServerSideEncryptionConfiguration": "

The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Refer to Amazon Connect Voice ID encryption at rest for more details on how the KMS key is used.

", + "Domain$ServerSideEncryptionConfiguration": "

The server-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data.

", + "DomainSummary$ServerSideEncryptionConfiguration": "

The server-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data.

", + "UpdateDomainRequest$ServerSideEncryptionConfiguration": "

The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Note that all the existing data in the domain are still encrypted using the existing key, only the data added to domain after updating the key is encrypted using the new key.

" + } + }, + "ServerSideEncryptionUpdateDetails": { + "base": "

Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain’s data can only be accessed using the new KMS key.

", + "refs": { + "Domain$ServerSideEncryptionUpdateDetails": "

Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain's data can only be accessed using the new KMS key.

", + "DomainSummary$ServerSideEncryptionUpdateDetails": "

Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain’s data can only be accessed using the new KMS key.

" + } + }, + "ServerSideEncryptionUpdateStatus": { + "base": null, + "refs": { + "ServerSideEncryptionUpdateDetails$UpdateStatus": "

Status of the server-side encryption update. During an update, if there is an issue with the domain's current or old KMS key ID, such as an inaccessible or disabled key, then the status is FAILED. In order to resolve this, the key needs to be made accessible, and then an UpdateDomain call with the existing server-side encryption configuration will re-attempt this update process.

" } }, "ServiceQuotaExceededException": { @@ -700,7 +714,7 @@ "StreamingStatus": { "base": null, "refs": { - "EvaluateSessionResponse$StreamingStatus": "

The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH. In this situation, if the StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can mean that the client should call the API again later, once Voice ID has enough audio to produce a result. If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.

" + "EvaluateSessionResponse$StreamingStatus": "

The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH. In this situation, if the StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can mean that the client should call the API again later, after Voice ID has enough audio to produce a result. If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.

" } }, "String": { @@ -715,6 +729,7 @@ "ListSpeakerEnrollmentJobsResponse$NextToken": "

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

", "ListSpeakersResponse$NextToken": "

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

", "ResourceNotFoundException$Message": null, + "ServerSideEncryptionUpdateDetails$Message": "

Message explaining the current UpdateStatus. When the UpdateStatus is FAILED, this message explains the cause of the failure.

", "ServiceQuotaExceededException$Message": null, "ThrottlingException$Message": null, "ValidationException$Message": null diff --git a/gems/aws-sdk-applicationinsights/CHANGELOG.md b/gems/aws-sdk-applicationinsights/CHANGELOG.md index b850b0276b1..a1c4335f0ce 100644 --- a/gems/aws-sdk-applicationinsights/CHANGELOG.md +++ b/gems/aws-sdk-applicationinsights/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.31.0 (2022-06-02) +------------------ + +* Feature - Provide Account Level onboarding support through CFN/CLI + 1.30.0 (2022-02-24) ------------------ diff --git a/gems/aws-sdk-applicationinsights/VERSION b/gems/aws-sdk-applicationinsights/VERSION index 034552a83ee..34aae156b19 100644 --- a/gems/aws-sdk-applicationinsights/VERSION +++ b/gems/aws-sdk-applicationinsights/VERSION @@ -1 +1 @@ -1.30.0 +1.31.0 diff --git a/gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights.rb b/gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights.rb index a0cef5b3e8b..5f4ec764d4b 100644 --- a/gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights.rb +++ b/gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights.rb @@ -48,6 +48,6 @@ # @!group service module Aws::ApplicationInsights - GEM_VERSION = '1.30.0' + GEM_VERSION = '1.31.0' end diff --git a/gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb b/gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb index 626e58f87c1..500a574d6f3 100644 --- a/gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb +++ b/gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb @@ -386,8 +386,17 @@ def initialize(*args) # characters. The maximum length of a tag value is 256 characters. # # @option params [Boolean] :auto_config_enabled + # Indicates whether Application Insights automatically configures + # unmonitored resources in the resource group. # # @option params [Boolean] :auto_create + # Configures all of the resources in the resource group by applying the + # recommended configurations. + # + # @option params [String] :grouping_type + # Application Insights can create applications based on a resource group + # or on an account. To create an account-based application using all of + # the resources in the account, set this parameter to `ACCOUNT_BASED`. # # @return [Types::CreateApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -408,6 +417,7 @@ def initialize(*args) # ], # auto_config_enabled: false, # auto_create: false, + # grouping_type: "ACCOUNT_BASED", # accepts ACCOUNT_BASED # }) # # @example Response structure @@ -726,9 +736,7 @@ def describe_component_configuration(params = {}, options = {}) # The name of the component. # # @option params [required, String] :tier - # The tier of the application component. Supported tiers include - # `DOT_NET_CORE`, `DOT_NET_WORKER`, `DOT_NET_WEB`, `SQL_SERVER`, and - # `DEFAULT`. + # The tier of the application component. # # @return [Types::DescribeComponentConfigurationRecommendationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -892,7 +900,7 @@ def describe_observation(params = {}, options = {}) # resp.problem.affected_resource #=> String # resp.problem.start_time #=> Time # resp.problem.end_time #=> Time - # resp.problem.severity_level #=> String, one of "Low", "Medium", "High" + # resp.problem.severity_level #=> String, one of "Informative", "Low", "Medium", "High" # resp.problem.resource_group_name #=> String # resp.problem.feedback #=> Hash # resp.problem.feedback["FeedbackKey"] #=> String, one of "NOT_SPECIFIED", "USEFUL", "NOT_USEFUL" @@ -1279,6 +1287,7 @@ def list_log_patterns(params = {}, options = {}) # The token to request the next page of results. # # @option params [String] :component_name + # The name of the component. # # @return [Types::ListProblemsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -1309,7 +1318,7 @@ def list_log_patterns(params = {}, options = {}) # resp.problem_list[0].affected_resource #=> String # resp.problem_list[0].start_time #=> Time # resp.problem_list[0].end_time #=> Time - # resp.problem_list[0].severity_level #=> String, one of "Low", "Medium", "High" + # resp.problem_list[0].severity_level #=> String, one of "Informative", "Low", "Medium", "High" # resp.problem_list[0].resource_group_name #=> String # resp.problem_list[0].feedback #=> Hash # resp.problem_list[0].feedback["FeedbackKey"] #=> String, one of "NOT_SPECIFIED", "USEFUL", "NOT_USEFUL" @@ -1465,6 +1474,7 @@ def untag_resource(params = {}, options = {}) # problems. # # @option params [Boolean] :auto_config_enabled + # Turns auto-configuration on or off. # # @return [Types::UpdateApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -1551,9 +1561,7 @@ def update_component(params = {}, options = {}) # Indicates whether the application component is monitored. # # @option params [String] :tier - # The tier of the application component. Supported tiers include - # `DOT_NET_WORKER`, `DOT_NET_WEB`, `DOT_NET_CORE`, `SQL_SERVER`, and - # `DEFAULT`. + # The tier of the application component. # # @option params [String] :component_configuration # The configuration settings of the component. The value is the escaped @@ -1569,6 +1577,8 @@ def update_component(params = {}, options = {}) # [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/component-config.html # # @option params [Boolean] :auto_config_enabled + # Automatically configures the component by applying the recommended + # configurations. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @@ -1665,7 +1675,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-applicationinsights' - context[:gem_version] = '1.30.0' + context[:gem_version] = '1.31.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client_api.rb b/gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client_api.rb index 1970c5ab7d1..9392a42cc60 100644 --- a/gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client_api.rb +++ b/gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client_api.rb @@ -84,6 +84,7 @@ module ClientApi Feedback = Shapes::MapShape.new(name: 'Feedback') FeedbackKey = Shapes::StringShape.new(name: 'FeedbackKey') FeedbackValue = Shapes::StringShape.new(name: 'FeedbackValue') + GroupingType = Shapes::StringShape.new(name: 'GroupingType') HealthEventArn = Shapes::StringShape.new(name: 'HealthEventArn') HealthEventDescription = Shapes::StringShape.new(name: 'HealthEventDescription') HealthEventTypeCategory = Shapes::StringShape.new(name: 'HealthEventTypeCategory') @@ -235,6 +236,7 @@ module ClientApi CreateApplicationRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags")) CreateApplicationRequest.add_member(:auto_config_enabled, Shapes::ShapeRef.new(shape: AutoConfigEnabled, location_name: "AutoConfigEnabled")) CreateApplicationRequest.add_member(:auto_create, Shapes::ShapeRef.new(shape: AutoCreate, location_name: "AutoCreate")) + CreateApplicationRequest.add_member(:grouping_type, Shapes::ShapeRef.new(shape: GroupingType, location_name: "GroupingType")) CreateApplicationRequest.struct_class = Types::CreateApplicationRequest CreateApplicationResponse.add_member(:application_info, Shapes::ShapeRef.new(shape: ApplicationInfo, location_name: "ApplicationInfo")) diff --git a/gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/types.rb b/gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/types.rb index 106e52aac24..debca85aa5a 100644 --- a/gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/types.rb +++ b/gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/types.rb @@ -107,9 +107,12 @@ class ApplicationComponent < Struct.new( # @return [String] # # @!attribute [rw] auto_config_enabled + # Indicates whether auto-configuration is turned on for this + # application. # @return [Boolean] # # @!attribute [rw] discovery_type + # The method used by Application Insights to onboard your resources. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/ApplicationInfo AWS API Documentation @@ -198,6 +201,7 @@ class ConfigurationEvent < Struct.new( # ], # auto_config_enabled: false, # auto_create: false, + # grouping_type: "ACCOUNT_BASED", # accepts ACCOUNT_BASED # } # # @!attribute [rw] resource_group_name @@ -228,11 +232,22 @@ class ConfigurationEvent < Struct.new( # @return [Array] # # @!attribute [rw] auto_config_enabled + # Indicates whether Application Insights automatically configures + # unmonitored resources in the resource group. # @return [Boolean] # # @!attribute [rw] auto_create + # Configures all of the resources in the resource group by applying + # the recommended configurations. # @return [Boolean] # + # @!attribute [rw] grouping_type + # Application Insights can create applications based on a resource + # group or on an account. To create an account-based application using + # all of the resources in the account, set this parameter to + # `ACCOUNT_BASED`. + # @return [String] + # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/CreateApplicationRequest AWS API Documentation # class CreateApplicationRequest < Struct.new( @@ -242,7 +257,8 @@ class CreateApplicationRequest < Struct.new( :ops_item_sns_topic_arn, :tags, :auto_config_enabled, - :auto_create) + :auto_create, + :grouping_type) SENSITIVE = [] include Aws::Structure end @@ -501,9 +517,7 @@ class DescribeApplicationResponse < Struct.new( # @return [String] # # @!attribute [rw] tier - # The tier of the application component. Supported tiers include - # `DOT_NET_CORE`, `DOT_NET_WORKER`, `DOT_NET_WEB`, `SQL_SERVER`, and - # `DEFAULT`. + # The tier of the application component. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/DescribeComponentConfigurationRecommendationRequest AWS API Documentation @@ -1111,6 +1125,7 @@ class ListLogPatternsResponse < Struct.new( # @return [String] # # @!attribute [rw] component_name + # The name of the component. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/ListProblemsRequest AWS API Documentation @@ -1136,6 +1151,7 @@ class ListProblemsRequest < Struct.new( # @return [String] # # @!attribute [rw] resource_group_name + # The name of the resource group. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/ListProblemsResponse AWS API Documentation @@ -1519,9 +1535,12 @@ class Observation < Struct.new( # @return [Hash] # # @!attribute [rw] recurring_count + # The number of times that the same problem reoccurred after the first + # time it was resolved. # @return [Integer] # # @!attribute [rw] last_recurrence_time + # The last time that the problem reoccurred after its last resolution. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/Problem AWS API Documentation @@ -1782,6 +1801,7 @@ class UntagResourceResponse < Aws::EmptyStructure; end # @return [Boolean] # # @!attribute [rw] auto_config_enabled + # Turns auto-configuration on or off. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/UpdateApplicationRequest AWS API Documentation @@ -1834,9 +1854,7 @@ class UpdateApplicationResponse < Struct.new( # @return [Boolean] # # @!attribute [rw] tier - # The tier of the application component. Supported tiers include - # `DOT_NET_WORKER`, `DOT_NET_WEB`, `DOT_NET_CORE`, `SQL_SERVER`, and - # `DEFAULT`. + # The tier of the application component. # @return [String] # # @!attribute [rw] component_configuration @@ -1855,6 +1873,8 @@ class UpdateApplicationResponse < Struct.new( # @return [String] # # @!attribute [rw] auto_config_enabled + # Automatically configures the component by applying the recommended + # configurations. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/UpdateComponentConfigurationRequest AWS API Documentation diff --git a/gems/aws-sdk-codeartifact/CHANGELOG.md b/gems/aws-sdk-codeartifact/CHANGELOG.md index d2ba06c4216..0fe4e3ac11c 100644 --- a/gems/aws-sdk-codeartifact/CHANGELOG.md +++ b/gems/aws-sdk-codeartifact/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.20.0 (2022-06-02) +------------------ + +* Feature - Documentation updates for CodeArtifact + 1.19.0 (2022-02-24) ------------------ diff --git a/gems/aws-sdk-codeartifact/VERSION b/gems/aws-sdk-codeartifact/VERSION index 815d5ca06d5..39893559155 100644 --- a/gems/aws-sdk-codeartifact/VERSION +++ b/gems/aws-sdk-codeartifact/VERSION @@ -1 +1 @@ -1.19.0 +1.20.0 diff --git a/gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact.rb b/gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact.rb index ad4aef233b9..abc57aeda65 100644 --- a/gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact.rb +++ b/gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact.rb @@ -48,6 +48,6 @@ # @!group service module Aws::CodeArtifact - GEM_VERSION = '1.19.0' + GEM_VERSION = '1.20.0' end diff --git a/gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb b/gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb index 015d6203154..83f2db5c024 100644 --- a/gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb +++ b/gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb @@ -363,8 +363,8 @@ def initialize(*args) # The name of the domain that contains the repository. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [required, String] :repository # The name of the repository to which the external connection is added. @@ -375,6 +375,8 @@ def initialize(*args) # # * `public:npmjs` - for the npm public repository. # + # * `public:nuget-org` - for the NuGet Gallery. + # # * `public:pypi` - for the Python Package Index. # # * `public:maven-central` - for Maven Central. @@ -435,8 +437,8 @@ def associate_external_connection(params = {}, options = {}) # repositories. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [required, String] :source_repository # The name of the repository that contains the package versions to copy. @@ -445,14 +447,7 @@ def associate_external_connection(params = {}, options = {}) # The name of the repository into which package versions are copied. # # @option params [required, String] :format - # The format of the package that is copied. The valid package types are: - # - # * `npm`\: A Node Package Manager (npm) package. - # - # * `pypi`\: A Python Package Index (PyPI) package. - # - # * `maven`\: A Maven package that contains compiled code in a - # distributable format, such as a JAR file. + # The format of the package that is copied. # # @option params [String] :namespace # The namespace of the package. The package component that specifies its @@ -547,9 +542,9 @@ def copy_package_versions(params = {}, options = {}) # Creates a domain. CodeArtifact *domains* make it easier to manage # multiple repositories across an organization. You can use a domain to - # apply permissions across many repositories owned by different AWS - # accounts. An asset is stored only once in a domain, even if it's in - # multiple repositories. + # apply permissions across many repositories owned by different Amazon + # Web Services accounts. An asset is stored only once in a domain, even + # if it's in multiple repositories. # # Although you can have multiple domains, we recommend a single # production domain that contains all published artifacts so that your @@ -558,10 +553,11 @@ def copy_package_versions(params = {}, options = {}) # configuration. # # @option params [required, String] :domain - # The name of the domain to create. All domain names in an AWS Region - # that are in the same AWS account must be unique. The domain name is - # used as the prefix in DNS hostnames. Do not use sensitive information - # in a domain name because it is publicly discoverable. + # The name of the domain to create. All domain names in an Amazon Web + # Services Region that are in the same Amazon Web Services account must + # be unique. The domain name is used as the prefix in DNS hostnames. Do + # not use sensitive information in a domain name because it is publicly + # discoverable. # # @option params [String] :encryption_key # The encryption key for the domain. This is used to encrypt content @@ -569,13 +565,13 @@ def copy_package_versions(params = {}, options = {}) # Resource Name (ARN), a key alias, or a key alias ARN. To specify an # `encryptionKey`, your IAM role must have `kms:DescribeKey` and # `kms:CreateGrant` permissions on the encryption key that is used. For - # more information, see [DescribeKey][1] in the *AWS Key Management - # Service API Reference* and [AWS KMS API Permissions Reference][2] in - # the *AWS Key Management Service Developer Guide*. + # more information, see [DescribeKey][1] in the *Key Management Service + # API Reference* and [Key Management Service API Permissions + # Reference][2] in the *Key Management Service Developer Guide*. # # CodeArtifact supports only symmetric CMKs. Do not associate an # asymmetric CMK with your domain. For more information, see [Using - # symmetric and asymmetric keys][3] in the *AWS Key Management Service + # symmetric and asymmetric keys][3] in the *Key Management Service # Developer Guide*. # # @@ -631,8 +627,8 @@ def create_domain(params = {}, options = {}) # The name of the domain that contains the created repository. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [required, String] :repository # The name of the repository to create. @@ -643,7 +639,7 @@ def create_domain(params = {}, options = {}) # @option params [Array] :upstreams # A list of upstream repositories to associate with the repository. The # order of the upstream repositories in the list determines their - # priority order when AWS CodeArtifact looks for a requested package + # priority order when CodeArtifact looks for a requested package # version. For more information, see [Working with upstream # repositories][1]. # @@ -710,8 +706,8 @@ def create_repository(params = {}, options = {}) # The name of the domain to delete. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @return [Types::DeleteDomainResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -752,8 +748,8 @@ def delete_domain(params = {}, options = {}) # deleted. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [String] :policy_revision # The current revision of the resource policy to be deleted. This @@ -804,21 +800,15 @@ def delete_domain_permissions_policy(params = {}, options = {}) # The name of the domain that contains the package to delete. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [required, String] :repository # The name of the repository that contains the package versions to # delete. # # @option params [required, String] :format - # The format of the package versions to delete. The valid values are: - # - # * `npm` - # - # * `pypi` - # - # * `maven` + # The format of the package versions to delete. # # @option params [String] :namespace # The namespace of the package. The package component that specifies its @@ -839,18 +829,7 @@ def delete_domain_permissions_policy(params = {}, options = {}) # delete. # # @option params [String] :expected_status - # The expected status of the package version to delete. Valid values - # are: - # - # * `Published` - # - # * `Unfinished` - # - # * `Unlisted` - # - # * `Archived` - # - # * `Disposed` + # The expected status of the package version to delete. # # @return [Types::DeletePackageVersionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -894,8 +873,8 @@ def delete_package_versions(params = {}, options = {}) # The name of the domain that contains the repository to delete. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [required, String] :repository # The name of the repository to delete. @@ -942,16 +921,17 @@ def delete_repository(params = {}, options = {}) # might not be immediate. # # Use `DeleteRepositoryPermissionsPolicy` with caution. After a policy - # is deleted, AWS users, roles, and accounts lose permissions to perform - # the repository actions granted by the deleted policy. + # is deleted, Amazon Web Services users, roles, and accounts lose + # permissions to perform the repository actions granted by the deleted + # policy. # # @option params [required, String] :domain # The name of the domain that contains the repository associated with # the resource policy to be deleted. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [required, String] :repository # The name of the repository that is associated with the resource policy @@ -1002,8 +982,8 @@ def delete_repository_permissions_policy(params = {}, options = {}) # A string that specifies the name of the requested domain. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @return [Types::DescribeDomainResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -1049,21 +1029,14 @@ def describe_domain(params = {}, options = {}) # package version. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [required, String] :repository # The name of the repository that contains the package version. # # @option params [required, String] :format - # A format that specifies the type of the requested package version. The - # valid values are: - # - # * `npm` - # - # * `pypi` - # - # * `maven` + # A format that specifies the type of the requested package version. # # @option params [String] :namespace # The namespace of the package. The package component that specifies its @@ -1131,8 +1104,8 @@ def describe_package_version(params = {}, options = {}) # The name of the domain that contains the repository to describe. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [required, String] :repository # A string that specifies the name of the requested repository. @@ -1180,8 +1153,8 @@ def describe_repository(params = {}, options = {}) # remove the external repository. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [required, String] :repository # The name of the repository from which the external connection will be @@ -1249,8 +1222,8 @@ def disassociate_external_connection(params = {}, options = {}) # dispose. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [required, String] :repository # The name of the repository that contains the package versions you want @@ -1258,13 +1231,7 @@ def disassociate_external_connection(params = {}, options = {}) # # @option params [required, String] :format # A format that specifies the type of package versions you want to - # dispose. The valid values are: - # - # * `npm` - # - # * `pypi` - # - # * `maven` + # dispose. # # @option params [String] :namespace # The namespace of the package. The package component that specifies its @@ -1287,18 +1254,7 @@ def disassociate_external_connection(params = {}, options = {}) # The revisions of the package versions you want to dispose. # # @option params [String] :expected_status - # The expected status of the package version to dispose. Valid values - # are: - # - # * `Published` - # - # * `Unfinished` - # - # * `Unlisted` - # - # * `Archived` - # - # * `Disposed` + # The expected status of the package version to dispose. # # @return [Types::DisposePackageVersionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -1342,8 +1298,8 @@ def dispose_package_versions(params = {}, options = {}) # Generates a temporary authorization token for accessing repositories # in the domain. This API requires the # `codeartifact:GetAuthorizationToken` and `sts:GetServiceBearerToken` - # permissions. For more information about authorization tokens, see [AWS - # CodeArtifact authentication and tokens][1]. + # permissions. For more information about authorization tokens, see + # [CodeArtifact authentication and tokens][1]. # # CodeArtifact authorization tokens are valid for a period of 12 hours # when created with the `login` command. You can call `login` @@ -1376,8 +1332,8 @@ def dispose_package_versions(params = {}, options = {}) # authorization token. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [Integer] :duration_seconds # The time, in seconds, that the generated authorization token is valid. @@ -1417,7 +1373,7 @@ def get_authorization_token(params = {}, options = {}) # # The policy is a resource-based policy, not an identity-based policy. # For more information, see [Identity-based policies and resource-based - # policies ][1] in the *AWS Identity and Access Management User Guide*. + # policies ][1] in the *IAM User Guide*. # # # @@ -1429,8 +1385,8 @@ def get_authorization_token(params = {}, options = {}) # The name of the domain to which the resource policy is attached. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @return [Types::GetDomainPermissionsPolicyResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -1467,8 +1423,8 @@ def get_domain_permissions_policy(params = {}, options = {}) # package version with the requested asset. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [required, String] :repository # The repository that contains the package version with the requested @@ -1476,13 +1432,7 @@ def get_domain_permissions_policy(params = {}, options = {}) # # @option params [required, String] :format # A format that specifies the type of the package version with the - # requested asset file. The valid values are: - # - # * `npm` - # - # * `pypi` - # - # * `maven` + # requested asset file. # # @option params [String] :namespace # The namespace of the package. The package component that specifies its @@ -1545,10 +1495,7 @@ def get_package_version_asset(params = {}, options = {}, &block) req.send_request(options, &block) end - # Gets the readme file or descriptive text for a package version. For - # packages that do not contain a readme file, CodeArtifact extracts a - # description from a metadata file. For example, from the - # `` element in the `pom.xml` file of a Maven package. + # Gets the readme file or descriptive text for a package version. # # The returned text might contain formatting. For example, it might # contain formatting for Markdown or reStructuredText. @@ -1558,8 +1505,8 @@ def get_package_version_asset(params = {}, options = {}, &block) # package version with the requested readme file. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [required, String] :repository # The repository that contains the package with the requested readme @@ -1567,13 +1514,12 @@ def get_package_version_asset(params = {}, options = {}, &block) # # @option params [required, String] :format # A format that specifies the type of the package version with the - # requested readme file. The valid values are: - # - # * `npm` + # requested readme file. # - # * `pypi` + # Although `maven` is listed as a valid value, CodeArtifact does not + # support displaying readme files for Maven packages. # - # * `maven` + # # # @option params [String] :namespace # The namespace of the package. The package component that specifies its @@ -1635,31 +1581,28 @@ def get_package_version_readme(params = {}, options = {}) # Returns the endpoint of a repository for a specific package format. A # repository has one endpoint for each package format: # + # * `maven` + # # * `npm` # - # * `pypi` + # * `nuget` # - # * `maven` + # * `pypi` # # @option params [required, String] :domain # The name of the domain that contains the repository. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain - # that contains the repository. It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain that contains the repository. It does not include + # dashes or spaces. # # @option params [required, String] :repository # The name of the repository. # # @option params [required, String] :format # Returns which endpoint of a repository to return. A repository has one - # endpoint for each package format: - # - # * `npm` - # - # * `pypi` - # - # * `maven` + # endpoint for each package format. # # @return [Types::GetRepositoryEndpointResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -1694,8 +1637,8 @@ def get_repository_endpoint(params = {}, options = {}) # resource policy is to be retrieved. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [required, String] :repository # The name of the repository whose associated resource policy is to be @@ -1729,8 +1672,8 @@ def get_repository_permissions_policy(params = {}, options = {}) end # Returns a list of [DomainSummary][1] objects for all domains owned by - # the AWS account that makes this call. Each returned `DomainSummary` - # object contains information about a domain. + # the Amazon Web Services account that makes this call. Each returned + # `DomainSummary` object contains information about a domain. # # # @@ -1790,8 +1733,8 @@ def list_domains(params = {}, options = {}) # the package version assets. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [required, String] :repository # The name of the repository that contains the package that contains the @@ -1799,14 +1742,7 @@ def list_domains(params = {}, options = {}) # # @option params [required, String] :format # The format of the package that contains the returned package version - # assets. The valid package types are: - # - # * `npm`\: A Node Package Manager (npm) package. - # - # * `pypi`\: A Python Package Index (PyPI) package. - # - # * `maven`\: A Maven package that contains compiled code in a - # distributable format, such as a JAR file. + # assets. # # @option params [String] :namespace # The namespace of the package. The package component that specifies its @@ -1900,23 +1836,15 @@ def list_package_version_assets(params = {}, options = {}) # requested package version dependencies. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [required, String] :repository # The name of the repository that contains the requested package # version. # # @option params [required, String] :format - # The format of the package with the requested dependencies. The valid - # package types are: - # - # * `npm`\: A Node Package Manager (npm) package. - # - # * `pypi`\: A Python Package Index (PyPI) package. - # - # * `maven`\: A Maven package that contains compiled code in a - # distributable format, such as a JAR file. + # The format of the package with the requested dependencies. # # @option params [String] :namespace # The namespace of the package. The package component that specifies its @@ -1998,21 +1926,14 @@ def list_package_version_dependencies(params = {}, options = {}) # returned package versions. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [required, String] :repository # The name of the repository that contains the package. # # @option params [required, String] :format - # The format of the returned packages. The valid package types are: - # - # * `npm`\: A Node Package Manager (npm) package. - # - # * `pypi`\: A Python Package Index (PyPI) package. - # - # * `maven`\: A Maven package that contains compiled code in a - # distributable format, such as a JAR file. + # The format of the returned packages. # # @option params [String] :namespace # The namespace of the package. The package component that specifies its @@ -2031,17 +1952,7 @@ def list_package_version_dependencies(params = {}, options = {}) # # @option params [String] :status # A string that specifies the status of the package versions to include - # in the returned list. It can be one of the following: - # - # * `Published` - # - # * `Unfinished` - # - # * `Unlisted` - # - # * `Archived` - # - # * `Disposed` + # in the returned list. # # @option params [String] :sort_by # How to sort the returned list of package versions. @@ -2113,21 +2024,14 @@ def list_package_versions(params = {}, options = {}) # requested list of packages. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [required, String] :repository # The name of the repository from which packages are to be listed. # # @option params [String] :format - # The format of the packages. The valid package types are: - # - # * `npm`\: A Node Package Manager (npm) package. - # - # * `pypi`\: A Python Package Index (PyPI) package. - # - # * `maven`\: A Maven package that contains compiled code in a - # distributable format, such as a JAR file. + # The format of the packages. # # @option params [String] :namespace # The namespace of the package. The package component that specifies its @@ -2191,7 +2095,8 @@ def list_packages(params = {}, options = {}) # Returns a list of [RepositorySummary][1] objects. Each # `RepositorySummary` contains information about a repository in the - # specified AWS account and that matches the input parameters. + # specified Amazon Web Services account and that matches the input + # parameters. # # # @@ -2257,12 +2162,12 @@ def list_repositories(params = {}, options = {}) # repositories. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [String] :administrator_account # Filter the list of repositories to only include those that are managed - # by the AWS account ID. + # by the Amazon Web Services account ID. # # @option params [String] :repository_prefix # A prefix used to filter returned repositories. Only repositories with @@ -2314,8 +2219,8 @@ def list_repositories_in_domain(params = {}, options = {}) req.send_request(options) end - # Gets information about AWS tags for a specified Amazon Resource Name - # (ARN) in AWS CodeArtifact. + # Gets information about Amazon Web Services tags for a specified Amazon + # Resource Name (ARN) in CodeArtifact. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) of the resource to get tags for. @@ -2357,8 +2262,8 @@ def list_tags_for_resource(params = {}, options = {}) # The name of the domain on which to set the resource policy. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [String] :policy_revision # The current revision of the resource policy to be set. This revision @@ -2411,8 +2316,8 @@ def put_domain_permissions_policy(params = {}, options = {}) # policy on. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [required, String] :repository # The name of the repository to set the resource policy on. @@ -2456,7 +2361,7 @@ def put_repository_permissions_policy(params = {}, options = {}) req.send_request(options) end - # Adds or updates tags for a resource in AWS CodeArtifact. + # Adds or updates tags for a resource in CodeArtifact. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) of the resource that you want to add or @@ -2488,7 +2393,7 @@ def tag_resource(params = {}, options = {}) req.send_request(options) end - # Removes tags from a resource in AWS CodeArtifact. + # Removes tags from a resource in CodeArtifact. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) of the resource that you want to remove @@ -2515,15 +2420,22 @@ def untag_resource(params = {}, options = {}) req.send_request(options) end - # Updates the status of one or more versions of a package. + # Updates the status of one or more versions of a package. Using + # `UpdatePackageVersionsStatus`, you can update the status of package + # versions to `Archived`, `Published`, or `Unlisted`. To set the status + # of a package version to `Disposed`, use [DisposePackageVersions][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DisposePackageVersions.html # # @option params [required, String] :domain # The name of the domain that contains the repository that contains the # package versions with a status to be updated. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [required, String] :repository # The repository that contains the package versions with the status you @@ -2531,13 +2443,7 @@ def untag_resource(params = {}, options = {}) # # @option params [required, String] :format # A format that specifies the type of the package with the statuses to - # update. The valid values are: - # - # * `npm` - # - # * `pypi` - # - # * `maven` + # update. # # @option params [String] :namespace # The namespace of the package. The package component that specifies its @@ -2617,8 +2523,8 @@ def update_package_versions_status(params = {}, options = {}) # The name of the domain associated with the repository to update. # # @option params [String] :domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # # @option params [required, String] :repository # The name of the repository to update. @@ -2629,7 +2535,7 @@ def update_package_versions_status(params = {}, options = {}) # @option params [Array] :upstreams # A list of upstream repositories to associate with the repository. The # order of the upstream repositories in the list determines their - # priority order when AWS CodeArtifact looks for a requested package + # priority order when CodeArtifact looks for a requested package # version. For more information, see [Working with upstream # repositories][1]. # @@ -2692,7 +2598,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-codeartifact' - context[:gem_version] = '1.19.0' + context[:gem_version] = '1.20.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/types.rb b/gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/types.rb index acd335a7669..6777c758b48 100644 --- a/gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/types.rb +++ b/gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/types.rb @@ -63,8 +63,8 @@ class AssetSummary < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] repository @@ -78,6 +78,8 @@ class AssetSummary < Struct.new( # # * `public:npmjs` - for the npm public repository. # + # * `public:nuget-org` - for the NuGet Gallery. + # # * `public:pypi` - for the Python Package Index. # # * `public:maven-central` - for Maven Central. @@ -124,7 +126,7 @@ class AssociateExternalConnectionResult < Struct.new( # @return [String] # # @!attribute [rw] resource_type - # The type of AWS resource. + # The type of Amazon Web Services resource. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/ConflictException AWS API Documentation @@ -162,8 +164,8 @@ class ConflictException < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] source_repository @@ -176,15 +178,7 @@ class ConflictException < Struct.new( # @return [String] # # @!attribute [rw] format - # The format of the package that is copied. The valid package types - # are: - # - # * `npm`\: A Node Package Manager (npm) package. - # - # * `pypi`\: A Python Package Index (PyPI) package. - # - # * `maven`\: A Maven package that contains compiled code in a - # distributable format, such as a JAR file. + # The format of the package that is copied. # @return [String] # # @!attribute [rw] namespace @@ -308,10 +302,11 @@ class CopyPackageVersionsResult < Struct.new( # } # # @!attribute [rw] domain - # The name of the domain to create. All domain names in an AWS Region - # that are in the same AWS account must be unique. The domain name is - # used as the prefix in DNS hostnames. Do not use sensitive - # information in a domain name because it is publicly discoverable. + # The name of the domain to create. All domain names in an Amazon Web + # Services Region that are in the same Amazon Web Services account + # must be unique. The domain name is used as the prefix in DNS + # hostnames. Do not use sensitive information in a domain name because + # it is publicly discoverable. # @return [String] # # @!attribute [rw] encryption_key @@ -320,13 +315,13 @@ class CopyPackageVersionsResult < Struct.new( # Resource Name (ARN), a key alias, or a key alias ARN. To specify an # `encryptionKey`, your IAM role must have `kms:DescribeKey` and # `kms:CreateGrant` permissions on the encryption key that is used. - # For more information, see [DescribeKey][1] in the *AWS Key - # Management Service API Reference* and [AWS KMS API Permissions - # Reference][2] in the *AWS Key Management Service Developer Guide*. + # For more information, see [DescribeKey][1] in the *Key Management + # Service API Reference* and [Key Management Service API Permissions + # Reference][2] in the *Key Management Service Developer Guide*. # # CodeArtifact supports only symmetric CMKs. Do not associate an # asymmetric CMK with your domain. For more information, see [Using - # symmetric and asymmetric keys][3] in the *AWS Key Management Service + # symmetric and asymmetric keys][3] in the *Key Management Service # Developer Guide*. # # @@ -389,8 +384,8 @@ class CreateDomainResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] repository @@ -404,7 +399,7 @@ class CreateDomainResult < Struct.new( # @!attribute [rw] upstreams # A list of upstream repositories to associate with the repository. # The order of the upstream repositories in the list determines their - # priority order when AWS CodeArtifact looks for a requested package + # priority order when CodeArtifact looks for a requested package # version. For more information, see [Working with upstream # repositories][1]. # @@ -458,8 +453,8 @@ class CreateRepositoryResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] policy_revision @@ -504,8 +499,8 @@ class DeleteDomainPermissionsPolicyResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/DeleteDomainRequest AWS API Documentation @@ -549,8 +544,8 @@ class DeleteDomainResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] repository @@ -559,13 +554,7 @@ class DeleteDomainResult < Struct.new( # @return [String] # # @!attribute [rw] format - # The format of the package versions to delete. The valid values are: - # - # * `npm` - # - # * `pypi` - # - # * `maven` + # The format of the package versions to delete. # @return [String] # # @!attribute [rw] namespace @@ -590,18 +579,7 @@ class DeleteDomainResult < Struct.new( # @return [Array] # # @!attribute [rw] expected_status - # The expected status of the package version to delete. Valid values - # are: - # - # * `Published` - # - # * `Unfinished` - # - # * `Unlisted` - # - # * `Archived` - # - # * `Disposed` + # The expected status of the package version to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/DeletePackageVersionsRequest AWS API Documentation @@ -620,7 +598,8 @@ class DeletePackageVersionsRequest < Struct.new( end # @!attribute [rw] successful_versions - # A list of the package versions that were successfully deleted. + # A list of the package versions that were successfully deleted. The + # status of every successful version will be `Deleted`. # @return [Hash] # # @!attribute [rw] failed_versions @@ -665,8 +644,8 @@ class DeletePackageVersionsResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] repository @@ -718,8 +697,8 @@ class DeleteRepositoryPermissionsPolicyResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] repository @@ -762,8 +741,8 @@ class DeleteRepositoryResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/DescribeDomainRequest AWS API Documentation @@ -808,8 +787,8 @@ class DescribeDomainResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] repository @@ -818,13 +797,6 @@ class DescribeDomainResult < Struct.new( # # @!attribute [rw] format # A format that specifies the type of the requested package version. - # The valid values are: - # - # * `npm` - # - # * `pypi` - # - # * `maven` # @return [String] # # @!attribute [rw] namespace @@ -892,8 +864,8 @@ class DescribePackageVersionResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] repository @@ -939,8 +911,8 @@ class DescribeRepositoryResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] repository @@ -999,8 +971,8 @@ class DisassociateExternalConnectionResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] repository @@ -1010,13 +982,7 @@ class DisassociateExternalConnectionResult < Struct.new( # # @!attribute [rw] format # A format that specifies the type of package versions you want to - # dispose. The valid values are: - # - # * `npm` - # - # * `pypi` - # - # * `maven` + # dispose. # @return [String] # # @!attribute [rw] namespace @@ -1044,18 +1010,7 @@ class DisassociateExternalConnectionResult < Struct.new( # @return [Hash] # # @!attribute [rw] expected_status - # The expected status of the package version to dispose. Valid values - # are: - # - # * `Published` - # - # * `Unfinished` - # - # * `Unlisted` - # - # * `Archived` - # - # * `Disposed` + # The expected status of the package version to dispose. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/DisposePackageVersionsRequest AWS API Documentation @@ -1114,7 +1069,7 @@ class DisposePackageVersionsResult < Struct.new( # @return [String] # # @!attribute [rw] owner - # The AWS account ID that owns the domain. + # The Amazon Web Services account ID that owns the domain. # @return [String] # # @!attribute [rw] arn @@ -1122,11 +1077,7 @@ class DisposePackageVersionsResult < Struct.new( # @return [String] # # @!attribute [rw] status - # The current status of a domain. The valid values are - # - # * `Active` - # - # * `Deleted` + # The current status of a domain. # @return [String] # # @!attribute [rw] created_time @@ -1135,8 +1086,8 @@ class DisposePackageVersionsResult < Struct.new( # @return [Time] # # @!attribute [rw] encryption_key - # The ARN of an AWS Key Management Service (AWS KMS) key associated - # with a domain. + # The ARN of an Key Management Service (KMS) key associated with a + # domain. # @return [String] # # @!attribute [rw] repository_count @@ -1181,8 +1132,8 @@ class DomainDescription < Struct.new( # @return [String] # # @!attribute [rw] owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] arn @@ -1190,12 +1141,7 @@ class DomainDescription < Struct.new( # @return [String] # # @!attribute [rw] status - # A string that contains the status of the domain. The valid values - # are: - # - # * `Active` - # - # * `Deleted` + # A string that contains the status of the domain. # @return [String] # # @!attribute [rw] created_time @@ -1234,8 +1180,8 @@ class DomainSummary < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] duration_seconds @@ -1287,8 +1233,8 @@ class GetAuthorizationTokenResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/GetDomainPermissionsPolicyRequest AWS API Documentation @@ -1333,8 +1279,8 @@ class GetDomainPermissionsPolicyResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] repository @@ -1344,13 +1290,7 @@ class GetDomainPermissionsPolicyResult < Struct.new( # # @!attribute [rw] format # A format that specifies the type of the package version with the - # requested asset file. The valid values are: - # - # * `npm` - # - # * `pypi` - # - # * `maven` + # requested asset file. # @return [String] # # @!attribute [rw] namespace @@ -1445,8 +1385,8 @@ class GetPackageVersionAssetResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] repository @@ -1456,13 +1396,12 @@ class GetPackageVersionAssetResult < Struct.new( # # @!attribute [rw] format # A format that specifies the type of the package version with the - # requested readme file. The valid values are: + # requested readme file. # - # * `npm` + # Although `maven` is listed as a valid value, CodeArtifact does not + # support displaying readme files for Maven packages. # - # * `pypi` - # - # * `maven` + # # @return [String] # # @!attribute [rw] namespace @@ -1501,14 +1440,7 @@ class GetPackageVersionReadmeRequest < Struct.new( end # @!attribute [rw] format - # The format of the package with the requested readme file. Valid - # format types are: - # - # * `npm` - # - # * `pypi` - # - # * `maven` + # The format of the package with the requested readme file. # @return [String] # # @!attribute [rw] namespace @@ -1567,8 +1499,9 @@ class GetPackageVersionReadmeResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain - # that contains the repository. It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain that contains the repository. It does not include + # dashes or spaces. # @return [String] # # @!attribute [rw] repository @@ -1577,13 +1510,7 @@ class GetPackageVersionReadmeResult < Struct.new( # # @!attribute [rw] format # Returns which endpoint of a repository to return. A repository has - # one endpoint for each package format: - # - # * `npm` - # - # * `pypi` - # - # * `maven` + # one endpoint for each package format. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/GetRepositoryEndpointRequest AWS API Documentation @@ -1624,8 +1551,8 @@ class GetRepositoryEndpointResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] repository @@ -1656,7 +1583,7 @@ class GetRepositoryPermissionsPolicyResult < Struct.new( end # The operation did not succeed because of an error that occurred inside - # AWS CodeArtifact. + # CodeArtifact. # # @!attribute [rw] message # @return [String] @@ -1759,8 +1686,8 @@ class ListDomainsResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] repository @@ -1770,14 +1697,7 @@ class ListDomainsResult < Struct.new( # # @!attribute [rw] format # The format of the package that contains the returned package version - # assets. The valid package types are: - # - # * `npm`\: A Node Package Manager (npm) package. - # - # * `pypi`\: A Python Package Index (PyPI) package. - # - # * `maven`\: A Maven package that contains compiled code in a - # distributable format, such as a JAR file. + # assets. # @return [String] # # @!attribute [rw] namespace @@ -1904,8 +1824,8 @@ class ListPackageVersionAssetsResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] repository @@ -1914,15 +1834,7 @@ class ListPackageVersionAssetsResult < Struct.new( # @return [String] # # @!attribute [rw] format - # The format of the package with the requested dependencies. The valid - # package types are: - # - # * `npm`\: A Node Package Manager (npm) package. - # - # * `pypi`\: A Python Package Index (PyPI) package. - # - # * `maven`\: A Maven package that contains compiled code in a - # distributable format, such as a JAR file. + # The format of the package with the requested dependencies. # @return [String] # # @!attribute [rw] namespace @@ -1968,13 +1880,7 @@ class ListPackageVersionDependenciesRequest < Struct.new( # @!attribute [rw] format # A format that specifies the type of the package that contains the - # returned dependencies. The valid values are: - # - # * `npm` - # - # * `pypi` - # - # * `maven` + # returned dependencies. # @return [String] # # @!attribute [rw] namespace @@ -2052,8 +1958,8 @@ class ListPackageVersionDependenciesResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] repository @@ -2061,14 +1967,7 @@ class ListPackageVersionDependenciesResult < Struct.new( # @return [String] # # @!attribute [rw] format - # The format of the returned packages. The valid package types are: - # - # * `npm`\: A Node Package Manager (npm) package. - # - # * `pypi`\: A Python Package Index (PyPI) package. - # - # * `maven`\: A Maven package that contains compiled code in a - # distributable format, such as a JAR file. + # The format of the returned packages. # @return [String] # # @!attribute [rw] namespace @@ -2090,17 +1989,7 @@ class ListPackageVersionDependenciesResult < Struct.new( # # @!attribute [rw] status # A string that specifies the status of the package versions to - # include in the returned list. It can be one of the following: - # - # * `Published` - # - # * `Unfinished` - # - # * `Unlisted` - # - # * `Archived` - # - # * `Disposed` + # include in the returned list. # @return [String] # # @!attribute [rw] sort_by @@ -2147,13 +2036,7 @@ class ListPackageVersionsRequest < Struct.new( # @return [String] # # @!attribute [rw] format - # A format of the package. Valid package format values are: - # - # * `npm` - # - # * `pypi` - # - # * `maven` + # A format of the package. # @return [String] # # @!attribute [rw] namespace @@ -2218,8 +2101,8 @@ class ListPackageVersionsResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] repository @@ -2227,14 +2110,7 @@ class ListPackageVersionsResult < Struct.new( # @return [String] # # @!attribute [rw] format - # The format of the packages. The valid package types are: - # - # * `npm`\: A Node Package Manager (npm) package. - # - # * `pypi`\: A Python Package Index (PyPI) package. - # - # * `maven`\: A Maven package that contains compiled code in a - # distributable format, such as a JAR file. + # The format of the packages. # @return [String] # # @!attribute [rw] namespace @@ -2319,13 +2195,13 @@ class ListPackagesResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] administrator_account # Filter the list of repositories to only include those that are - # managed by the AWS account ID. + # managed by the Amazon Web Services account ID. # @return [String] # # @!attribute [rw] repository_prefix @@ -2513,13 +2389,7 @@ class PackageDependency < Struct.new( # [1]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackages.html # # @!attribute [rw] format - # The format of the package. Valid values are: - # - # * `npm` - # - # * `pypi` - # - # * `maven` + # The format of the package. # @return [String] # # @!attribute [rw] namespace @@ -2551,14 +2421,7 @@ class PackageSummary < Struct.new( # Details about a package version. # # @!attribute [rw] format - # The format of the package version. The valid package formats are: - # - # * `npm`\: A Node Package Manager (npm) package. - # - # * `pypi`\: A Python Package Index (PyPI) package. - # - # * `maven`\: A Maven package that contains compiled code in a - # distributable format, such as a JAR file. + # The format of the package version. # @return [String] # # @!attribute [rw] namespace @@ -2617,18 +2480,7 @@ class PackageSummary < Struct.new( # @return [String] # # @!attribute [rw] status - # A string that contains the status of the package version. It can be - # one of the following: - # - # * `Published` - # - # * `Unfinished` - # - # * `Unlisted` - # - # * `Archived` - # - # * `Disposed` + # A string that contains the status of the package version. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/PackageVersionDescription AWS API Documentation @@ -2700,16 +2552,6 @@ class PackageVersionError < Struct.new( # @!attribute [rw] status # A string that contains the status of the package version. It can be # one of the following: - # - # * `Published` - # - # * `Unfinished` - # - # * `Unlisted` - # - # * `Archived` - # - # * `Disposed` # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/PackageVersionSummary AWS API Documentation @@ -2737,8 +2579,8 @@ class PackageVersionSummary < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] policy_revision @@ -2792,8 +2634,8 @@ class PutDomainPermissionsPolicyResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] repository @@ -2836,21 +2678,21 @@ class PutRepositoryPermissionsPolicyResult < Struct.new( include Aws::Structure end - # The details of a repository stored in AWS CodeArtifact. A CodeArtifact + # The details of a repository stored in CodeArtifact. A CodeArtifact # repository contains a set of package versions, each of which maps to a # set of assets. Repositories are polyglot—a single repository can # contain packages of any supported type. Each repository exposes # endpoints for fetching and publishing packages using tools like the # `npm` CLI, the Maven CLI (`mvn`), and `pip`. You can create up to 100 - # repositories per AWS account. + # repositories per Amazon Web Services account. # # @!attribute [rw] name # The name of the repository. # @return [String] # # @!attribute [rw] administrator_account - # The 12-digit account number of the AWS account that manages the - # repository. + # The 12-digit account number of the Amazon Web Services account that + # manages the repository. # @return [String] # # @!attribute [rw] domain_name @@ -2858,8 +2700,9 @@ class PutRepositoryPermissionsPolicyResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain - # that contains the repository. It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain that contains the repository. It does not include + # dashes or spaces. # @return [String] # # @!attribute [rw] arn @@ -2873,7 +2716,7 @@ class PutRepositoryPermissionsPolicyResult < Struct.new( # @!attribute [rw] upstreams # A list of upstream repositories to associate with the repository. # The order of the upstream repositories in the list determines their - # priority order when AWS CodeArtifact looks for a requested package + # priority order when CodeArtifact looks for a requested package # version. For more information, see [Working with upstream # repositories][1]. # @@ -2917,6 +2760,8 @@ class RepositoryDescription < Struct.new( # # * `maven`\: A Maven package that contains compiled code in a # distributable format, such as a JAR file. + # + # * `nuget`\: A NuGet package. # @return [String] # # @!attribute [rw] status @@ -2947,7 +2792,7 @@ class RepositoryExternalConnectionInfo < Struct.new( # @return [String] # # @!attribute [rw] administrator_account - # The AWS account ID that manages the repository. + # The Amazon Web Services account ID that manages the repository. # @return [String] # # @!attribute [rw] domain_name @@ -2955,8 +2800,8 @@ class RepositoryExternalConnectionInfo < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] arn @@ -2991,7 +2836,7 @@ class RepositorySummary < Struct.new( # @return [String] # # @!attribute [rw] resource_type - # The type of AWS resource. + # The type of Amazon Web Services resource. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/ResourceNotFoundException AWS API Documentation @@ -3004,8 +2849,8 @@ class ResourceNotFoundException < Struct.new( include Aws::Structure end - # An AWS CodeArtifact resource policy that contains a resource ARN, - # document details, and a revision. + # An CodeArtifact resource policy that contains a resource ARN, document + # details, and a revision. # # @!attribute [rw] resource_arn # The ARN of the resource associated with the resource policy @@ -3040,7 +2885,7 @@ class ResourcePolicy < Struct.new( # @return [String] # # @!attribute [rw] resource_type - # The type of AWS resource. + # The type of Amazon Web Services resource. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/ServiceQuotaExceededException AWS API Documentation @@ -3060,17 +2905,7 @@ class ServiceQuotaExceededException < Struct.new( # @return [String] # # @!attribute [rw] status - # The status of a package version. Valid statuses are: - # - # * `Published` - # - # * `Unfinished` - # - # * `Unlisted` - # - # * `Archived` - # - # * `Disposed` + # The status of a package version. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/SuccessfulPackageVersionInfo AWS API Documentation @@ -3083,7 +2918,7 @@ class SuccessfulPackageVersionInfo < Struct.new( end # A tag is a key-value pair that can be used to manage, search for, or - # filter resources in AWS CodeArtifact. + # filter resources in CodeArtifact. # # @note When making an API call, you may pass Tag # data as a hash: @@ -3218,8 +3053,8 @@ class UntagResourceResult < Aws::EmptyStructure; end # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] repository @@ -3229,13 +3064,7 @@ class UntagResourceResult < Aws::EmptyStructure; end # # @!attribute [rw] format # A format that specifies the type of the package with the statuses to - # update. The valid values are: - # - # * `npm` - # - # * `pypi` - # - # * `maven` + # update. # @return [String] # # @!attribute [rw] namespace @@ -3332,8 +3161,8 @@ class UpdatePackageVersionsStatusResult < Struct.new( # @return [String] # # @!attribute [rw] domain_owner - # The 12-digit account number of the AWS account that owns the domain. - # It does not include dashes or spaces. + # The 12-digit account number of the Amazon Web Services account that + # owns the domain. It does not include dashes or spaces. # @return [String] # # @!attribute [rw] repository @@ -3347,7 +3176,7 @@ class UpdatePackageVersionsStatusResult < Struct.new( # @!attribute [rw] upstreams # A list of upstream repositories to associate with the repository. # The order of the upstream repositories in the list determines their - # priority order when AWS CodeArtifact looks for a requested package + # priority order when CodeArtifact looks for a requested package # version. For more information, see [Working with upstream # repositories][1]. # diff --git a/gems/aws-sdk-connect/CHANGELOG.md b/gems/aws-sdk-connect/CHANGELOG.md index 2845556adf4..0a1cb0fa7c5 100644 --- a/gems/aws-sdk-connect/CHANGELOG.md +++ b/gems/aws-sdk-connect/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.72.0 (2022-06-02) +------------------ + +* Feature - This release adds the following features: 1) New APIs to manage (create, list, update) task template resources, 2) Updates to startTaskContact API to support task templates, and 3) new TransferContact API to programmatically transfer in-progress tasks via a contact flow. + 1.71.0 (2022-04-28) ------------------ diff --git a/gems/aws-sdk-connect/VERSION b/gems/aws-sdk-connect/VERSION index df484cbb1d9..0834888f558 100644 --- a/gems/aws-sdk-connect/VERSION +++ b/gems/aws-sdk-connect/VERSION @@ -1 +1 @@ -1.71.0 +1.72.0 diff --git a/gems/aws-sdk-connect/lib/aws-sdk-connect.rb b/gems/aws-sdk-connect/lib/aws-sdk-connect.rb index c9e363ff612..58c7d177902 100644 --- a/gems/aws-sdk-connect/lib/aws-sdk-connect.rb +++ b/gems/aws-sdk-connect/lib/aws-sdk-connect.rb @@ -48,6 +48,6 @@ # @!group service module Aws::Connect - GEM_VERSION = '1.71.0' + GEM_VERSION = '1.72.0' end diff --git a/gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb b/gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb index cda6d612173..675f724c9f6 100644 --- a/gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb +++ b/gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb @@ -1425,6 +1425,118 @@ def create_security_profile(params = {}, options = {}) req.send_request(options) end + # Creates a new task template in the specified Amazon Connect instance. + # + # @option params [required, String] :instance_id + # The identifier of the Amazon Connect instance. You can find the + # instanceId in the ARN of the instance. + # + # @option params [required, String] :name + # The name of the task template. + # + # @option params [String] :description + # The description of the task template. + # + # @option params [String] :contact_flow_id + # The identifier of the flow that runs by default when a task is created + # by referencing this template. + # + # @option params [Types::TaskTemplateConstraints] :constraints + # Constraints that are applicable to the fields listed. + # + # @option params [Types::TaskTemplateDefaults] :defaults + # The default values for fields when a task is created by referencing + # this template. + # + # @option params [String] :status + # Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to it. + # Tasks can only be created from `ACTIVE` templates. If a template is + # marked as `INACTIVE`, then a task that refers to this template cannot + # be created. + # + # @option params [required, Array] :fields + # Fields that are part of the template. + # + # @option params [String] :client_token + # A unique, case-sensitive identifier that you provide to ensure the + # idempotency of the request. + # + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option.** + # + # @return [Types::CreateTaskTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::CreateTaskTemplateResponse#id #id} => String + # * {Types::CreateTaskTemplateResponse#arn #arn} => String + # + # @example Request syntax with placeholder values + # + # resp = client.create_task_template({ + # instance_id: "InstanceId", # required + # name: "TaskTemplateName", # required + # description: "TaskTemplateDescription", + # contact_flow_id: "ContactFlowId", + # constraints: { + # required_fields: [ + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # }, + # ], + # read_only_fields: [ + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # }, + # ], + # invisible_fields: [ + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # }, + # ], + # }, + # defaults: { + # default_field_values: [ + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # default_value: "TaskTemplateFieldValue", + # }, + # ], + # }, + # status: "ACTIVE", # accepts ACTIVE, INACTIVE + # fields: [ # required + # { + # id: { # required + # name: "TaskTemplateFieldName", + # }, + # description: "TaskTemplateFieldDescription", + # type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL + # single_select_options: ["TaskTemplateSingleSelectOption"], + # }, + # ], + # client_token: "ClientToken", + # }) + # + # @example Response structure + # + # resp.id #=> String + # resp.arn #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateTaskTemplate AWS API Documentation + # + # @overload create_task_template(params = {}) + # @param [Hash] params ({}) + def create_task_template(params = {}, options = {}) + req = build_request(:create_task_template, params) + req.send_request(options) + end + # Creates a use case for an integration association. # # @option params [required, String] :instance_id @@ -1901,6 +2013,33 @@ def delete_security_profile(params = {}, options = {}) req.send_request(options) end + # Deletes the task template. + # + # @option params [required, String] :instance_id + # The identifier of the Amazon Connect instance. You can find the + # instanceId in the ARN of the instance. + # + # @option params [required, String] :task_template_id + # A unique identifier for the task template. + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.delete_task_template({ + # instance_id: "InstanceId", # required + # task_template_id: "TaskTemplateId", # required + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteTaskTemplate AWS API Documentation + # + # @overload delete_task_template(params = {}) + # @param [Hash] params ({}) + def delete_task_template(params = {}, options = {}) + req = build_request(:delete_task_template, params) + req.send_request(options) + end + # Deletes a use case from an integration association. # # @option params [required, String] :instance_id @@ -3679,6 +3818,82 @@ def get_metric_data(params = {}, options = {}) req.send_request(options) end + # Gets details about a specific task template in the specified Amazon + # Connect instance. + # + # @option params [required, String] :instance_id + # The identifier of the Amazon Connect instance. You can find the + # instanceId in the ARN of the instance. + # + # @option params [required, String] :task_template_id + # A unique identifier for the task template. + # + # @option params [String] :snapshot_version + # The system generated version of a task template that is associated + # with a task, when the task is created. + # + # @return [Types::GetTaskTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::GetTaskTemplateResponse#instance_id #instance_id} => String + # * {Types::GetTaskTemplateResponse#id #id} => String + # * {Types::GetTaskTemplateResponse#arn #arn} => String + # * {Types::GetTaskTemplateResponse#name #name} => String + # * {Types::GetTaskTemplateResponse#description #description} => String + # * {Types::GetTaskTemplateResponse#contact_flow_id #contact_flow_id} => String + # * {Types::GetTaskTemplateResponse#constraints #constraints} => Types::TaskTemplateConstraints + # * {Types::GetTaskTemplateResponse#defaults #defaults} => Types::TaskTemplateDefaults + # * {Types::GetTaskTemplateResponse#fields #fields} => Array<Types::TaskTemplateField> + # * {Types::GetTaskTemplateResponse#status #status} => String + # * {Types::GetTaskTemplateResponse#last_modified_time #last_modified_time} => Time + # * {Types::GetTaskTemplateResponse#created_time #created_time} => Time + # * {Types::GetTaskTemplateResponse#tags #tags} => Hash<String,String> + # + # @example Request syntax with placeholder values + # + # resp = client.get_task_template({ + # instance_id: "InstanceId", # required + # task_template_id: "TaskTemplateId", # required + # snapshot_version: "SnapshotVersion", + # }) + # + # @example Response structure + # + # resp.instance_id #=> String + # resp.id #=> String + # resp.arn #=> String + # resp.name #=> String + # resp.description #=> String + # resp.contact_flow_id #=> String + # resp.constraints.required_fields #=> Array + # resp.constraints.required_fields[0].id.name #=> String + # resp.constraints.read_only_fields #=> Array + # resp.constraints.read_only_fields[0].id.name #=> String + # resp.constraints.invisible_fields #=> Array + # resp.constraints.invisible_fields[0].id.name #=> String + # resp.defaults.default_field_values #=> Array + # resp.defaults.default_field_values[0].id.name #=> String + # resp.defaults.default_field_values[0].default_value #=> String + # resp.fields #=> Array + # resp.fields[0].id.name #=> String + # resp.fields[0].description #=> String + # resp.fields[0].type #=> String, one of "NAME", "DESCRIPTION", "SCHEDULED_TIME", "QUICK_CONNECT", "URL", "NUMBER", "TEXT", "TEXT_AREA", "DATE_TIME", "BOOLEAN", "SINGLE_SELECT", "EMAIL" + # resp.fields[0].single_select_options #=> Array + # resp.fields[0].single_select_options[0] #=> String + # resp.status #=> String, one of "ACTIVE", "INACTIVE" + # resp.last_modified_time #=> Time + # resp.created_time #=> Time + # resp.tags #=> Hash + # resp.tags["TagKey"] #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetTaskTemplate AWS API Documentation + # + # @overload get_task_template(params = {}) + # @param [Hash] params ({}) + def get_task_template(params = {}, options = {}) + req = build_request(:get_task_template, params) + req.send_request(options) + end + # This API is in preview release for Amazon Connect and is subject to # change. # @@ -3987,7 +4202,7 @@ def list_contact_flows(params = {}, options = {}) # resp = client.list_contact_references({ # instance_id: "InstanceId", # required # contact_id: "ContactId", # required - # reference_types: ["URL"], # required, accepts URL, ATTACHMENT + # reference_types: ["URL"], # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL # next_token: "NextToken", # }) # @@ -3999,6 +4214,14 @@ def list_contact_flows(params = {}, options = {}) # resp.reference_summary_list[0].attachment.name #=> String # resp.reference_summary_list[0].attachment.value #=> String # resp.reference_summary_list[0].attachment.status #=> String, one of "APPROVED", "REJECTED" + # resp.reference_summary_list[0].string.name #=> String + # resp.reference_summary_list[0].string.value #=> String + # resp.reference_summary_list[0].number.name #=> String + # resp.reference_summary_list[0].number.value #=> String + # resp.reference_summary_list[0].date.name #=> String + # resp.reference_summary_list[0].date.value #=> String + # resp.reference_summary_list[0].email.name #=> String + # resp.reference_summary_list[0].email.value #=> String # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactReferences AWS API Documentation @@ -5097,6 +5320,72 @@ def list_tags_for_resource(params = {}, options = {}) req.send_request(options) end + # Lists task templates for the specified Amazon Connect instance. + # + # @option params [required, String] :instance_id + # The identifier of the Amazon Connect instance. You can find the + # instanceId in the ARN of the instance. + # + # @option params [String] :next_token + # The token for the next set of results. Use the value returned in the + # previous response in the next request to retrieve the next set of + # results. + # + # It is not expected that you set this because the value returned in the + # previous response is always null. + # + # @option params [Integer] :max_results + # The maximum number of results to return per page. + # + # It is not expected that you set this. + # + # @option params [String] :status + # Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to it. + # Tasks can only be created from `ACTIVE` templates. If a template is + # marked as `INACTIVE`, then a task that refers to this template cannot + # be created. + # + # @option params [String] :name + # The name of the task template. + # + # @return [Types::ListTaskTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListTaskTemplatesResponse#task_templates #task_templates} => Array<Types::TaskTemplateMetadata> + # * {Types::ListTaskTemplatesResponse#next_token #next_token} => String + # + # 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_task_templates({ + # instance_id: "InstanceId", # required + # next_token: "NextToken", + # max_results: 1, + # status: "ACTIVE", # accepts ACTIVE, INACTIVE + # name: "TaskTemplateName", + # }) + # + # @example Response structure + # + # resp.task_templates #=> Array + # resp.task_templates[0].id #=> String + # resp.task_templates[0].arn #=> String + # resp.task_templates[0].name #=> String + # resp.task_templates[0].description #=> String + # resp.task_templates[0].status #=> String, one of "ACTIVE", "INACTIVE" + # resp.task_templates[0].last_modified_time #=> Time + # resp.task_templates[0].created_time #=> Time + # resp.next_token #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListTaskTemplates AWS API Documentation + # + # @overload list_task_templates(params = {}) + # @param [Hash] params ({}) + def list_task_templates(params = {}, options = {}) + req = build_request(:list_task_templates, params) + req.send_request(options) + end + # Lists the use cases for the integration association. # # @option params [required, String] :instance_id @@ -5965,7 +6254,7 @@ def start_outbound_voice_contact(params = {}, options = {}) # @option params [String] :previous_contact_id # The identifier of the previous chat, voice, or task contact. # - # @option params [required, String] :contact_flow_id + # @option params [String] :contact_flow_id # The identifier of the contact flow for initiating the tasks. To see # the ContactFlowId in the Amazon Connect console user interface, on the # navigation menu go to **Routing**, **Contact Flows**. Choose the @@ -6008,6 +6297,12 @@ def start_outbound_voice_contact(params = {}, options = {}) # the inbound contact flow. The scheduled time cannot be in the past. It # must be within up to 6 days in future. # + # @option params [String] :task_template_id + # A unique identifier for the task template. + # + # @option params [String] :quick_connect_id + # The identifier for the quick connect. + # # @return [Types::StartTaskContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::StartTaskContactResponse#contact_id #contact_id} => String @@ -6017,7 +6312,7 @@ def start_outbound_voice_contact(params = {}, options = {}) # resp = client.start_task_contact({ # instance_id: "InstanceId", # required # previous_contact_id: "ContactId", - # contact_flow_id: "ContactFlowId", # required + # contact_flow_id: "ContactFlowId", # attributes: { # "AttributeName" => "AttributeValue", # }, @@ -6025,12 +6320,14 @@ def start_outbound_voice_contact(params = {}, options = {}) # references: { # "ReferenceKey" => { # value: "ReferenceValue", # required - # type: "URL", # required, accepts URL, ATTACHMENT + # type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL # }, # }, # description: "Description", # client_token: "ClientToken", # scheduled_time: Time.now, + # task_template_id: "TaskTemplateId", + # quick_connect_id: "QuickConnectId", # }) # # @example Response structure @@ -6200,8 +6497,8 @@ def suspend_contact_recording(params = {}, options = {}) # Adds the specified tags to the specified resource. # # The supported resource types are users, routing profiles, queues, - # quick connects, contact flows, agent status, hours of operation, and - # phone number. + # quick connects, contact flows, agent status, hours of operation, phone + # number, security profiles, and task templates. # # For sample policies that use tags, see [Amazon Connect Identity-Based # Policy Examples][1] in the *Amazon Connect Administrator Guide*. @@ -6237,6 +6534,79 @@ def tag_resource(params = {}, options = {}) req.send_request(options) end + # Transfers contacts from one agent or queue to another agent or queue + # at any point after a contact is created. You can transfer a contact to + # another queue by providing the contact flow which orchestrates the + # contact to the destination queue. This gives you more control over + # contact handling and helps you adhere to the service level agreement + # (SLA) guaranteed to your customers. + # + # Note the following requirements: + # + # * Transfer is supported for only `TASK` contacts. + # + # * Do not use both `QueueId` and `UserId` in the same call. + # + # * The following contact flow types are supported: Inbound contact + # flow, Transfer to agent flow, and Transfer to queue flow. + # + # * The `TransferContact` API can be called only on active contacts. + # + # * A contact cannot be transferred more than 11 times. + # + # @option params [required, String] :instance_id + # The identifier of the Amazon Connect instance. You can find the + # instanceId in the ARN of the instance. + # + # @option params [required, String] :contact_id + # The identifier of the contact in this instance of Amazon Connect + # + # @option params [String] :queue_id + # The identifier for the queue. + # + # @option params [String] :user_id + # The identifier for the user. + # + # @option params [required, String] :contact_flow_id + # The identifier of the contact flow. + # + # @option params [String] :client_token + # A unique, case-sensitive identifier that you provide to ensure the + # idempotency of the request. + # + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option.** + # + # @return [Types::TransferContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::TransferContactResponse#contact_id #contact_id} => String + # * {Types::TransferContactResponse#contact_arn #contact_arn} => String + # + # @example Request syntax with placeholder values + # + # resp = client.transfer_contact({ + # instance_id: "InstanceId", # required + # contact_id: "ContactId", # required + # queue_id: "QueueId", + # user_id: "AgentResourceId", + # contact_flow_id: "ContactFlowId", # required + # client_token: "ClientToken", + # }) + # + # @example Response structure + # + # resp.contact_id #=> String + # resp.contact_arn #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TransferContact AWS API Documentation + # + # @overload transfer_contact(params = {}) + # @param [Hash] params ({}) + def transfer_contact(params = {}, options = {}) + req = build_request(:transfer_contact, params) + req.send_request(options) + end + # Removes the specified tags from the specified resource. # # @option params [required, String] :resource_arn @@ -6338,7 +6708,7 @@ def update_agent_status(params = {}, options = {}) # The description of the contact. # # @option params [Hash] :references - # A formatted URL that is shown to an agent in the Contact Control Panel + # Well-formed data on contact, shown to agents on Contact Control Panel # (CCP). # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. @@ -6353,7 +6723,7 @@ def update_agent_status(params = {}, options = {}) # references: { # "ReferenceKey" => { # value: "ReferenceValue", # required - # type: "URL", # required, accepts URL, ATTACHMENT + # type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL # }, # }, # }) @@ -7321,6 +7691,148 @@ def update_security_profile(params = {}, options = {}) req.send_request(options) end + # Updates details about a specific task template in the specified Amazon + # Connect instance. This operation does not support partial updates. + # Instead it does a full update of template content. + # + # @option params [required, String] :task_template_id + # A unique identifier for the task template. + # + # @option params [required, String] :instance_id + # The identifier of the Amazon Connect instance. You can find the + # instanceId in the ARN of the instance. + # + # @option params [String] :name + # The name of the task template. + # + # @option params [String] :description + # The description of the task template. + # + # @option params [String] :contact_flow_id + # The identifier of the flow that runs by default when a task is created + # by referencing this template. + # + # @option params [Types::TaskTemplateConstraints] :constraints + # Constraints that are applicable to the fields listed. + # + # @option params [Types::TaskTemplateDefaults] :defaults + # The default values for fields when a task is created by referencing + # this template. + # + # @option params [String] :status + # Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to it. + # Tasks can only be created from `ACTIVE` templates. If a template is + # marked as `INACTIVE`, then a task that refers to this template cannot + # be created. + # + # @option params [Array] :fields + # Fields that are part of the template. + # + # @return [Types::UpdateTaskTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::UpdateTaskTemplateResponse#instance_id #instance_id} => String + # * {Types::UpdateTaskTemplateResponse#id #id} => String + # * {Types::UpdateTaskTemplateResponse#arn #arn} => String + # * {Types::UpdateTaskTemplateResponse#name #name} => String + # * {Types::UpdateTaskTemplateResponse#description #description} => String + # * {Types::UpdateTaskTemplateResponse#contact_flow_id #contact_flow_id} => String + # * {Types::UpdateTaskTemplateResponse#constraints #constraints} => Types::TaskTemplateConstraints + # * {Types::UpdateTaskTemplateResponse#defaults #defaults} => Types::TaskTemplateDefaults + # * {Types::UpdateTaskTemplateResponse#fields #fields} => Array<Types::TaskTemplateField> + # * {Types::UpdateTaskTemplateResponse#status #status} => String + # * {Types::UpdateTaskTemplateResponse#last_modified_time #last_modified_time} => Time + # * {Types::UpdateTaskTemplateResponse#created_time #created_time} => Time + # + # @example Request syntax with placeholder values + # + # resp = client.update_task_template({ + # task_template_id: "TaskTemplateId", # required + # instance_id: "InstanceId", # required + # name: "TaskTemplateName", + # description: "TaskTemplateDescription", + # contact_flow_id: "ContactFlowId", + # constraints: { + # required_fields: [ + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # }, + # ], + # read_only_fields: [ + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # }, + # ], + # invisible_fields: [ + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # }, + # ], + # }, + # defaults: { + # default_field_values: [ + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # default_value: "TaskTemplateFieldValue", + # }, + # ], + # }, + # status: "ACTIVE", # accepts ACTIVE, INACTIVE + # fields: [ + # { + # id: { # required + # name: "TaskTemplateFieldName", + # }, + # description: "TaskTemplateFieldDescription", + # type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL + # single_select_options: ["TaskTemplateSingleSelectOption"], + # }, + # ], + # }) + # + # @example Response structure + # + # resp.instance_id #=> String + # resp.id #=> String + # resp.arn #=> String + # resp.name #=> String + # resp.description #=> String + # resp.contact_flow_id #=> String + # resp.constraints.required_fields #=> Array + # resp.constraints.required_fields[0].id.name #=> String + # resp.constraints.read_only_fields #=> Array + # resp.constraints.read_only_fields[0].id.name #=> String + # resp.constraints.invisible_fields #=> Array + # resp.constraints.invisible_fields[0].id.name #=> String + # resp.defaults.default_field_values #=> Array + # resp.defaults.default_field_values[0].id.name #=> String + # resp.defaults.default_field_values[0].default_value #=> String + # resp.fields #=> Array + # resp.fields[0].id.name #=> String + # resp.fields[0].description #=> String + # resp.fields[0].type #=> String, one of "NAME", "DESCRIPTION", "SCHEDULED_TIME", "QUICK_CONNECT", "URL", "NUMBER", "TEXT", "TEXT_AREA", "DATE_TIME", "BOOLEAN", "SINGLE_SELECT", "EMAIL" + # resp.fields[0].single_select_options #=> Array + # resp.fields[0].single_select_options[0] #=> String + # resp.status #=> String, one of "ACTIVE", "INACTIVE" + # resp.last_modified_time #=> Time + # resp.created_time #=> Time + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateTaskTemplate AWS API Documentation + # + # @overload update_task_template(params = {}) + # @param [Hash] params ({}) + def update_task_template(params = {}, options = {}) + req = build_request(:update_task_template, params) + req.send_request(options) + end + # Assigns the specified hierarchy group to the specified user. # # @option params [String] :hierarchy_group_id @@ -7585,7 +8097,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-connect' - context[:gem_version] = '1.71.0' + context[:gem_version] = '1.72.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-connect/lib/aws-sdk-connect/client_api.rb b/gems/aws-sdk-connect/lib/aws-sdk-connect/client_api.rb index b875004712f..ba6aa447290 100644 --- a/gems/aws-sdk-connect/lib/aws-sdk-connect/client_api.rb +++ b/gems/aws-sdk-connect/lib/aws-sdk-connect/client_api.rb @@ -122,6 +122,8 @@ module ClientApi CreateRoutingProfileResponse = Shapes::StructureShape.new(name: 'CreateRoutingProfileResponse') CreateSecurityProfileRequest = Shapes::StructureShape.new(name: 'CreateSecurityProfileRequest') CreateSecurityProfileResponse = Shapes::StructureShape.new(name: 'CreateSecurityProfileResponse') + CreateTaskTemplateRequest = Shapes::StructureShape.new(name: 'CreateTaskTemplateRequest') + CreateTaskTemplateResponse = Shapes::StructureShape.new(name: 'CreateTaskTemplateResponse') CreateUseCaseRequest = Shapes::StructureShape.new(name: 'CreateUseCaseRequest') CreateUseCaseResponse = Shapes::StructureShape.new(name: 'CreateUseCaseResponse') CreateUserHierarchyGroupRequest = Shapes::StructureShape.new(name: 'CreateUserHierarchyGroupRequest') @@ -138,6 +140,7 @@ module ClientApi CurrentMetricResult = Shapes::StructureShape.new(name: 'CurrentMetricResult') CurrentMetricResults = Shapes::ListShape.new(name: 'CurrentMetricResults') CurrentMetrics = Shapes::ListShape.new(name: 'CurrentMetrics') + DateReference = Shapes::StructureShape.new(name: 'DateReference') DefaultVocabulary = Shapes::StructureShape.new(name: 'DefaultVocabulary') DefaultVocabularyList = Shapes::ListShape.new(name: 'DefaultVocabularyList') Delay = Shapes::IntegerShape.new(name: 'Delay') @@ -149,6 +152,8 @@ module ClientApi DeleteIntegrationAssociationRequest = Shapes::StructureShape.new(name: 'DeleteIntegrationAssociationRequest') DeleteQuickConnectRequest = Shapes::StructureShape.new(name: 'DeleteQuickConnectRequest') DeleteSecurityProfileRequest = Shapes::StructureShape.new(name: 'DeleteSecurityProfileRequest') + DeleteTaskTemplateRequest = Shapes::StructureShape.new(name: 'DeleteTaskTemplateRequest') + DeleteTaskTemplateResponse = Shapes::StructureShape.new(name: 'DeleteTaskTemplateResponse') DeleteUseCaseRequest = Shapes::StructureShape.new(name: 'DeleteUseCaseRequest') DeleteUserHierarchyGroupRequest = Shapes::StructureShape.new(name: 'DeleteUserHierarchyGroupRequest') DeleteUserRequest = Shapes::StructureShape.new(name: 'DeleteUserRequest') @@ -207,6 +212,7 @@ module ClientApi DisplayName = Shapes::StringShape.new(name: 'DisplayName') DuplicateResourceException = Shapes::StructureShape.new(name: 'DuplicateResourceException') Email = Shapes::StringShape.new(name: 'Email') + EmailReference = Shapes::StructureShape.new(name: 'EmailReference') EncryptionConfig = Shapes::StructureShape.new(name: 'EncryptionConfig') EncryptionType = Shapes::StringShape.new(name: 'EncryptionType') Filters = Shapes::StructureShape.new(name: 'Filters') @@ -220,6 +226,8 @@ module ClientApi GetFederationTokenResponse = Shapes::StructureShape.new(name: 'GetFederationTokenResponse') GetMetricDataRequest = Shapes::StructureShape.new(name: 'GetMetricDataRequest') GetMetricDataResponse = Shapes::StructureShape.new(name: 'GetMetricDataResponse') + GetTaskTemplateRequest = Shapes::StructureShape.new(name: 'GetTaskTemplateRequest') + GetTaskTemplateResponse = Shapes::StructureShape.new(name: 'GetTaskTemplateResponse') Grouping = Shapes::StringShape.new(name: 'Grouping') Groupings = Shapes::ListShape.new(name: 'Groupings') HierarchyGroup = Shapes::StructureShape.new(name: 'HierarchyGroup') @@ -277,6 +285,8 @@ module ClientApi InvalidContactFlowModuleException = Shapes::StructureShape.new(name: 'InvalidContactFlowModuleException') InvalidParameterException = Shapes::StructureShape.new(name: 'InvalidParameterException') InvalidRequestException = Shapes::StructureShape.new(name: 'InvalidRequestException') + InvisibleFieldInfo = Shapes::StructureShape.new(name: 'InvisibleFieldInfo') + InvisibleTaskTemplateFields = Shapes::ListShape.new(name: 'InvisibleTaskTemplateFields') KeyId = Shapes::StringShape.new(name: 'KeyId') KinesisFirehoseConfig = Shapes::StructureShape.new(name: 'KinesisFirehoseConfig') KinesisStreamConfig = Shapes::StructureShape.new(name: 'KinesisStreamConfig') @@ -344,6 +354,8 @@ module ClientApi ListSecurityProfilesResponse = Shapes::StructureShape.new(name: 'ListSecurityProfilesResponse') ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest') ListTagsForResourceResponse = Shapes::StructureShape.new(name: 'ListTagsForResourceResponse') + ListTaskTemplatesRequest = Shapes::StructureShape.new(name: 'ListTaskTemplatesRequest') + ListTaskTemplatesResponse = Shapes::StructureShape.new(name: 'ListTaskTemplatesResponse') ListUseCasesRequest = Shapes::StructureShape.new(name: 'ListUseCasesRequest') ListUseCasesResponse = Shapes::StructureShape.new(name: 'ListUseCasesResponse') ListUserHierarchyGroupsRequest = Shapes::StructureShape.new(name: 'ListUserHierarchyGroupsRequest') @@ -363,6 +375,7 @@ module ClientApi Name = Shapes::StringShape.new(name: 'Name') NextToken = Shapes::StringShape.new(name: 'NextToken') NextToken2500 = Shapes::StringShape.new(name: 'NextToken2500') + NumberReference = Shapes::StructureShape.new(name: 'NumberReference') Origin = Shapes::StringShape.new(name: 'Origin') OriginsList = Shapes::ListShape.new(name: 'OriginsList') OutboundCallerConfig = Shapes::StructureShape.new(name: 'OutboundCallerConfig') @@ -399,6 +412,10 @@ module ClientApi PromptName = Shapes::StringShape.new(name: 'PromptName') PromptSummary = Shapes::StructureShape.new(name: 'PromptSummary') PromptSummaryList = Shapes::ListShape.new(name: 'PromptSummaryList') + PropertyValidationException = Shapes::StructureShape.new(name: 'PropertyValidationException') + PropertyValidationExceptionProperty = Shapes::StructureShape.new(name: 'PropertyValidationExceptionProperty') + PropertyValidationExceptionPropertyList = Shapes::ListShape.new(name: 'PropertyValidationExceptionPropertyList') + PropertyValidationExceptionReason = Shapes::StringShape.new(name: 'PropertyValidationExceptionReason') PutUserStatusRequest = Shapes::StructureShape.new(name: 'PutUserStatusRequest') PutUserStatusResponse = Shapes::StructureShape.new(name: 'PutUserStatusResponse') Queue = Shapes::StructureShape.new(name: 'Queue') @@ -425,6 +442,8 @@ module ClientApi QuickConnectType = Shapes::StringShape.new(name: 'QuickConnectType') QuickConnectTypes = Shapes::ListShape.new(name: 'QuickConnectTypes') QuickConnectsList = Shapes::ListShape.new(name: 'QuickConnectsList') + ReadOnlyFieldInfo = Shapes::StructureShape.new(name: 'ReadOnlyFieldInfo') + ReadOnlyTaskTemplateFields = Shapes::ListShape.new(name: 'ReadOnlyTaskTemplateFields') Reference = Shapes::StructureShape.new(name: 'Reference') ReferenceKey = Shapes::StringShape.new(name: 'ReferenceKey') ReferenceStatus = Shapes::StringShape.new(name: 'ReferenceStatus') @@ -434,6 +453,8 @@ module ClientApi ReferenceTypes = Shapes::ListShape.new(name: 'ReferenceTypes') ReferenceValue = Shapes::StringShape.new(name: 'ReferenceValue') ReleasePhoneNumberRequest = Shapes::StructureShape.new(name: 'ReleasePhoneNumberRequest') + RequiredFieldInfo = Shapes::StructureShape.new(name: 'RequiredFieldInfo') + RequiredTaskTemplateFields = Shapes::ListShape.new(name: 'RequiredTaskTemplateFields') ResourceConflictException = Shapes::StructureShape.new(name: 'ResourceConflictException') ResourceInUseException = Shapes::StructureShape.new(name: 'ResourceInUseException') ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException') @@ -471,6 +492,8 @@ module ClientApi SecurityProfileSummaryList = Shapes::ListShape.new(name: 'SecurityProfileSummaryList') SecurityToken = Shapes::StringShape.new(name: 'SecurityToken') ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException') + SingleSelectOptions = Shapes::ListShape.new(name: 'SingleSelectOptions') + SnapshotVersion = Shapes::StringShape.new(name: 'SnapshotVersion') SourceApplicationName = Shapes::StringShape.new(name: 'SourceApplicationName') SourceType = Shapes::StringShape.new(name: 'SourceType') StartChatContactRequest = Shapes::StructureShape.new(name: 'StartChatContactRequest') @@ -495,6 +518,7 @@ module ClientApi String = Shapes::StringShape.new(name: 'String') StringComparisonType = Shapes::StringShape.new(name: 'StringComparisonType') StringCondition = Shapes::StructureShape.new(name: 'StringCondition') + StringReference = Shapes::StructureShape.new(name: 'StringReference') SupportedMessagingContentType = Shapes::StringShape.new(name: 'SupportedMessagingContentType') SupportedMessagingContentTypes = Shapes::ListShape.new(name: 'SupportedMessagingContentTypes') SuspendContactRecordingRequest = Shapes::StructureShape.new(name: 'SuspendContactRecordingRequest') @@ -507,12 +531,33 @@ module ClientApi TagOrConditionList = Shapes::ListShape.new(name: 'TagOrConditionList') TagResourceRequest = Shapes::StructureShape.new(name: 'TagResourceRequest') TagValue = Shapes::StringShape.new(name: 'TagValue') + TaskTemplateArn = Shapes::StringShape.new(name: 'TaskTemplateArn') + TaskTemplateConstraints = Shapes::StructureShape.new(name: 'TaskTemplateConstraints') + TaskTemplateDefaultFieldValue = Shapes::StructureShape.new(name: 'TaskTemplateDefaultFieldValue') + TaskTemplateDefaultFieldValueList = Shapes::ListShape.new(name: 'TaskTemplateDefaultFieldValueList') + TaskTemplateDefaults = Shapes::StructureShape.new(name: 'TaskTemplateDefaults') + TaskTemplateDescription = Shapes::StringShape.new(name: 'TaskTemplateDescription') + TaskTemplateField = Shapes::StructureShape.new(name: 'TaskTemplateField') + TaskTemplateFieldDescription = Shapes::StringShape.new(name: 'TaskTemplateFieldDescription') + TaskTemplateFieldIdentifier = Shapes::StructureShape.new(name: 'TaskTemplateFieldIdentifier') + TaskTemplateFieldName = Shapes::StringShape.new(name: 'TaskTemplateFieldName') + TaskTemplateFieldType = Shapes::StringShape.new(name: 'TaskTemplateFieldType') + TaskTemplateFieldValue = Shapes::StringShape.new(name: 'TaskTemplateFieldValue') + TaskTemplateFields = Shapes::ListShape.new(name: 'TaskTemplateFields') + TaskTemplateId = Shapes::StringShape.new(name: 'TaskTemplateId') + TaskTemplateList = Shapes::ListShape.new(name: 'TaskTemplateList') + TaskTemplateMetadata = Shapes::StructureShape.new(name: 'TaskTemplateMetadata') + TaskTemplateName = Shapes::StringShape.new(name: 'TaskTemplateName') + TaskTemplateSingleSelectOption = Shapes::StringShape.new(name: 'TaskTemplateSingleSelectOption') + TaskTemplateStatus = Shapes::StringShape.new(name: 'TaskTemplateStatus') Threshold = Shapes::StructureShape.new(name: 'Threshold') ThresholdValue = Shapes::FloatShape.new(name: 'ThresholdValue') ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException') TimeZone = Shapes::StringShape.new(name: 'TimeZone') Timestamp = Shapes::TimestampShape.new(name: 'Timestamp') TrafficType = Shapes::StringShape.new(name: 'TrafficType') + TransferContactRequest = Shapes::StructureShape.new(name: 'TransferContactRequest') + TransferContactResponse = Shapes::StructureShape.new(name: 'TransferContactResponse') URI = Shapes::StringShape.new(name: 'URI') Unit = Shapes::StringShape.new(name: 'Unit') UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest') @@ -550,6 +595,8 @@ module ClientApi UpdateRoutingProfileNameRequest = Shapes::StructureShape.new(name: 'UpdateRoutingProfileNameRequest') UpdateRoutingProfileQueuesRequest = Shapes::StructureShape.new(name: 'UpdateRoutingProfileQueuesRequest') UpdateSecurityProfileRequest = Shapes::StructureShape.new(name: 'UpdateSecurityProfileRequest') + UpdateTaskTemplateRequest = Shapes::StructureShape.new(name: 'UpdateTaskTemplateRequest') + UpdateTaskTemplateResponse = Shapes::StructureShape.new(name: 'UpdateTaskTemplateResponse') UpdateUserHierarchyGroupNameRequest = Shapes::StructureShape.new(name: 'UpdateUserHierarchyGroupNameRequest') UpdateUserHierarchyRequest = Shapes::StructureShape.new(name: 'UpdateUserHierarchyRequest') UpdateUserHierarchyStructureRequest = Shapes::StructureShape.new(name: 'UpdateUserHierarchyStructureRequest') @@ -920,6 +967,21 @@ module ClientApi CreateSecurityProfileResponse.add_member(:security_profile_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "SecurityProfileArn")) CreateSecurityProfileResponse.struct_class = Types::CreateSecurityProfileResponse + CreateTaskTemplateRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId")) + CreateTaskTemplateRequest.add_member(:name, Shapes::ShapeRef.new(shape: TaskTemplateName, required: true, location_name: "Name")) + CreateTaskTemplateRequest.add_member(:description, Shapes::ShapeRef.new(shape: TaskTemplateDescription, location_name: "Description")) + CreateTaskTemplateRequest.add_member(:contact_flow_id, Shapes::ShapeRef.new(shape: ContactFlowId, location_name: "ContactFlowId")) + CreateTaskTemplateRequest.add_member(:constraints, Shapes::ShapeRef.new(shape: TaskTemplateConstraints, location_name: "Constraints")) + CreateTaskTemplateRequest.add_member(:defaults, Shapes::ShapeRef.new(shape: TaskTemplateDefaults, location_name: "Defaults")) + CreateTaskTemplateRequest.add_member(:status, Shapes::ShapeRef.new(shape: TaskTemplateStatus, location_name: "Status")) + CreateTaskTemplateRequest.add_member(:fields, Shapes::ShapeRef.new(shape: TaskTemplateFields, required: true, location_name: "Fields")) + CreateTaskTemplateRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true})) + CreateTaskTemplateRequest.struct_class = Types::CreateTaskTemplateRequest + + CreateTaskTemplateResponse.add_member(:id, Shapes::ShapeRef.new(shape: TaskTemplateId, required: true, location_name: "Id")) + CreateTaskTemplateResponse.add_member(:arn, Shapes::ShapeRef.new(shape: TaskTemplateArn, required: true, location_name: "Arn")) + CreateTaskTemplateResponse.struct_class = Types::CreateTaskTemplateResponse + CreateUseCaseRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId")) CreateUseCaseRequest.add_member(:integration_association_id, Shapes::ShapeRef.new(shape: IntegrationAssociationId, required: true, location: "uri", location_name: "IntegrationAssociationId")) CreateUseCaseRequest.add_member(:use_case_type, Shapes::ShapeRef.new(shape: UseCaseType, required: true, location_name: "UseCaseType")) @@ -993,6 +1055,10 @@ module ClientApi CurrentMetrics.member = Shapes::ShapeRef.new(shape: CurrentMetric) + DateReference.add_member(:name, Shapes::ShapeRef.new(shape: ReferenceKey, location_name: "Name")) + DateReference.add_member(:value, Shapes::ShapeRef.new(shape: ReferenceValue, location_name: "Value")) + DateReference.struct_class = Types::DateReference + DefaultVocabulary.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId")) DefaultVocabulary.add_member(:language_code, Shapes::ShapeRef.new(shape: VocabularyLanguageCode, required: true, location_name: "LanguageCode")) DefaultVocabulary.add_member(:vocabulary_id, Shapes::ShapeRef.new(shape: VocabularyId, required: true, location_name: "VocabularyId")) @@ -1030,6 +1096,12 @@ module ClientApi DeleteSecurityProfileRequest.add_member(:security_profile_id, Shapes::ShapeRef.new(shape: SecurityProfileId, required: true, location: "uri", location_name: "SecurityProfileId")) DeleteSecurityProfileRequest.struct_class = Types::DeleteSecurityProfileRequest + DeleteTaskTemplateRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId")) + DeleteTaskTemplateRequest.add_member(:task_template_id, Shapes::ShapeRef.new(shape: TaskTemplateId, required: true, location: "uri", location_name: "TaskTemplateId")) + DeleteTaskTemplateRequest.struct_class = Types::DeleteTaskTemplateRequest + + DeleteTaskTemplateResponse.struct_class = Types::DeleteTaskTemplateResponse + DeleteUseCaseRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId")) DeleteUseCaseRequest.add_member(:integration_association_id, Shapes::ShapeRef.new(shape: IntegrationAssociationId, required: true, location: "uri", location_name: "IntegrationAssociationId")) DeleteUseCaseRequest.add_member(:use_case_id, Shapes::ShapeRef.new(shape: UseCaseId, required: true, location: "uri", location_name: "UseCaseId")) @@ -1220,6 +1292,10 @@ module ClientApi DuplicateResourceException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message")) DuplicateResourceException.struct_class = Types::DuplicateResourceException + EmailReference.add_member(:name, Shapes::ShapeRef.new(shape: ReferenceKey, location_name: "Name")) + EmailReference.add_member(:value, Shapes::ShapeRef.new(shape: ReferenceValue, location_name: "Value")) + EmailReference.struct_class = Types::EmailReference + EncryptionConfig.add_member(:encryption_type, Shapes::ShapeRef.new(shape: EncryptionType, required: true, location_name: "EncryptionType")) EncryptionConfig.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyId, required: true, location_name: "KeyId")) EncryptionConfig.struct_class = Types::EncryptionConfig @@ -1270,6 +1346,26 @@ module ClientApi GetMetricDataResponse.add_member(:metric_results, Shapes::ShapeRef.new(shape: HistoricalMetricResults, location_name: "MetricResults")) GetMetricDataResponse.struct_class = Types::GetMetricDataResponse + GetTaskTemplateRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId")) + GetTaskTemplateRequest.add_member(:task_template_id, Shapes::ShapeRef.new(shape: TaskTemplateId, required: true, location: "uri", location_name: "TaskTemplateId")) + GetTaskTemplateRequest.add_member(:snapshot_version, Shapes::ShapeRef.new(shape: SnapshotVersion, location: "querystring", location_name: "snapshotVersion")) + GetTaskTemplateRequest.struct_class = Types::GetTaskTemplateRequest + + GetTaskTemplateResponse.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, location_name: "InstanceId")) + GetTaskTemplateResponse.add_member(:id, Shapes::ShapeRef.new(shape: TaskTemplateId, required: true, location_name: "Id")) + GetTaskTemplateResponse.add_member(:arn, Shapes::ShapeRef.new(shape: TaskTemplateArn, required: true, location_name: "Arn")) + GetTaskTemplateResponse.add_member(:name, Shapes::ShapeRef.new(shape: TaskTemplateName, required: true, location_name: "Name")) + GetTaskTemplateResponse.add_member(:description, Shapes::ShapeRef.new(shape: TaskTemplateDescription, location_name: "Description")) + GetTaskTemplateResponse.add_member(:contact_flow_id, Shapes::ShapeRef.new(shape: ContactFlowId, location_name: "ContactFlowId")) + GetTaskTemplateResponse.add_member(:constraints, Shapes::ShapeRef.new(shape: TaskTemplateConstraints, location_name: "Constraints")) + GetTaskTemplateResponse.add_member(:defaults, Shapes::ShapeRef.new(shape: TaskTemplateDefaults, location_name: "Defaults")) + GetTaskTemplateResponse.add_member(:fields, Shapes::ShapeRef.new(shape: TaskTemplateFields, location_name: "Fields")) + GetTaskTemplateResponse.add_member(:status, Shapes::ShapeRef.new(shape: TaskTemplateStatus, location_name: "Status")) + GetTaskTemplateResponse.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: timestamp, location_name: "LastModifiedTime")) + GetTaskTemplateResponse.add_member(:created_time, Shapes::ShapeRef.new(shape: timestamp, location_name: "CreatedTime")) + GetTaskTemplateResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags")) + GetTaskTemplateResponse.struct_class = Types::GetTaskTemplateResponse + Groupings.member = Shapes::ShapeRef.new(shape: Grouping) HierarchyGroup.add_member(:id, Shapes::ShapeRef.new(shape: HierarchyGroupId, location_name: "Id")) @@ -1435,6 +1531,11 @@ module ClientApi InvalidRequestException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message")) InvalidRequestException.struct_class = Types::InvalidRequestException + InvisibleFieldInfo.add_member(:id, Shapes::ShapeRef.new(shape: TaskTemplateFieldIdentifier, location_name: "Id")) + InvisibleFieldInfo.struct_class = Types::InvisibleFieldInfo + + InvisibleTaskTemplateFields.member = Shapes::ShapeRef.new(shape: InvisibleFieldInfo) + KinesisFirehoseConfig.add_member(:firehose_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "FirehoseArn")) KinesisFirehoseConfig.struct_class = Types::KinesisFirehoseConfig @@ -1722,6 +1823,17 @@ module ClientApi ListTagsForResourceResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags")) ListTagsForResourceResponse.struct_class = Types::ListTagsForResourceResponse + ListTaskTemplatesRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId")) + ListTaskTemplatesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken")) + ListTaskTemplatesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResult100, location: "querystring", location_name: "maxResults", metadata: {"box"=>true})) + ListTaskTemplatesRequest.add_member(:status, Shapes::ShapeRef.new(shape: TaskTemplateStatus, location: "querystring", location_name: "status")) + ListTaskTemplatesRequest.add_member(:name, Shapes::ShapeRef.new(shape: TaskTemplateName, location: "querystring", location_name: "name")) + ListTaskTemplatesRequest.struct_class = Types::ListTaskTemplatesRequest + + ListTaskTemplatesResponse.add_member(:task_templates, Shapes::ShapeRef.new(shape: TaskTemplateList, location_name: "TaskTemplates")) + ListTaskTemplatesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken")) + ListTaskTemplatesResponse.struct_class = Types::ListTaskTemplatesResponse + ListUseCasesRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId")) ListUseCasesRequest.add_member(:integration_association_id, Shapes::ShapeRef.new(shape: IntegrationAssociationId, required: true, location: "uri", location_name: "IntegrationAssociationId")) ListUseCasesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken")) @@ -1756,6 +1868,10 @@ module ClientApi MediaConcurrency.add_member(:concurrency, Shapes::ShapeRef.new(shape: Concurrency, required: true, location_name: "Concurrency")) MediaConcurrency.struct_class = Types::MediaConcurrency + NumberReference.add_member(:name, Shapes::ShapeRef.new(shape: ReferenceKey, location_name: "Name")) + NumberReference.add_member(:value, Shapes::ShapeRef.new(shape: ReferenceValue, location_name: "Value")) + NumberReference.struct_class = Types::NumberReference + OriginsList.member = Shapes::ShapeRef.new(shape: Origin) OutboundCallerConfig.add_member(:outbound_caller_id_name, Shapes::ShapeRef.new(shape: OutboundCallerIdName, location_name: "OutboundCallerIdName")) @@ -1803,6 +1919,17 @@ module ClientApi PromptSummaryList.member = Shapes::ShapeRef.new(shape: PromptSummary) + PropertyValidationException.add_member(:message, Shapes::ShapeRef.new(shape: Message, required: true, location_name: "Message")) + PropertyValidationException.add_member(:property_list, Shapes::ShapeRef.new(shape: PropertyValidationExceptionPropertyList, location_name: "PropertyList")) + PropertyValidationException.struct_class = Types::PropertyValidationException + + PropertyValidationExceptionProperty.add_member(:property_path, Shapes::ShapeRef.new(shape: String, required: true, location_name: "PropertyPath")) + PropertyValidationExceptionProperty.add_member(:reason, Shapes::ShapeRef.new(shape: PropertyValidationExceptionReason, required: true, location_name: "Reason")) + PropertyValidationExceptionProperty.add_member(:message, Shapes::ShapeRef.new(shape: Message, required: true, location_name: "Message")) + PropertyValidationExceptionProperty.struct_class = Types::PropertyValidationExceptionProperty + + PropertyValidationExceptionPropertyList.member = Shapes::ShapeRef.new(shape: PropertyValidationExceptionProperty) + PutUserStatusRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: UserId, required: true, location: "uri", location_name: "UserId")) PutUserStatusRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId")) PutUserStatusRequest.add_member(:agent_status_id, Shapes::ShapeRef.new(shape: AgentStatusId, required: true, location_name: "AgentStatusId")) @@ -1871,15 +1998,28 @@ module ClientApi QuickConnectsList.member = Shapes::ShapeRef.new(shape: QuickConnectId) + ReadOnlyFieldInfo.add_member(:id, Shapes::ShapeRef.new(shape: TaskTemplateFieldIdentifier, location_name: "Id")) + ReadOnlyFieldInfo.struct_class = Types::ReadOnlyFieldInfo + + ReadOnlyTaskTemplateFields.member = Shapes::ShapeRef.new(shape: ReadOnlyFieldInfo) + Reference.add_member(:value, Shapes::ShapeRef.new(shape: ReferenceValue, required: true, location_name: "Value")) Reference.add_member(:type, Shapes::ShapeRef.new(shape: ReferenceType, required: true, location_name: "Type")) Reference.struct_class = Types::Reference ReferenceSummary.add_member(:url, Shapes::ShapeRef.new(shape: UrlReference, location_name: "Url")) ReferenceSummary.add_member(:attachment, Shapes::ShapeRef.new(shape: AttachmentReference, location_name: "Attachment")) + ReferenceSummary.add_member(:string, Shapes::ShapeRef.new(shape: StringReference, location_name: "String")) + ReferenceSummary.add_member(:number, Shapes::ShapeRef.new(shape: NumberReference, location_name: "Number")) + ReferenceSummary.add_member(:date, Shapes::ShapeRef.new(shape: DateReference, location_name: "Date")) + ReferenceSummary.add_member(:email, Shapes::ShapeRef.new(shape: EmailReference, location_name: "Email")) ReferenceSummary.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown')) ReferenceSummary.add_member_subclass(:url, Types::ReferenceSummary::Url) ReferenceSummary.add_member_subclass(:attachment, Types::ReferenceSummary::Attachment) + ReferenceSummary.add_member_subclass(:string, Types::ReferenceSummary::String) + ReferenceSummary.add_member_subclass(:number, Types::ReferenceSummary::Number) + ReferenceSummary.add_member_subclass(:date, Types::ReferenceSummary::Date) + ReferenceSummary.add_member_subclass(:email, Types::ReferenceSummary::Email) ReferenceSummary.add_member_subclass(:unknown, Types::ReferenceSummary::Unknown) ReferenceSummary.struct_class = Types::ReferenceSummary @@ -1891,6 +2031,11 @@ module ClientApi ReleasePhoneNumberRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location: "querystring", location_name: "clientToken", metadata: {"idempotencyToken"=>true})) ReleasePhoneNumberRequest.struct_class = Types::ReleasePhoneNumberRequest + RequiredFieldInfo.add_member(:id, Shapes::ShapeRef.new(shape: TaskTemplateFieldIdentifier, location_name: "Id")) + RequiredFieldInfo.struct_class = Types::RequiredFieldInfo + + RequiredTaskTemplateFields.member = Shapes::ShapeRef.new(shape: RequiredFieldInfo) + ResourceConflictException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message")) ResourceConflictException.struct_class = Types::ResourceConflictException @@ -2017,6 +2162,8 @@ module ClientApi ServiceQuotaExceededException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message")) ServiceQuotaExceededException.struct_class = Types::ServiceQuotaExceededException + SingleSelectOptions.member = Shapes::ShapeRef.new(shape: TaskTemplateSingleSelectOption) + StartChatContactRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId")) StartChatContactRequest.add_member(:contact_flow_id, Shapes::ShapeRef.new(shape: ContactFlowId, required: true, location_name: "ContactFlowId")) StartChatContactRequest.add_member(:attributes, Shapes::ShapeRef.new(shape: Attributes, location_name: "Attributes")) @@ -2066,13 +2213,15 @@ module ClientApi StartTaskContactRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId")) StartTaskContactRequest.add_member(:previous_contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "PreviousContactId")) - StartTaskContactRequest.add_member(:contact_flow_id, Shapes::ShapeRef.new(shape: ContactFlowId, required: true, location_name: "ContactFlowId")) + StartTaskContactRequest.add_member(:contact_flow_id, Shapes::ShapeRef.new(shape: ContactFlowId, location_name: "ContactFlowId")) StartTaskContactRequest.add_member(:attributes, Shapes::ShapeRef.new(shape: Attributes, location_name: "Attributes")) StartTaskContactRequest.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "Name")) StartTaskContactRequest.add_member(:references, Shapes::ShapeRef.new(shape: ContactReferences, location_name: "References")) StartTaskContactRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description")) StartTaskContactRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true})) StartTaskContactRequest.add_member(:scheduled_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "ScheduledTime")) + StartTaskContactRequest.add_member(:task_template_id, Shapes::ShapeRef.new(shape: TaskTemplateId, location_name: "TaskTemplateId")) + StartTaskContactRequest.add_member(:quick_connect_id, Shapes::ShapeRef.new(shape: QuickConnectId, location_name: "QuickConnectId")) StartTaskContactRequest.struct_class = Types::StartTaskContactRequest StartTaskContactResponse.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "ContactId")) @@ -2103,6 +2252,10 @@ module ClientApi StringCondition.add_member(:comparison_type, Shapes::ShapeRef.new(shape: StringComparisonType, location_name: "ComparisonType")) StringCondition.struct_class = Types::StringCondition + StringReference.add_member(:name, Shapes::ShapeRef.new(shape: ReferenceKey, location_name: "Name")) + StringReference.add_member(:value, Shapes::ShapeRef.new(shape: ReferenceValue, location_name: "Value")) + StringReference.struct_class = Types::StringReference + SupportedMessagingContentTypes.member = Shapes::ShapeRef.new(shape: SupportedMessagingContentType) SuspendContactRecordingRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId")) @@ -2129,6 +2282,42 @@ module ClientApi TagResourceRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, required: true, location_name: "tags")) TagResourceRequest.struct_class = Types::TagResourceRequest + TaskTemplateConstraints.add_member(:required_fields, Shapes::ShapeRef.new(shape: RequiredTaskTemplateFields, location_name: "RequiredFields")) + TaskTemplateConstraints.add_member(:read_only_fields, Shapes::ShapeRef.new(shape: ReadOnlyTaskTemplateFields, location_name: "ReadOnlyFields")) + TaskTemplateConstraints.add_member(:invisible_fields, Shapes::ShapeRef.new(shape: InvisibleTaskTemplateFields, location_name: "InvisibleFields")) + TaskTemplateConstraints.struct_class = Types::TaskTemplateConstraints + + TaskTemplateDefaultFieldValue.add_member(:id, Shapes::ShapeRef.new(shape: TaskTemplateFieldIdentifier, location_name: "Id")) + TaskTemplateDefaultFieldValue.add_member(:default_value, Shapes::ShapeRef.new(shape: TaskTemplateFieldValue, location_name: "DefaultValue")) + TaskTemplateDefaultFieldValue.struct_class = Types::TaskTemplateDefaultFieldValue + + TaskTemplateDefaultFieldValueList.member = Shapes::ShapeRef.new(shape: TaskTemplateDefaultFieldValue) + + TaskTemplateDefaults.add_member(:default_field_values, Shapes::ShapeRef.new(shape: TaskTemplateDefaultFieldValueList, location_name: "DefaultFieldValues")) + TaskTemplateDefaults.struct_class = Types::TaskTemplateDefaults + + TaskTemplateField.add_member(:id, Shapes::ShapeRef.new(shape: TaskTemplateFieldIdentifier, required: true, location_name: "Id")) + TaskTemplateField.add_member(:description, Shapes::ShapeRef.new(shape: TaskTemplateFieldDescription, location_name: "Description")) + TaskTemplateField.add_member(:type, Shapes::ShapeRef.new(shape: TaskTemplateFieldType, location_name: "Type")) + TaskTemplateField.add_member(:single_select_options, Shapes::ShapeRef.new(shape: SingleSelectOptions, location_name: "SingleSelectOptions")) + TaskTemplateField.struct_class = Types::TaskTemplateField + + TaskTemplateFieldIdentifier.add_member(:name, Shapes::ShapeRef.new(shape: TaskTemplateFieldName, location_name: "Name")) + TaskTemplateFieldIdentifier.struct_class = Types::TaskTemplateFieldIdentifier + + TaskTemplateFields.member = Shapes::ShapeRef.new(shape: TaskTemplateField) + + TaskTemplateList.member = Shapes::ShapeRef.new(shape: TaskTemplateMetadata) + + TaskTemplateMetadata.add_member(:id, Shapes::ShapeRef.new(shape: TaskTemplateId, location_name: "Id")) + TaskTemplateMetadata.add_member(:arn, Shapes::ShapeRef.new(shape: TaskTemplateArn, location_name: "Arn")) + TaskTemplateMetadata.add_member(:name, Shapes::ShapeRef.new(shape: TaskTemplateName, location_name: "Name")) + TaskTemplateMetadata.add_member(:description, Shapes::ShapeRef.new(shape: TaskTemplateDescription, location_name: "Description")) + TaskTemplateMetadata.add_member(:status, Shapes::ShapeRef.new(shape: TaskTemplateStatus, location_name: "Status")) + TaskTemplateMetadata.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: timestamp, location_name: "LastModifiedTime")) + TaskTemplateMetadata.add_member(:created_time, Shapes::ShapeRef.new(shape: timestamp, location_name: "CreatedTime")) + TaskTemplateMetadata.struct_class = Types::TaskTemplateMetadata + Threshold.add_member(:comparison, Shapes::ShapeRef.new(shape: Comparison, location_name: "Comparison")) Threshold.add_member(:threshold_value, Shapes::ShapeRef.new(shape: ThresholdValue, location_name: "ThresholdValue", metadata: {"box"=>true})) Threshold.struct_class = Types::Threshold @@ -2136,6 +2325,18 @@ module ClientApi ThrottlingException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message")) ThrottlingException.struct_class = Types::ThrottlingException + TransferContactRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId")) + TransferContactRequest.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location_name: "ContactId")) + TransferContactRequest.add_member(:queue_id, Shapes::ShapeRef.new(shape: QueueId, location_name: "QueueId")) + TransferContactRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: AgentResourceId, location_name: "UserId")) + TransferContactRequest.add_member(:contact_flow_id, Shapes::ShapeRef.new(shape: ContactFlowId, required: true, location_name: "ContactFlowId")) + TransferContactRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true})) + TransferContactRequest.struct_class = Types::TransferContactRequest + + TransferContactResponse.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "ContactId")) + TransferContactResponse.add_member(:contact_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "ContactArn")) + TransferContactResponse.struct_class = Types::TransferContactResponse + UntagResourceRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location: "uri", location_name: "resourceArn")) UntagResourceRequest.add_member(:tag_keys, Shapes::ShapeRef.new(shape: TagKeyList, required: true, location: "querystring", location_name: "tagKeys")) UntagResourceRequest.struct_class = Types::UntagResourceRequest @@ -2298,6 +2499,31 @@ module ClientApi UpdateSecurityProfileRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId")) UpdateSecurityProfileRequest.struct_class = Types::UpdateSecurityProfileRequest + UpdateTaskTemplateRequest.add_member(:task_template_id, Shapes::ShapeRef.new(shape: TaskTemplateId, required: true, location: "uri", location_name: "TaskTemplateId")) + UpdateTaskTemplateRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId")) + UpdateTaskTemplateRequest.add_member(:name, Shapes::ShapeRef.new(shape: TaskTemplateName, location_name: "Name")) + UpdateTaskTemplateRequest.add_member(:description, Shapes::ShapeRef.new(shape: TaskTemplateDescription, location_name: "Description")) + UpdateTaskTemplateRequest.add_member(:contact_flow_id, Shapes::ShapeRef.new(shape: ContactFlowId, location_name: "ContactFlowId")) + UpdateTaskTemplateRequest.add_member(:constraints, Shapes::ShapeRef.new(shape: TaskTemplateConstraints, location_name: "Constraints")) + UpdateTaskTemplateRequest.add_member(:defaults, Shapes::ShapeRef.new(shape: TaskTemplateDefaults, location_name: "Defaults")) + UpdateTaskTemplateRequest.add_member(:status, Shapes::ShapeRef.new(shape: TaskTemplateStatus, location_name: "Status")) + UpdateTaskTemplateRequest.add_member(:fields, Shapes::ShapeRef.new(shape: TaskTemplateFields, location_name: "Fields")) + UpdateTaskTemplateRequest.struct_class = Types::UpdateTaskTemplateRequest + + UpdateTaskTemplateResponse.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, location_name: "InstanceId")) + UpdateTaskTemplateResponse.add_member(:id, Shapes::ShapeRef.new(shape: TaskTemplateId, location_name: "Id")) + UpdateTaskTemplateResponse.add_member(:arn, Shapes::ShapeRef.new(shape: TaskTemplateArn, location_name: "Arn")) + UpdateTaskTemplateResponse.add_member(:name, Shapes::ShapeRef.new(shape: TaskTemplateName, location_name: "Name")) + UpdateTaskTemplateResponse.add_member(:description, Shapes::ShapeRef.new(shape: TaskTemplateDescription, location_name: "Description")) + UpdateTaskTemplateResponse.add_member(:contact_flow_id, Shapes::ShapeRef.new(shape: ContactFlowId, location_name: "ContactFlowId")) + UpdateTaskTemplateResponse.add_member(:constraints, Shapes::ShapeRef.new(shape: TaskTemplateConstraints, location_name: "Constraints")) + UpdateTaskTemplateResponse.add_member(:defaults, Shapes::ShapeRef.new(shape: TaskTemplateDefaults, location_name: "Defaults")) + UpdateTaskTemplateResponse.add_member(:fields, Shapes::ShapeRef.new(shape: TaskTemplateFields, location_name: "Fields")) + UpdateTaskTemplateResponse.add_member(:status, Shapes::ShapeRef.new(shape: TaskTemplateStatus, location_name: "Status")) + UpdateTaskTemplateResponse.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: timestamp, location_name: "LastModifiedTime")) + UpdateTaskTemplateResponse.add_member(:created_time, Shapes::ShapeRef.new(shape: timestamp, location_name: "CreatedTime")) + UpdateTaskTemplateResponse.struct_class = Types::UpdateTaskTemplateResponse + UpdateUserHierarchyGroupNameRequest.add_member(:name, Shapes::ShapeRef.new(shape: HierarchyGroupName, required: true, location_name: "Name")) UpdateUserHierarchyGroupNameRequest.add_member(:hierarchy_group_id, Shapes::ShapeRef.new(shape: HierarchyGroupId, required: true, location: "uri", location_name: "HierarchyGroupId")) UpdateUserHierarchyGroupNameRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId")) @@ -2759,6 +2985,20 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: InternalServiceException) end) + api.add_operation(:create_task_template, Seahorse::Model::Operation.new.tap do |o| + o.name = "CreateTaskTemplate" + o.http_method = "PUT" + o.http_request_uri = "/instance/{InstanceId}/task/template" + o.input = Shapes::ShapeRef.new(shape: CreateTaskTemplateRequest) + o.output = Shapes::ShapeRef.new(shape: CreateTaskTemplateResponse) + o.errors << Shapes::ShapeRef.new(shape: PropertyValidationException) + o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException) + o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException) + o.errors << Shapes::ShapeRef.new(shape: InternalServiceException) + end) + api.add_operation(:create_use_case, Seahorse::Model::Operation.new.tap do |o| o.name = "CreateUseCase" o.http_method = "PUT" @@ -2909,6 +3149,19 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException) end) + api.add_operation(:delete_task_template, Seahorse::Model::Operation.new.tap do |o| + o.name = "DeleteTaskTemplate" + o.http_method = "DELETE" + o.http_request_uri = "/instance/{InstanceId}/task/template/{TaskTemplateId}" + o.input = Shapes::ShapeRef.new(shape: DeleteTaskTemplateRequest) + o.output = Shapes::ShapeRef.new(shape: DeleteTaskTemplateResponse) + o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException) + o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException) + o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: InternalServiceException) + end) + api.add_operation(:delete_use_case, Seahorse::Model::Operation.new.tap do |o| o.name = "DeleteUseCase" o.http_method = "DELETE" @@ -3362,6 +3615,19 @@ module ClientApi ) end) + api.add_operation(:get_task_template, Seahorse::Model::Operation.new.tap do |o| + o.name = "GetTaskTemplate" + o.http_method = "GET" + o.http_request_uri = "/instance/{InstanceId}/task/template/{TaskTemplateId}" + o.input = Shapes::ShapeRef.new(shape: GetTaskTemplateRequest) + o.output = Shapes::ShapeRef.new(shape: GetTaskTemplateResponse) + o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException) + o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException) + o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: InternalServiceException) + end) + api.add_operation(:list_agent_statuses, Seahorse::Model::Operation.new.tap do |o| o.name = "ListAgentStatuses" o.http_method = "GET" @@ -3844,6 +4110,25 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) end) + api.add_operation(:list_task_templates, Seahorse::Model::Operation.new.tap do |o| + o.name = "ListTaskTemplates" + o.http_method = "GET" + o.http_request_uri = "/instance/{InstanceId}/task/template" + o.input = Shapes::ShapeRef.new(shape: ListTaskTemplatesRequest) + o.output = Shapes::ShapeRef.new(shape: ListTaskTemplatesResponse) + o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException) + o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException) + o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: InternalServiceException) + o[:pager] = Aws::Pager.new( + limit_key: "max_results", + tokens: { + "next_token" => "next_token" + } + ) + end) + api.add_operation(:list_use_cases, Seahorse::Model::Operation.new.tap do |o| o.name = "ListUseCases" o.http_method = "GET" @@ -4122,6 +4407,21 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) end) + api.add_operation(:transfer_contact, Seahorse::Model::Operation.new.tap do |o| + o.name = "TransferContact" + o.http_method = "POST" + o.http_request_uri = "/contact/transfer" + o.input = Shapes::ShapeRef.new(shape: TransferContactRequest) + o.output = Shapes::ShapeRef.new(shape: TransferContactResponse) + o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException) + o.errors << Shapes::ShapeRef.new(shape: IdempotencyException) + o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) + o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: InternalServiceException) + end) + api.add_operation(:untag_resource, Seahorse::Model::Operation.new.tap do |o| o.name = "UntagResource" o.http_method = "DELETE" @@ -4473,6 +4773,20 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: InternalServiceException) end) + api.add_operation(:update_task_template, Seahorse::Model::Operation.new.tap do |o| + o.name = "UpdateTaskTemplate" + o.http_method = "POST" + o.http_request_uri = "/instance/{InstanceId}/task/template/{TaskTemplateId}" + o.input = Shapes::ShapeRef.new(shape: UpdateTaskTemplateRequest) + o.output = Shapes::ShapeRef.new(shape: UpdateTaskTemplateResponse) + o.errors << Shapes::ShapeRef.new(shape: PropertyValidationException) + o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException) + o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException) + o.errors << Shapes::ShapeRef.new(shape: InternalServiceException) + end) + api.add_operation(:update_user_hierarchy, Seahorse::Model::Operation.new.tap do |o| o.name = "UpdateUserHierarchy" o.http_method = "POST" diff --git a/gems/aws-sdk-connect/lib/aws-sdk-connect/errors.rb b/gems/aws-sdk-connect/lib/aws-sdk-connect/errors.rb index c2b403f49b3..7e18089be9d 100644 --- a/gems/aws-sdk-connect/lib/aws-sdk-connect/errors.rb +++ b/gems/aws-sdk-connect/lib/aws-sdk-connect/errors.rb @@ -40,6 +40,7 @@ module Aws::Connect # * {InvalidRequestException} # * {LimitExceededException} # * {OutboundContactNotPermittedException} + # * {PropertyValidationException} # * {ResourceConflictException} # * {ResourceInUseException} # * {ResourceNotFoundException} @@ -248,6 +249,26 @@ def message end end + class PropertyValidationException < ServiceError + + # @param [Seahorse::Client::RequestContext] context + # @param [String] message + # @param [Aws::Connect::Types::PropertyValidationException] data + def initialize(context, message, data = Aws::EmptyStructure.new) + super(context, message, data) + end + + # @return [String] + def message + @message || @data[:message] + end + + # @return [String] + def property_list + @data[:property_list] + end + end + class ResourceConflictException < ServiceError # @param [Seahorse::Client::RequestContext] context diff --git a/gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb b/gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb index 7e1eb918fd7..3966d6d4307 100644 --- a/gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb +++ b/gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb @@ -526,7 +526,7 @@ class AssociateSecurityKeyResponse < Struct.new( include Aws::Structure end - # Information about the attachment reference if the `referenceType` is + # Information about a reference when the `referenceType` is # `ATTACHMENT`. Otherwise, null. # # @!attribute [rw] name @@ -534,11 +534,11 @@ class AssociateSecurityKeyResponse < Struct.new( # @return [String] # # @!attribute [rw] value - # Contains the location path of the attachment reference. + # The location path of the attachment reference. # @return [String] # # @!attribute [rw] status - # Status of an attachment reference type. + # Status of the attachment reference type. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AttachmentReference AWS API Documentation @@ -1889,6 +1889,140 @@ class CreateSecurityProfileResponse < Struct.new( include Aws::Structure end + # @note When making an API call, you may pass CreateTaskTemplateRequest + # data as a hash: + # + # { + # instance_id: "InstanceId", # required + # name: "TaskTemplateName", # required + # description: "TaskTemplateDescription", + # contact_flow_id: "ContactFlowId", + # constraints: { + # required_fields: [ + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # }, + # ], + # read_only_fields: [ + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # }, + # ], + # invisible_fields: [ + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # }, + # ], + # }, + # defaults: { + # default_field_values: [ + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # default_value: "TaskTemplateFieldValue", + # }, + # ], + # }, + # status: "ACTIVE", # accepts ACTIVE, INACTIVE + # fields: [ # required + # { + # id: { # required + # name: "TaskTemplateFieldName", + # }, + # description: "TaskTemplateFieldDescription", + # type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL + # single_select_options: ["TaskTemplateSingleSelectOption"], + # }, + # ], + # client_token: "ClientToken", + # } + # + # @!attribute [rw] instance_id + # The identifier of the Amazon Connect instance. You can find the + # instanceId in the ARN of the instance. + # @return [String] + # + # @!attribute [rw] name + # The name of the task template. + # @return [String] + # + # @!attribute [rw] description + # The description of the task template. + # @return [String] + # + # @!attribute [rw] contact_flow_id + # The identifier of the flow that runs by default when a task is + # created by referencing this template. + # @return [String] + # + # @!attribute [rw] constraints + # Constraints that are applicable to the fields listed. + # @return [Types::TaskTemplateConstraints] + # + # @!attribute [rw] defaults + # The default values for fields when a task is created by referencing + # this template. + # @return [Types::TaskTemplateDefaults] + # + # @!attribute [rw] status + # Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to + # it. Tasks can only be created from `ACTIVE` templates. If a template + # is marked as `INACTIVE`, then a task that refers to this template + # cannot be created. + # @return [String] + # + # @!attribute [rw] fields + # Fields that are part of the template. + # @return [Array] + # + # @!attribute [rw] client_token + # A unique, case-sensitive identifier that you provide to ensure the + # idempotency of the request. + # + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateTaskTemplateRequest AWS API Documentation + # + class CreateTaskTemplateRequest < Struct.new( + :instance_id, + :name, + :description, + :contact_flow_id, + :constraints, + :defaults, + :status, + :fields, + :client_token) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] id + # The identifier of the task template resource. + # @return [String] + # + # @!attribute [rw] arn + # The Amazon Resource Name (ARN) for the task template resource. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateTaskTemplateResponse AWS API Documentation + # + class CreateTaskTemplateResponse < Struct.new( + :id, + :arn) + SENSITIVE = [] + include Aws::Structure + end + # @note When making an API call, you may pass CreateUseCaseRequest # data as a hash: # @@ -2326,6 +2460,26 @@ class CurrentMetricResult < Struct.new( include Aws::Structure end + # Information about a reference when the `referenceType` is `DATE`. + # Otherwise, null. + # + # @!attribute [rw] name + # Identifier of the date reference. + # @return [String] + # + # @!attribute [rw] value + # A valid date. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DateReference AWS API Documentation + # + class DateReference < Struct.new( + :name, + :value) + SENSITIVE = [] + include Aws::Structure + end + # Contains information about a default vocabulary. # # @!attribute [rw] instance_id @@ -2542,6 +2696,36 @@ class DeleteSecurityProfileRequest < Struct.new( include Aws::Structure end + # @note When making an API call, you may pass DeleteTaskTemplateRequest + # data as a hash: + # + # { + # instance_id: "InstanceId", # required + # task_template_id: "TaskTemplateId", # required + # } + # + # @!attribute [rw] instance_id + # The identifier of the Amazon Connect instance. You can find the + # instanceId in the ARN of the instance. + # @return [String] + # + # @!attribute [rw] task_template_id + # A unique identifier for the task template. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteTaskTemplateRequest AWS API Documentation + # + class DeleteTaskTemplateRequest < Struct.new( + :instance_id, + :task_template_id) + SENSITIVE = [] + include Aws::Structure + end + + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteTaskTemplateResponse AWS API Documentation + # + class DeleteTaskTemplateResponse < Aws::EmptyStructure; end + # @note When making an API call, you may pass DeleteUseCaseRequest # data as a hash: # @@ -3634,6 +3818,26 @@ class DuplicateResourceException < Struct.new( include Aws::Structure end + # Information about a reference when the `referenceType` is `EMAIL`. + # Otherwise, null. + # + # @!attribute [rw] name + # Identifier of the email reference. + # @return [String] + # + # @!attribute [rw] value + # A valid email address. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EmailReference AWS API Documentation + # + class EmailReference < Struct.new( + :name, + :value) + SENSITIVE = [] + include Aws::Structure + end + # The encryption configuration. # # @note When making an API call, you may pass EncryptionConfig @@ -4274,6 +4478,118 @@ class GetMetricDataResponse < Struct.new( include Aws::Structure end + # @note When making an API call, you may pass GetTaskTemplateRequest + # data as a hash: + # + # { + # instance_id: "InstanceId", # required + # task_template_id: "TaskTemplateId", # required + # snapshot_version: "SnapshotVersion", + # } + # + # @!attribute [rw] instance_id + # The identifier of the Amazon Connect instance. You can find the + # instanceId in the ARN of the instance. + # @return [String] + # + # @!attribute [rw] task_template_id + # A unique identifier for the task template. + # @return [String] + # + # @!attribute [rw] snapshot_version + # The system generated version of a task template that is associated + # with a task, when the task is created. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetTaskTemplateRequest AWS API Documentation + # + class GetTaskTemplateRequest < Struct.new( + :instance_id, + :task_template_id, + :snapshot_version) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] instance_id + # The identifier of the Amazon Connect instance. You can find the + # instanceId in the ARN of the instance. + # @return [String] + # + # @!attribute [rw] id + # A unique identifier for the task template. + # @return [String] + # + # @!attribute [rw] arn + # The Amazon Resource Name (ARN). + # @return [String] + # + # @!attribute [rw] name + # The name of the task template. + # @return [String] + # + # @!attribute [rw] description + # The description of the task template. + # @return [String] + # + # @!attribute [rw] contact_flow_id + # The identifier of the flow that runs by default when a task is + # created by referencing this template. + # @return [String] + # + # @!attribute [rw] constraints + # Constraints that are applicable to the fields listed. + # @return [Types::TaskTemplateConstraints] + # + # @!attribute [rw] defaults + # The default values for fields when a task is created by referencing + # this template. + # @return [Types::TaskTemplateDefaults] + # + # @!attribute [rw] fields + # Fields that are part of the template. + # @return [Array] + # + # @!attribute [rw] status + # Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to + # it. Tasks can only be created from `ACTIVE` templates. If a template + # is marked as `INACTIVE`, then a task that refers to this template + # cannot be created. + # @return [String] + # + # @!attribute [rw] last_modified_time + # The timestamp when the task template was last modified. + # @return [Time] + # + # @!attribute [rw] created_time + # The timestamp when the task template was created. + # @return [Time] + # + # @!attribute [rw] tags + # The tags used to organize, track, or control access for this + # resource. + # @return [Hash] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetTaskTemplateResponse AWS API Documentation + # + class GetTaskTemplateResponse < Struct.new( + :instance_id, + :id, + :arn, + :name, + :description, + :contact_flow_id, + :constraints, + :defaults, + :fields, + :status, + :last_modified_time, + :created_time, + :tags) + SENSITIVE = [] + include Aws::Structure + end + # Contains information about a hierarchy group. # # @!attribute [rw] id @@ -5088,6 +5404,29 @@ class InvalidRequestException < Struct.new( include Aws::Structure end + # A field that is invisible to an agent. + # + # @note When making an API call, you may pass InvisibleFieldInfo + # data as a hash: + # + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # } + # + # @!attribute [rw] id + # Identifier of the invisible field. + # @return [Types::TaskTemplateFieldIdentifier] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InvisibleFieldInfo AWS API Documentation + # + class InvisibleFieldInfo < Struct.new( + :id) + SENSITIVE = [] + include Aws::Structure + end + # Configuration information of a Kinesis Data Firehose delivery stream. # # @note When making an API call, you may pass KinesisFirehoseConfig @@ -5543,7 +5882,7 @@ class ListContactFlowsResponse < Struct.new( # { # instance_id: "InstanceId", # required # contact_id: "ContactId", # required - # reference_types: ["URL"], # required, accepts URL, ATTACHMENT + # reference_types: ["URL"], # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL # next_token: "NextToken", # } # @@ -6746,17 +7085,15 @@ class ListTagsForResourceResponse < Struct.new( include Aws::Structure end - # Provides summary information about the use cases for the specified - # integration association. - # - # @note When making an API call, you may pass ListUseCasesRequest + # @note When making an API call, you may pass ListTaskTemplatesRequest # data as a hash: # # { # instance_id: "InstanceId", # required - # integration_association_id: "IntegrationAssociationId", # required # next_token: "NextToken", # max_results: 1, + # status: "ACTIVE", # accepts ACTIVE, INACTIVE + # name: "TaskTemplateName", # } # # @!attribute [rw] instance_id @@ -6764,50 +7101,127 @@ class ListTagsForResourceResponse < Struct.new( # instanceId in the ARN of the instance. # @return [String] # - # @!attribute [rw] integration_association_id - # The identifier for the integration association. - # @return [String] - # # @!attribute [rw] next_token # The token for the next set of results. Use the value returned in the # previous response in the next request to retrieve the next set of # results. + # + # It is not expected that you set this because the value returned in + # the previous response is always null. # @return [String] # # @!attribute [rw] max_results # The maximum number of results to return per page. + # + # It is not expected that you set this. # @return [Integer] # - # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUseCasesRequest AWS API Documentation + # @!attribute [rw] status + # Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to + # it. Tasks can only be created from `ACTIVE` templates. If a template + # is marked as `INACTIVE`, then a task that refers to this template + # cannot be created. + # @return [String] # - class ListUseCasesRequest < Struct.new( + # @!attribute [rw] name + # The name of the task template. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListTaskTemplatesRequest AWS API Documentation + # + class ListTaskTemplatesRequest < Struct.new( :instance_id, - :integration_association_id, :next_token, - :max_results) + :max_results, + :status, + :name) SENSITIVE = [] include Aws::Structure end - # @!attribute [rw] use_case_summary_list - # The use cases. - # @return [Array] + # @!attribute [rw] task_templates + # Provides details about a list of task templates belonging to an + # instance. + # @return [Array] # # @!attribute [rw] next_token # If there are additional results, this is the token for the next set # of results. + # + # This is always returned as a null in the response. # @return [String] # - # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUseCasesResponse AWS API Documentation + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListTaskTemplatesResponse AWS API Documentation # - class ListUseCasesResponse < Struct.new( - :use_case_summary_list, + class ListTaskTemplatesResponse < Struct.new( + :task_templates, :next_token) SENSITIVE = [] include Aws::Structure end - # @note When making an API call, you may pass ListUserHierarchyGroupsRequest + # Provides summary information about the use cases for the specified + # integration association. + # + # @note When making an API call, you may pass ListUseCasesRequest + # data as a hash: + # + # { + # instance_id: "InstanceId", # required + # integration_association_id: "IntegrationAssociationId", # required + # next_token: "NextToken", + # max_results: 1, + # } + # + # @!attribute [rw] instance_id + # The identifier of the Amazon Connect instance. You can find the + # instanceId in the ARN of the instance. + # @return [String] + # + # @!attribute [rw] integration_association_id + # The identifier for the integration association. + # @return [String] + # + # @!attribute [rw] next_token + # The token for the next set of results. Use the value returned in the + # previous response in the next request to retrieve the next set of + # results. + # @return [String] + # + # @!attribute [rw] max_results + # The maximum number of results to return per page. + # @return [Integer] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUseCasesRequest AWS API Documentation + # + class ListUseCasesRequest < Struct.new( + :instance_id, + :integration_association_id, + :next_token, + :max_results) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] use_case_summary_list + # The use cases. + # @return [Array] + # + # @!attribute [rw] next_token + # If there are additional results, this is the token for the next set + # of results. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUseCasesResponse AWS API Documentation + # + class ListUseCasesResponse < Struct.new( + :use_case_summary_list, + :next_token) + SENSITIVE = [] + include Aws::Structure + end + + # @note When making an API call, you may pass ListUserHierarchyGroupsRequest # data as a hash: # # { @@ -6947,6 +7361,26 @@ class MediaConcurrency < Struct.new( include Aws::Structure end + # Information about a reference when the `referenceType` is `NUMBER`. + # Otherwise, null. + # + # @!attribute [rw] name + # Identifier of the number reference. + # @return [String] + # + # @!attribute [rw] value + # A valid number. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/NumberReference AWS API Documentation + # + class NumberReference < Struct.new( + :name, + :value) + SENSITIVE = [] + include Aws::Structure + end + # The outbound caller ID name, number, and outbound whisper flow. # # @note When making an API call, you may pass OutboundCallerConfig @@ -7128,6 +7562,45 @@ class PromptSummary < Struct.new( include Aws::Structure end + # @!attribute [rw] message + # @return [String] + # + # @!attribute [rw] property_list + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PropertyValidationException AWS API Documentation + # + class PropertyValidationException < Struct.new( + :message, + :property_list) + SENSITIVE = [] + include Aws::Structure + end + + # Contains information about why a property is not valid. + # + # @!attribute [rw] property_path + # The full property path. + # @return [String] + # + # @!attribute [rw] reason + # Why the property is not valid. + # @return [String] + # + # @!attribute [rw] message + # A message describing why the property is not valid. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PropertyValidationExceptionProperty AWS API Documentation + # + class PropertyValidationExceptionProperty < Struct.new( + :property_path, + :reason, + :message) + SENSITIVE = [] + include Aws::Structure + end + # @note When making an API call, you may pass PutUserStatusRequest # data as a hash: # @@ -7441,15 +7914,39 @@ class QuickConnectSummary < Struct.new( include Aws::Structure end - # A link that an agent selects to complete a given task. You can have up - # to 4,096 UTF-8 bytes across all references for a contact. + # Indicates a field that is read-only to an agent. + # + # @note When making an API call, you may pass ReadOnlyFieldInfo + # data as a hash: + # + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # } + # + # @!attribute [rw] id + # Identifier of the read-only field. + # @return [Types::TaskTemplateFieldIdentifier] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ReadOnlyFieldInfo AWS API Documentation + # + class ReadOnlyFieldInfo < Struct.new( + :id) + SENSITIVE = [] + include Aws::Structure + end + + # Well-formed data on a contact, used by agents to complete a contact + # request. You can have up to 4,096 UTF-8 bytes across all references + # for a contact. # # @note When making an API call, you may pass Reference # data as a hash: # # { # value: "ReferenceValue", # required - # type: "URL", # required, accepts URL, ATTACHMENT + # type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL # } # # @!attribute [rw] value @@ -7459,8 +7956,7 @@ class QuickConnectSummary < Struct.new( # @return [String] # # @!attribute [rw] type - # The type of the reference. Only `URL` type can be added or updated - # on a contact. + # The type of the reference. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Reference AWS API Documentation @@ -7479,20 +7975,44 @@ class Reference < Struct.new( # @note ReferenceSummary is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ReferenceSummary corresponding to the set member. # # @!attribute [rw] url - # Information about the URL reference if the `referenceType` is `URL`. + # Information about the reference when the `referenceType` is `URL`. # Otherwise, null. # @return [Types::UrlReference] # # @!attribute [rw] attachment - # Information about the attachment reference if the `referenceType` is + # Information about the reference when the `referenceType` is # `ATTACHMENT`. Otherwise, null. # @return [Types::AttachmentReference] # + # @!attribute [rw] string + # Information about a reference when the `referenceType` is `STRING`. + # Otherwise, null. + # @return [Types::StringReference] + # + # @!attribute [rw] number + # Information about a reference when the `referenceType` is `NUMBER`. + # Otherwise, null. + # @return [Types::NumberReference] + # + # @!attribute [rw] date + # Information about a reference when the `referenceType` is `DATE`. + # Otherwise, null. + # @return [Types::DateReference] + # + # @!attribute [rw] email + # Information about a reference when the `referenceType` is `EMAIL`. + # Otherwise, null. + # @return [Types::EmailReference] + # # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ReferenceSummary AWS API Documentation # class ReferenceSummary < Struct.new( :url, :attachment, + :string, + :number, + :date, + :email, :unknown) SENSITIVE = [] include Aws::Structure @@ -7500,6 +8020,10 @@ class ReferenceSummary < Struct.new( class Url < ReferenceSummary; end class Attachment < ReferenceSummary; end + class String < ReferenceSummary; end + class Number < ReferenceSummary; end + class Date < ReferenceSummary; end + class Email < ReferenceSummary; end class Unknown < ReferenceSummary; end end @@ -7532,6 +8056,29 @@ class ReleasePhoneNumberRequest < Struct.new( include Aws::Structure end + # Information about a required field. + # + # @note When making an API call, you may pass RequiredFieldInfo + # data as a hash: + # + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # } + # + # @!attribute [rw] id + # The unique identifier for the field. + # @return [Types::TaskTemplateFieldIdentifier] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RequiredFieldInfo AWS API Documentation + # + class RequiredFieldInfo < Struct.new( + :id) + SENSITIVE = [] + include Aws::Structure + end + # A resource already has that name. # # @!attribute [rw] message @@ -8567,7 +9114,7 @@ class StartOutboundVoiceContactResponse < Struct.new( # { # instance_id: "InstanceId", # required # previous_contact_id: "ContactId", - # contact_flow_id: "ContactFlowId", # required + # contact_flow_id: "ContactFlowId", # attributes: { # "AttributeName" => "AttributeValue", # }, @@ -8575,12 +9122,14 @@ class StartOutboundVoiceContactResponse < Struct.new( # references: { # "ReferenceKey" => { # value: "ReferenceValue", # required - # type: "URL", # required, accepts URL, ATTACHMENT + # type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL # }, # }, # description: "Description", # client_token: "ClientToken", # scheduled_time: Time.now, + # task_template_id: "TaskTemplateId", + # quick_connect_id: "QuickConnectId", # } # # @!attribute [rw] instance_id @@ -8642,6 +9191,14 @@ class StartOutboundVoiceContactResponse < Struct.new( # the past. It must be within up to 6 days in future. # @return [Time] # + # @!attribute [rw] task_template_id + # A unique identifier for the task template. + # @return [String] + # + # @!attribute [rw] quick_connect_id + # The identifier for the quick connect. + # @return [String] + # # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartTaskContactRequest AWS API Documentation # class StartTaskContactRequest < Struct.new( @@ -8653,7 +9210,9 @@ class StartTaskContactRequest < Struct.new( :references, :description, :client_token, - :scheduled_time) + :scheduled_time, + :task_template_id, + :quick_connect_id) SENSITIVE = [] include Aws::Structure end @@ -8810,6 +9369,26 @@ class StringCondition < Struct.new( include Aws::Structure end + # Information about a reference when the `referenceType` is `STRING`. + # Otherwise, null. + # + # @!attribute [rw] name + # Identifier of the string reference. + # @return [String] + # + # @!attribute [rw] value + # A valid string. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StringReference AWS API Documentation + # + class StringReference < Struct.new( + :name, + :value) + SENSITIVE = [] + include Aws::Structure + end + # @note When making an API call, you may pass SuspendContactRecordingRequest # data as a hash: # @@ -8903,6 +9482,223 @@ class TagResourceRequest < Struct.new( include Aws::Structure end + # Describes constraints that apply to the template fields. + # + # @note When making an API call, you may pass TaskTemplateConstraints + # data as a hash: + # + # { + # required_fields: [ + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # }, + # ], + # read_only_fields: [ + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # }, + # ], + # invisible_fields: [ + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # }, + # ], + # } + # + # @!attribute [rw] required_fields + # Lists the fields that are required to be filled by agents. + # @return [Array] + # + # @!attribute [rw] read_only_fields + # Lists the fields that are read-only to agents, and cannot be edited. + # @return [Array] + # + # @!attribute [rw] invisible_fields + # Lists the fields that are invisible to agents. + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TaskTemplateConstraints AWS API Documentation + # + class TaskTemplateConstraints < Struct.new( + :required_fields, + :read_only_fields, + :invisible_fields) + SENSITIVE = [] + include Aws::Structure + end + + # Describes a default field and its corresponding value. + # + # @note When making an API call, you may pass TaskTemplateDefaultFieldValue + # data as a hash: + # + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # default_value: "TaskTemplateFieldValue", + # } + # + # @!attribute [rw] id + # Identifier of a field. + # @return [Types::TaskTemplateFieldIdentifier] + # + # @!attribute [rw] default_value + # Default value for the field. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TaskTemplateDefaultFieldValue AWS API Documentation + # + class TaskTemplateDefaultFieldValue < Struct.new( + :id, + :default_value) + SENSITIVE = [] + include Aws::Structure + end + + # Describes default values for fields on a template. + # + # @note When making an API call, you may pass TaskTemplateDefaults + # data as a hash: + # + # { + # default_field_values: [ + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # default_value: "TaskTemplateFieldValue", + # }, + # ], + # } + # + # @!attribute [rw] default_field_values + # Default value for the field. + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TaskTemplateDefaults AWS API Documentation + # + class TaskTemplateDefaults < Struct.new( + :default_field_values) + SENSITIVE = [] + include Aws::Structure + end + + # Describes a single task template field. + # + # @note When making an API call, you may pass TaskTemplateField + # data as a hash: + # + # { + # id: { # required + # name: "TaskTemplateFieldName", + # }, + # description: "TaskTemplateFieldDescription", + # type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL + # single_select_options: ["TaskTemplateSingleSelectOption"], + # } + # + # @!attribute [rw] id + # The unique identifier for the field. + # @return [Types::TaskTemplateFieldIdentifier] + # + # @!attribute [rw] description + # The description of the field. + # @return [String] + # + # @!attribute [rw] type + # Indicates the type of field. + # @return [String] + # + # @!attribute [rw] single_select_options + # A list of options for a single select field. + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TaskTemplateField AWS API Documentation + # + class TaskTemplateField < Struct.new( + :id, + :description, + :type, + :single_select_options) + SENSITIVE = [] + include Aws::Structure + end + + # The identifier of the task template field. + # + # @note When making an API call, you may pass TaskTemplateFieldIdentifier + # data as a hash: + # + # { + # name: "TaskTemplateFieldName", + # } + # + # @!attribute [rw] name + # The name of the task template field. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TaskTemplateFieldIdentifier AWS API Documentation + # + class TaskTemplateFieldIdentifier < Struct.new( + :name) + SENSITIVE = [] + include Aws::Structure + end + + # Contains summary information about the task template. + # + # @!attribute [rw] id + # A unique identifier for the task template. + # @return [String] + # + # @!attribute [rw] arn + # The Amazon Resource Name (ARN) of the task template. + # @return [String] + # + # @!attribute [rw] name + # The name of the task template. + # @return [String] + # + # @!attribute [rw] description + # The description of the task template. + # @return [String] + # + # @!attribute [rw] status + # Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to + # it. Tasks can only be created from `ACTIVE` templates. If a template + # is marked as `INACTIVE`, then a task that refers to this template + # cannot be created. + # @return [String] + # + # @!attribute [rw] last_modified_time + # The timestamp when the task template was last modified. + # @return [Time] + # + # @!attribute [rw] created_time + # The timestamp when the task template was created. + # @return [Time] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TaskTemplateMetadata AWS API Documentation + # + class TaskTemplateMetadata < Struct.new( + :id, + :arn, + :name, + :description, + :status, + :last_modified_time, + :created_time) + SENSITIVE = [] + include Aws::Structure + end + # Contains information about the threshold for service level metrics. # # @note When making an API call, you may pass Threshold @@ -8944,6 +9740,77 @@ class ThrottlingException < Struct.new( include Aws::Structure end + # @note When making an API call, you may pass TransferContactRequest + # data as a hash: + # + # { + # instance_id: "InstanceId", # required + # contact_id: "ContactId", # required + # queue_id: "QueueId", + # user_id: "AgentResourceId", + # contact_flow_id: "ContactFlowId", # required + # client_token: "ClientToken", + # } + # + # @!attribute [rw] instance_id + # The identifier of the Amazon Connect instance. You can find the + # instanceId in the ARN of the instance. + # @return [String] + # + # @!attribute [rw] contact_id + # The identifier of the contact in this instance of Amazon Connect + # @return [String] + # + # @!attribute [rw] queue_id + # The identifier for the queue. + # @return [String] + # + # @!attribute [rw] user_id + # The identifier for the user. + # @return [String] + # + # @!attribute [rw] contact_flow_id + # The identifier of the contact flow. + # @return [String] + # + # @!attribute [rw] client_token + # A unique, case-sensitive identifier that you provide to ensure the + # idempotency of the request. + # + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TransferContactRequest AWS API Documentation + # + class TransferContactRequest < Struct.new( + :instance_id, + :contact_id, + :queue_id, + :user_id, + :contact_flow_id, + :client_token) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] contact_id + # The identifier of the contact in this instance of Amazon Connect + # @return [String] + # + # @!attribute [rw] contact_arn + # The Amazon Resource Name (ARN) of the contact. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TransferContactResponse AWS API Documentation + # + class TransferContactResponse < Struct.new( + :contact_id, + :contact_arn) + SENSITIVE = [] + include Aws::Structure + end + # @note When making an API call, you may pass UntagResourceRequest # data as a hash: # @@ -9282,7 +10149,7 @@ class UpdateContactFlowNameRequest < Struct.new( # references: { # "ReferenceKey" => { # value: "ReferenceValue", # required - # type: "URL", # required, accepts URL, ATTACHMENT + # type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL # }, # }, # } @@ -9306,7 +10173,7 @@ class UpdateContactFlowNameRequest < Struct.new( # @return [String] # # @!attribute [rw] references - # A formatted URL that is shown to an agent in the Contact Control + # Well-formed data on contact, shown to agents on Contact Control # Panel (CCP). # @return [Hash] # @@ -10026,6 +10893,192 @@ class UpdateSecurityProfileRequest < Struct.new( include Aws::Structure end + # @note When making an API call, you may pass UpdateTaskTemplateRequest + # data as a hash: + # + # { + # task_template_id: "TaskTemplateId", # required + # instance_id: "InstanceId", # required + # name: "TaskTemplateName", + # description: "TaskTemplateDescription", + # contact_flow_id: "ContactFlowId", + # constraints: { + # required_fields: [ + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # }, + # ], + # read_only_fields: [ + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # }, + # ], + # invisible_fields: [ + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # }, + # ], + # }, + # defaults: { + # default_field_values: [ + # { + # id: { + # name: "TaskTemplateFieldName", + # }, + # default_value: "TaskTemplateFieldValue", + # }, + # ], + # }, + # status: "ACTIVE", # accepts ACTIVE, INACTIVE + # fields: [ + # { + # id: { # required + # name: "TaskTemplateFieldName", + # }, + # description: "TaskTemplateFieldDescription", + # type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL + # single_select_options: ["TaskTemplateSingleSelectOption"], + # }, + # ], + # } + # + # @!attribute [rw] task_template_id + # A unique identifier for the task template. + # @return [String] + # + # @!attribute [rw] instance_id + # The identifier of the Amazon Connect instance. You can find the + # instanceId in the ARN of the instance. + # @return [String] + # + # @!attribute [rw] name + # The name of the task template. + # @return [String] + # + # @!attribute [rw] description + # The description of the task template. + # @return [String] + # + # @!attribute [rw] contact_flow_id + # The identifier of the flow that runs by default when a task is + # created by referencing this template. + # @return [String] + # + # @!attribute [rw] constraints + # Constraints that are applicable to the fields listed. + # @return [Types::TaskTemplateConstraints] + # + # @!attribute [rw] defaults + # The default values for fields when a task is created by referencing + # this template. + # @return [Types::TaskTemplateDefaults] + # + # @!attribute [rw] status + # Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to + # it. Tasks can only be created from `ACTIVE` templates. If a template + # is marked as `INACTIVE`, then a task that refers to this template + # cannot be created. + # @return [String] + # + # @!attribute [rw] fields + # Fields that are part of the template. + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateTaskTemplateRequest AWS API Documentation + # + class UpdateTaskTemplateRequest < Struct.new( + :task_template_id, + :instance_id, + :name, + :description, + :contact_flow_id, + :constraints, + :defaults, + :status, + :fields) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] instance_id + # The identifier of the Amazon Connect instance. You can find the + # instanceId in the ARN of the instance. + # @return [String] + # + # @!attribute [rw] id + # The identifier of the task template resource. + # @return [String] + # + # @!attribute [rw] arn + # The Amazon Resource Name (ARN) for the task template resource. + # @return [String] + # + # @!attribute [rw] name + # The name of the task template. + # @return [String] + # + # @!attribute [rw] description + # The description of the task template. + # @return [String] + # + # @!attribute [rw] contact_flow_id + # The identifier of the flow that runs by default when a task is + # created by referencing this template. + # @return [String] + # + # @!attribute [rw] constraints + # Constraints that are applicable to the fields listed. + # @return [Types::TaskTemplateConstraints] + # + # @!attribute [rw] defaults + # The default values for fields when a task is created by referencing + # this template. + # @return [Types::TaskTemplateDefaults] + # + # @!attribute [rw] fields + # Fields that are part of the template. + # @return [Array] + # + # @!attribute [rw] status + # Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to + # it. Tasks can only be created from `ACTIVE` templates. If a template + # is marked as `INACTIVE`, then a task that refers to this template + # cannot be created. + # @return [String] + # + # @!attribute [rw] last_modified_time + # The timestamp when the task template was last modified. + # @return [Time] + # + # @!attribute [rw] created_time + # The timestamp when the task template was created. + # @return [Time] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateTaskTemplateResponse AWS API Documentation + # + class UpdateTaskTemplateResponse < Struct.new( + :instance_id, + :id, + :arn, + :name, + :description, + :contact_flow_id, + :constraints, + :defaults, + :fields, + :status, + :last_modified_time, + :created_time) + SENSITIVE = [] + include Aws::Structure + end + # @note When making an API call, you may pass UpdateUserHierarchyGroupNameRequest # data as a hash: # diff --git a/gems/aws-sdk-kendra/CHANGELOG.md b/gems/aws-sdk-kendra/CHANGELOG.md index 72aec1ead4d..02c00b0c7aa 100644 --- a/gems/aws-sdk-kendra/CHANGELOG.md +++ b/gems/aws-sdk-kendra/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.52.0 (2022-06-02) +------------------ + +* Feature - Amazon Kendra now provides a data source connector for GitHub. For more information, see https://docs.aws.amazon.com/kendra/latest/dg/data-source-github.html + 1.51.0 (2022-05-12) ------------------ diff --git a/gems/aws-sdk-kendra/VERSION b/gems/aws-sdk-kendra/VERSION index ba0a719118c..a63cb35e6f0 100644 --- a/gems/aws-sdk-kendra/VERSION +++ b/gems/aws-sdk-kendra/VERSION @@ -1 +1 @@ -1.51.0 +1.52.0 diff --git a/gems/aws-sdk-kendra/lib/aws-sdk-kendra.rb b/gems/aws-sdk-kendra/lib/aws-sdk-kendra.rb index b618506b5e9..0aef5eab529 100644 --- a/gems/aws-sdk-kendra/lib/aws-sdk-kendra.rb +++ b/gems/aws-sdk-kendra/lib/aws-sdk-kendra.rb @@ -48,6 +48,6 @@ # @!group service module Aws::Kendra - GEM_VERSION = '1.51.0' + GEM_VERSION = '1.52.0' end diff --git a/gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb b/gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb index 409850d781d..0fd5579f156 100644 --- a/gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb +++ b/gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb @@ -925,7 +925,7 @@ def clear_query_suggestions(params = {}, options = {}) # resp = client.create_data_source({ # name: "DataSourceName", # required # index_id: "IndexId", # required - # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX, QUIP, JIRA + # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX, QUIP, JIRA, GITHUB # configuration: { # s3_configuration: { # bucket_name: "S3BucketName", # required @@ -1407,6 +1407,99 @@ def clear_query_suggestions(params = {}, options = {}) # security_group_ids: ["VpcSecurityGroupId"], # required # }, # }, + # git_hub_configuration: { + # saa_s_configuration: { + # organization_name: "OrganizationName", # required + # host_url: "Url", # required + # }, + # on_premise_configuration: { + # host_url: "Url", # required + # organization_name: "OrganizationName", # required + # ssl_certificate_s3_path: { # required + # bucket: "S3BucketName", # required + # key: "S3ObjectKey", # required + # }, + # }, + # type: "SAAS", # accepts SAAS, ON_PREMISE + # secret_arn: "SecretArn", # required + # use_change_log: false, + # git_hub_document_crawl_properties: { + # crawl_repository_documents: false, + # crawl_issue: false, + # crawl_issue_comment: false, + # crawl_issue_comment_attachment: false, + # crawl_pull_request: false, + # crawl_pull_request_comment: false, + # crawl_pull_request_comment_attachment: false, + # }, + # repository_filter: ["RepositoryName"], + # inclusion_folder_name_patterns: ["String"], + # inclusion_file_type_patterns: ["String"], + # inclusion_file_name_patterns: ["String"], + # exclusion_folder_name_patterns: ["String"], + # exclusion_file_type_patterns: ["String"], + # exclusion_file_name_patterns: ["String"], + # vpc_configuration: { + # subnet_ids: ["SubnetId"], # required + # security_group_ids: ["VpcSecurityGroupId"], # required + # }, + # git_hub_repository_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_commit_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_issue_document_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_issue_comment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_issue_attachment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_pull_request_comment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_pull_request_document_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_pull_request_document_attachment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # }, # }, # description: "Description", # schedule: "ScanSchedule", @@ -2274,7 +2367,7 @@ def delete_thesaurus(params = {}, options = {}) # resp.id #=> String # resp.index_id #=> String # resp.name #=> String - # resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX", "SLACK", "BOX", "QUIP", "JIRA" + # resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX", "SLACK", "BOX", "QUIP", "JIRA", "GITHUB" # resp.configuration.s3_configuration.bucket_name #=> String # resp.configuration.s3_configuration.inclusion_prefixes #=> Array # resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String @@ -2629,6 +2722,72 @@ def delete_thesaurus(params = {}, options = {}) # resp.configuration.jira_configuration.vpc_configuration.subnet_ids[0] #=> String # resp.configuration.jira_configuration.vpc_configuration.security_group_ids #=> Array # resp.configuration.jira_configuration.vpc_configuration.security_group_ids[0] #=> String + # resp.configuration.git_hub_configuration.saa_s_configuration.organization_name #=> String + # resp.configuration.git_hub_configuration.saa_s_configuration.host_url #=> String + # resp.configuration.git_hub_configuration.on_premise_configuration.host_url #=> String + # resp.configuration.git_hub_configuration.on_premise_configuration.organization_name #=> String + # resp.configuration.git_hub_configuration.on_premise_configuration.ssl_certificate_s3_path.bucket #=> String + # resp.configuration.git_hub_configuration.on_premise_configuration.ssl_certificate_s3_path.key #=> String + # resp.configuration.git_hub_configuration.type #=> String, one of "SAAS", "ON_PREMISE" + # resp.configuration.git_hub_configuration.secret_arn #=> String + # resp.configuration.git_hub_configuration.use_change_log #=> Boolean + # resp.configuration.git_hub_configuration.git_hub_document_crawl_properties.crawl_repository_documents #=> Boolean + # resp.configuration.git_hub_configuration.git_hub_document_crawl_properties.crawl_issue #=> Boolean + # resp.configuration.git_hub_configuration.git_hub_document_crawl_properties.crawl_issue_comment #=> Boolean + # resp.configuration.git_hub_configuration.git_hub_document_crawl_properties.crawl_issue_comment_attachment #=> Boolean + # resp.configuration.git_hub_configuration.git_hub_document_crawl_properties.crawl_pull_request #=> Boolean + # resp.configuration.git_hub_configuration.git_hub_document_crawl_properties.crawl_pull_request_comment #=> Boolean + # resp.configuration.git_hub_configuration.git_hub_document_crawl_properties.crawl_pull_request_comment_attachment #=> Boolean + # resp.configuration.git_hub_configuration.repository_filter #=> Array + # resp.configuration.git_hub_configuration.repository_filter[0] #=> String + # resp.configuration.git_hub_configuration.inclusion_folder_name_patterns #=> Array + # resp.configuration.git_hub_configuration.inclusion_folder_name_patterns[0] #=> String + # resp.configuration.git_hub_configuration.inclusion_file_type_patterns #=> Array + # resp.configuration.git_hub_configuration.inclusion_file_type_patterns[0] #=> String + # resp.configuration.git_hub_configuration.inclusion_file_name_patterns #=> Array + # resp.configuration.git_hub_configuration.inclusion_file_name_patterns[0] #=> String + # resp.configuration.git_hub_configuration.exclusion_folder_name_patterns #=> Array + # resp.configuration.git_hub_configuration.exclusion_folder_name_patterns[0] #=> String + # resp.configuration.git_hub_configuration.exclusion_file_type_patterns #=> Array + # resp.configuration.git_hub_configuration.exclusion_file_type_patterns[0] #=> String + # resp.configuration.git_hub_configuration.exclusion_file_name_patterns #=> Array + # resp.configuration.git_hub_configuration.exclusion_file_name_patterns[0] #=> String + # resp.configuration.git_hub_configuration.vpc_configuration.subnet_ids #=> Array + # resp.configuration.git_hub_configuration.vpc_configuration.subnet_ids[0] #=> String + # resp.configuration.git_hub_configuration.vpc_configuration.security_group_ids #=> Array + # resp.configuration.git_hub_configuration.vpc_configuration.security_group_ids[0] #=> String + # resp.configuration.git_hub_configuration.git_hub_repository_configuration_field_mappings #=> Array + # resp.configuration.git_hub_configuration.git_hub_repository_configuration_field_mappings[0].data_source_field_name #=> String + # resp.configuration.git_hub_configuration.git_hub_repository_configuration_field_mappings[0].date_field_format #=> String + # resp.configuration.git_hub_configuration.git_hub_repository_configuration_field_mappings[0].index_field_name #=> String + # resp.configuration.git_hub_configuration.git_hub_commit_configuration_field_mappings #=> Array + # resp.configuration.git_hub_configuration.git_hub_commit_configuration_field_mappings[0].data_source_field_name #=> String + # resp.configuration.git_hub_configuration.git_hub_commit_configuration_field_mappings[0].date_field_format #=> String + # resp.configuration.git_hub_configuration.git_hub_commit_configuration_field_mappings[0].index_field_name #=> String + # resp.configuration.git_hub_configuration.git_hub_issue_document_configuration_field_mappings #=> Array + # resp.configuration.git_hub_configuration.git_hub_issue_document_configuration_field_mappings[0].data_source_field_name #=> String + # resp.configuration.git_hub_configuration.git_hub_issue_document_configuration_field_mappings[0].date_field_format #=> String + # resp.configuration.git_hub_configuration.git_hub_issue_document_configuration_field_mappings[0].index_field_name #=> String + # resp.configuration.git_hub_configuration.git_hub_issue_comment_configuration_field_mappings #=> Array + # resp.configuration.git_hub_configuration.git_hub_issue_comment_configuration_field_mappings[0].data_source_field_name #=> String + # resp.configuration.git_hub_configuration.git_hub_issue_comment_configuration_field_mappings[0].date_field_format #=> String + # resp.configuration.git_hub_configuration.git_hub_issue_comment_configuration_field_mappings[0].index_field_name #=> String + # resp.configuration.git_hub_configuration.git_hub_issue_attachment_configuration_field_mappings #=> Array + # resp.configuration.git_hub_configuration.git_hub_issue_attachment_configuration_field_mappings[0].data_source_field_name #=> String + # resp.configuration.git_hub_configuration.git_hub_issue_attachment_configuration_field_mappings[0].date_field_format #=> String + # resp.configuration.git_hub_configuration.git_hub_issue_attachment_configuration_field_mappings[0].index_field_name #=> String + # resp.configuration.git_hub_configuration.git_hub_pull_request_comment_configuration_field_mappings #=> Array + # resp.configuration.git_hub_configuration.git_hub_pull_request_comment_configuration_field_mappings[0].data_source_field_name #=> String + # resp.configuration.git_hub_configuration.git_hub_pull_request_comment_configuration_field_mappings[0].date_field_format #=> String + # resp.configuration.git_hub_configuration.git_hub_pull_request_comment_configuration_field_mappings[0].index_field_name #=> String + # resp.configuration.git_hub_configuration.git_hub_pull_request_document_configuration_field_mappings #=> Array + # resp.configuration.git_hub_configuration.git_hub_pull_request_document_configuration_field_mappings[0].data_source_field_name #=> String + # resp.configuration.git_hub_configuration.git_hub_pull_request_document_configuration_field_mappings[0].date_field_format #=> String + # resp.configuration.git_hub_configuration.git_hub_pull_request_document_configuration_field_mappings[0].index_field_name #=> String + # resp.configuration.git_hub_configuration.git_hub_pull_request_document_attachment_configuration_field_mappings #=> Array + # resp.configuration.git_hub_configuration.git_hub_pull_request_document_attachment_configuration_field_mappings[0].data_source_field_name #=> String + # resp.configuration.git_hub_configuration.git_hub_pull_request_document_attachment_configuration_field_mappings[0].date_field_format #=> String + # resp.configuration.git_hub_configuration.git_hub_pull_request_document_attachment_configuration_field_mappings[0].index_field_name #=> String # resp.created_at #=> Time # resp.updated_at #=> Time # resp.description #=> String @@ -3463,7 +3622,7 @@ def list_data_source_sync_jobs(params = {}, options = {}) # resp.summary_items #=> Array # resp.summary_items[0].name #=> String # resp.summary_items[0].id #=> String - # resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX", "SLACK", "BOX", "QUIP", "JIRA" + # resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX", "SLACK", "BOX", "QUIP", "JIRA", "GITHUB" # resp.summary_items[0].created_at #=> Time # resp.summary_items[0].updated_at #=> Time # resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE" @@ -5101,6 +5260,99 @@ def untag_resource(params = {}, options = {}) # security_group_ids: ["VpcSecurityGroupId"], # required # }, # }, + # git_hub_configuration: { + # saa_s_configuration: { + # organization_name: "OrganizationName", # required + # host_url: "Url", # required + # }, + # on_premise_configuration: { + # host_url: "Url", # required + # organization_name: "OrganizationName", # required + # ssl_certificate_s3_path: { # required + # bucket: "S3BucketName", # required + # key: "S3ObjectKey", # required + # }, + # }, + # type: "SAAS", # accepts SAAS, ON_PREMISE + # secret_arn: "SecretArn", # required + # use_change_log: false, + # git_hub_document_crawl_properties: { + # crawl_repository_documents: false, + # crawl_issue: false, + # crawl_issue_comment: false, + # crawl_issue_comment_attachment: false, + # crawl_pull_request: false, + # crawl_pull_request_comment: false, + # crawl_pull_request_comment_attachment: false, + # }, + # repository_filter: ["RepositoryName"], + # inclusion_folder_name_patterns: ["String"], + # inclusion_file_type_patterns: ["String"], + # inclusion_file_name_patterns: ["String"], + # exclusion_folder_name_patterns: ["String"], + # exclusion_file_type_patterns: ["String"], + # exclusion_file_name_patterns: ["String"], + # vpc_configuration: { + # subnet_ids: ["SubnetId"], # required + # security_group_ids: ["VpcSecurityGroupId"], # required + # }, + # git_hub_repository_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_commit_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_issue_document_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_issue_comment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_issue_attachment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_pull_request_comment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_pull_request_document_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_pull_request_document_attachment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # }, # }, # description: "Description", # schedule: "ScanSchedule", @@ -5571,7 +5823,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-kendra' - context[:gem_version] = '1.51.0' + context[:gem_version] = '1.52.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-kendra/lib/aws-sdk-kendra/client_api.rb b/gems/aws-sdk-kendra/lib/aws-sdk-kendra/client_api.rb index 475baeda31e..9eda7da2deb 100644 --- a/gems/aws-sdk-kendra/lib/aws-sdk-kendra/client_api.rb +++ b/gems/aws-sdk-kendra/lib/aws-sdk-kendra/client_api.rb @@ -234,6 +234,8 @@ module ClientApi GetQuerySuggestionsResponse = Shapes::StructureShape.new(name: 'GetQuerySuggestionsResponse') GetSnapshotsRequest = Shapes::StructureShape.new(name: 'GetSnapshotsRequest') GetSnapshotsResponse = Shapes::StructureShape.new(name: 'GetSnapshotsResponse') + GitHubConfiguration = Shapes::StructureShape.new(name: 'GitHubConfiguration') + GitHubDocumentCrawlProperties = Shapes::StructureShape.new(name: 'GitHubDocumentCrawlProperties') GoogleDriveConfiguration = Shapes::StructureShape.new(name: 'GoogleDriveConfiguration') GroupAttributeField = Shapes::StringShape.new(name: 'GroupAttributeField') GroupId = Shapes::StringShape.new(name: 'GroupId') @@ -331,12 +333,14 @@ module ClientApi NameType = Shapes::StringShape.new(name: 'NameType') NextToken = Shapes::StringShape.new(name: 'NextToken') ObjectBoolean = Shapes::BooleanShape.new(name: 'ObjectBoolean') + OnPremiseConfiguration = Shapes::StructureShape.new(name: 'OnPremiseConfiguration') OneDriveConfiguration = Shapes::StructureShape.new(name: 'OneDriveConfiguration') OneDriveUser = Shapes::StringShape.new(name: 'OneDriveUser') OneDriveUserList = Shapes::ListShape.new(name: 'OneDriveUserList') OneDriveUsers = Shapes::StructureShape.new(name: 'OneDriveUsers') Order = Shapes::StringShape.new(name: 'Order') OrganizationId = Shapes::StringShape.new(name: 'OrganizationId') + OrganizationName = Shapes::StringShape.new(name: 'OrganizationName') Persona = Shapes::StringShape.new(name: 'Persona') PersonasSummary = Shapes::StructureShape.new(name: 'PersonasSummary') PersonasSummaryList = Shapes::ListShape.new(name: 'PersonasSummaryList') @@ -374,6 +378,8 @@ module ClientApi RelevanceFeedback = Shapes::StructureShape.new(name: 'RelevanceFeedback') RelevanceFeedbackList = Shapes::ListShape.new(name: 'RelevanceFeedbackList') RelevanceType = Shapes::StringShape.new(name: 'RelevanceType') + RepositoryName = Shapes::StringShape.new(name: 'RepositoryName') + RepositoryNames = Shapes::ListShape.new(name: 'RepositoryNames') ResourceAlreadyExistException = Shapes::StructureShape.new(name: 'ResourceAlreadyExistException') ResourceInUseException = Shapes::StructureShape.new(name: 'ResourceInUseException') ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException') @@ -384,6 +390,7 @@ module ClientApi S3DataSourceConfiguration = Shapes::StructureShape.new(name: 'S3DataSourceConfiguration') S3ObjectKey = Shapes::StringShape.new(name: 'S3ObjectKey') S3Path = Shapes::StructureShape.new(name: 'S3Path') + SaaSConfiguration = Shapes::StructureShape.new(name: 'SaaSConfiguration') SalesforceChatterFeedConfiguration = Shapes::StructureShape.new(name: 'SalesforceChatterFeedConfiguration') SalesforceChatterFeedIncludeFilterType = Shapes::StringShape.new(name: 'SalesforceChatterFeedIncludeFilterType') SalesforceChatterFeedIncludeFilterTypes = Shapes::ListShape.new(name: 'SalesforceChatterFeedIncludeFilterTypes') @@ -443,6 +450,7 @@ module ClientApi StopDataSourceSyncJobRequest = Shapes::StructureShape.new(name: 'StopDataSourceSyncJobRequest') StorageCapacityUnit = Shapes::IntegerShape.new(name: 'StorageCapacityUnit') String = Shapes::StringShape.new(name: 'String') + StringList = Shapes::ListShape.new(name: 'StringList') SubmitFeedbackRequest = Shapes::StructureShape.new(name: 'SubmitFeedbackRequest') SubnetId = Shapes::StringShape.new(name: 'SubnetId') SubnetIdList = Shapes::ListShape.new(name: 'SubnetIdList') @@ -477,6 +485,7 @@ module ClientApi Title = Shapes::StringShape.new(name: 'Title') Token = Shapes::StringShape.new(name: 'Token') TopDocumentAttributeValueCountPairsSize = Shapes::IntegerShape.new(name: 'TopDocumentAttributeValueCountPairsSize') + Type = Shapes::StringShape.new(name: 'Type') UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest') UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse') UpdateDataSourceRequest = Shapes::StructureShape.new(name: 'UpdateDataSourceRequest') @@ -839,6 +848,7 @@ module ClientApi DataSourceConfiguration.add_member(:box_configuration, Shapes::ShapeRef.new(shape: BoxConfiguration, location_name: "BoxConfiguration")) DataSourceConfiguration.add_member(:quip_configuration, Shapes::ShapeRef.new(shape: QuipConfiguration, location_name: "QuipConfiguration")) DataSourceConfiguration.add_member(:jira_configuration, Shapes::ShapeRef.new(shape: JiraConfiguration, location_name: "JiraConfiguration")) + DataSourceConfiguration.add_member(:git_hub_configuration, Shapes::ShapeRef.new(shape: GitHubConfiguration, location_name: "GitHubConfiguration")) DataSourceConfiguration.struct_class = Types::DataSourceConfiguration DataSourceGroup.add_member(:group_id, Shapes::ShapeRef.new(shape: PrincipalName, required: true, location_name: "GroupId")) @@ -1283,6 +1293,39 @@ module ClientApi GetSnapshotsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken")) GetSnapshotsResponse.struct_class = Types::GetSnapshotsResponse + GitHubConfiguration.add_member(:saa_s_configuration, Shapes::ShapeRef.new(shape: SaaSConfiguration, location_name: "SaaSConfiguration")) + GitHubConfiguration.add_member(:on_premise_configuration, Shapes::ShapeRef.new(shape: OnPremiseConfiguration, location_name: "OnPremiseConfiguration")) + GitHubConfiguration.add_member(:type, Shapes::ShapeRef.new(shape: Type, location_name: "Type")) + GitHubConfiguration.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, required: true, location_name: "SecretArn")) + GitHubConfiguration.add_member(:use_change_log, Shapes::ShapeRef.new(shape: Boolean, location_name: "UseChangeLog")) + GitHubConfiguration.add_member(:git_hub_document_crawl_properties, Shapes::ShapeRef.new(shape: GitHubDocumentCrawlProperties, location_name: "GitHubDocumentCrawlProperties")) + GitHubConfiguration.add_member(:repository_filter, Shapes::ShapeRef.new(shape: RepositoryNames, location_name: "RepositoryFilter")) + GitHubConfiguration.add_member(:inclusion_folder_name_patterns, Shapes::ShapeRef.new(shape: StringList, location_name: "InclusionFolderNamePatterns")) + GitHubConfiguration.add_member(:inclusion_file_type_patterns, Shapes::ShapeRef.new(shape: StringList, location_name: "InclusionFileTypePatterns")) + GitHubConfiguration.add_member(:inclusion_file_name_patterns, Shapes::ShapeRef.new(shape: StringList, location_name: "InclusionFileNamePatterns")) + GitHubConfiguration.add_member(:exclusion_folder_name_patterns, Shapes::ShapeRef.new(shape: StringList, location_name: "ExclusionFolderNamePatterns")) + GitHubConfiguration.add_member(:exclusion_file_type_patterns, Shapes::ShapeRef.new(shape: StringList, location_name: "ExclusionFileTypePatterns")) + GitHubConfiguration.add_member(:exclusion_file_name_patterns, Shapes::ShapeRef.new(shape: StringList, location_name: "ExclusionFileNamePatterns")) + GitHubConfiguration.add_member(:vpc_configuration, Shapes::ShapeRef.new(shape: DataSourceVpcConfiguration, location_name: "VpcConfiguration")) + GitHubConfiguration.add_member(:git_hub_repository_configuration_field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "GitHubRepositoryConfigurationFieldMappings")) + GitHubConfiguration.add_member(:git_hub_commit_configuration_field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "GitHubCommitConfigurationFieldMappings")) + GitHubConfiguration.add_member(:git_hub_issue_document_configuration_field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "GitHubIssueDocumentConfigurationFieldMappings")) + GitHubConfiguration.add_member(:git_hub_issue_comment_configuration_field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "GitHubIssueCommentConfigurationFieldMappings")) + GitHubConfiguration.add_member(:git_hub_issue_attachment_configuration_field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "GitHubIssueAttachmentConfigurationFieldMappings")) + GitHubConfiguration.add_member(:git_hub_pull_request_comment_configuration_field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "GitHubPullRequestCommentConfigurationFieldMappings")) + GitHubConfiguration.add_member(:git_hub_pull_request_document_configuration_field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "GitHubPullRequestDocumentConfigurationFieldMappings")) + GitHubConfiguration.add_member(:git_hub_pull_request_document_attachment_configuration_field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "GitHubPullRequestDocumentAttachmentConfigurationFieldMappings")) + GitHubConfiguration.struct_class = Types::GitHubConfiguration + + GitHubDocumentCrawlProperties.add_member(:crawl_repository_documents, Shapes::ShapeRef.new(shape: Boolean, location_name: "CrawlRepositoryDocuments")) + GitHubDocumentCrawlProperties.add_member(:crawl_issue, Shapes::ShapeRef.new(shape: Boolean, location_name: "CrawlIssue")) + GitHubDocumentCrawlProperties.add_member(:crawl_issue_comment, Shapes::ShapeRef.new(shape: Boolean, location_name: "CrawlIssueComment")) + GitHubDocumentCrawlProperties.add_member(:crawl_issue_comment_attachment, Shapes::ShapeRef.new(shape: Boolean, location_name: "CrawlIssueCommentAttachment")) + GitHubDocumentCrawlProperties.add_member(:crawl_pull_request, Shapes::ShapeRef.new(shape: Boolean, location_name: "CrawlPullRequest")) + GitHubDocumentCrawlProperties.add_member(:crawl_pull_request_comment, Shapes::ShapeRef.new(shape: Boolean, location_name: "CrawlPullRequestComment")) + GitHubDocumentCrawlProperties.add_member(:crawl_pull_request_comment_attachment, Shapes::ShapeRef.new(shape: Boolean, location_name: "CrawlPullRequestCommentAttachment")) + GitHubDocumentCrawlProperties.struct_class = Types::GitHubDocumentCrawlProperties + GoogleDriveConfiguration.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, required: true, location_name: "SecretArn")) GoogleDriveConfiguration.add_member(:inclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "InclusionPatterns")) GoogleDriveConfiguration.add_member(:exclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "ExclusionPatterns")) @@ -1507,6 +1550,11 @@ module ClientApi MemberUsers.member = Shapes::ShapeRef.new(shape: MemberUser) + OnPremiseConfiguration.add_member(:host_url, Shapes::ShapeRef.new(shape: Url, required: true, location_name: "HostUrl")) + OnPremiseConfiguration.add_member(:organization_name, Shapes::ShapeRef.new(shape: OrganizationName, required: true, location_name: "OrganizationName")) + OnPremiseConfiguration.add_member(:ssl_certificate_s3_path, Shapes::ShapeRef.new(shape: S3Path, required: true, location_name: "SslCertificateS3Path")) + OnPremiseConfiguration.struct_class = Types::OnPremiseConfiguration + OneDriveConfiguration.add_member(:tenant_domain, Shapes::ShapeRef.new(shape: TenantDomain, required: true, location_name: "TenantDomain")) OneDriveConfiguration.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, required: true, location_name: "SecretArn")) OneDriveConfiguration.add_member(:one_drive_users, Shapes::ShapeRef.new(shape: OneDriveUsers, required: true, location_name: "OneDriveUsers")) @@ -1631,6 +1679,8 @@ module ClientApi RelevanceFeedbackList.member = Shapes::ShapeRef.new(shape: RelevanceFeedback) + RepositoryNames.member = Shapes::ShapeRef.new(shape: RepositoryName) + ResourceAlreadyExistException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message")) ResourceAlreadyExistException.struct_class = Types::ResourceAlreadyExistException @@ -1655,6 +1705,10 @@ module ClientApi S3Path.add_member(:key, Shapes::ShapeRef.new(shape: S3ObjectKey, required: true, location_name: "Key")) S3Path.struct_class = Types::S3Path + SaaSConfiguration.add_member(:organization_name, Shapes::ShapeRef.new(shape: OrganizationName, required: true, location_name: "OrganizationName")) + SaaSConfiguration.add_member(:host_url, Shapes::ShapeRef.new(shape: Url, required: true, location_name: "HostUrl")) + SaaSConfiguration.struct_class = Types::SaaSConfiguration + SalesforceChatterFeedConfiguration.add_member(:document_data_field_name, Shapes::ShapeRef.new(shape: DataSourceFieldName, required: true, location_name: "DocumentDataFieldName")) SalesforceChatterFeedConfiguration.add_member(:document_title_field_name, Shapes::ShapeRef.new(shape: DataSourceFieldName, location_name: "DocumentTitleFieldName")) SalesforceChatterFeedConfiguration.add_member(:field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "FieldMappings")) @@ -1832,6 +1886,8 @@ module ClientApi StopDataSourceSyncJobRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId")) StopDataSourceSyncJobRequest.struct_class = Types::StopDataSourceSyncJobRequest + StringList.member = Shapes::ShapeRef.new(shape: String) + SubmitFeedbackRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId")) SubmitFeedbackRequest.add_member(:query_id, Shapes::ShapeRef.new(shape: QueryId, required: true, location_name: "QueryId")) SubmitFeedbackRequest.add_member(:click_feedback_items, Shapes::ShapeRef.new(shape: ClickFeedbackList, location_name: "ClickFeedbackItems")) diff --git a/gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb b/gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb index f5123851d0e..77a1950d80f 100644 --- a/gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb +++ b/gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb @@ -2112,7 +2112,7 @@ class Correction < Struct.new( # { # name: "DataSourceName", # required # index_id: "IndexId", # required - # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX, QUIP, JIRA + # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX, QUIP, JIRA, GITHUB # configuration: { # s3_configuration: { # bucket_name: "S3BucketName", # required @@ -2594,6 +2594,99 @@ class Correction < Struct.new( # security_group_ids: ["VpcSecurityGroupId"], # required # }, # }, + # git_hub_configuration: { + # saa_s_configuration: { + # organization_name: "OrganizationName", # required + # host_url: "Url", # required + # }, + # on_premise_configuration: { + # host_url: "Url", # required + # organization_name: "OrganizationName", # required + # ssl_certificate_s3_path: { # required + # bucket: "S3BucketName", # required + # key: "S3ObjectKey", # required + # }, + # }, + # type: "SAAS", # accepts SAAS, ON_PREMISE + # secret_arn: "SecretArn", # required + # use_change_log: false, + # git_hub_document_crawl_properties: { + # crawl_repository_documents: false, + # crawl_issue: false, + # crawl_issue_comment: false, + # crawl_issue_comment_attachment: false, + # crawl_pull_request: false, + # crawl_pull_request_comment: false, + # crawl_pull_request_comment_attachment: false, + # }, + # repository_filter: ["RepositoryName"], + # inclusion_folder_name_patterns: ["String"], + # inclusion_file_type_patterns: ["String"], + # inclusion_file_name_patterns: ["String"], + # exclusion_folder_name_patterns: ["String"], + # exclusion_file_type_patterns: ["String"], + # exclusion_file_name_patterns: ["String"], + # vpc_configuration: { + # subnet_ids: ["SubnetId"], # required + # security_group_ids: ["VpcSecurityGroupId"], # required + # }, + # git_hub_repository_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_commit_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_issue_document_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_issue_comment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_issue_attachment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_pull_request_comment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_pull_request_document_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_pull_request_document_attachment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # }, # }, # description: "Description", # schedule: "ScanSchedule", @@ -3950,6 +4043,99 @@ class CustomDocumentEnrichmentConfiguration < Struct.new( # security_group_ids: ["VpcSecurityGroupId"], # required # }, # }, + # git_hub_configuration: { + # saa_s_configuration: { + # organization_name: "OrganizationName", # required + # host_url: "Url", # required + # }, + # on_premise_configuration: { + # host_url: "Url", # required + # organization_name: "OrganizationName", # required + # ssl_certificate_s3_path: { # required + # bucket: "S3BucketName", # required + # key: "S3ObjectKey", # required + # }, + # }, + # type: "SAAS", # accepts SAAS, ON_PREMISE + # secret_arn: "SecretArn", # required + # use_change_log: false, + # git_hub_document_crawl_properties: { + # crawl_repository_documents: false, + # crawl_issue: false, + # crawl_issue_comment: false, + # crawl_issue_comment_attachment: false, + # crawl_pull_request: false, + # crawl_pull_request_comment: false, + # crawl_pull_request_comment_attachment: false, + # }, + # repository_filter: ["RepositoryName"], + # inclusion_folder_name_patterns: ["String"], + # inclusion_file_type_patterns: ["String"], + # inclusion_file_name_patterns: ["String"], + # exclusion_folder_name_patterns: ["String"], + # exclusion_file_type_patterns: ["String"], + # exclusion_file_name_patterns: ["String"], + # vpc_configuration: { + # subnet_ids: ["SubnetId"], # required + # security_group_ids: ["VpcSecurityGroupId"], # required + # }, + # git_hub_repository_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_commit_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_issue_document_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_issue_comment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_issue_attachment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_pull_request_comment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_pull_request_document_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_pull_request_document_attachment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # }, # } # # @!attribute [rw] s3_configuration @@ -4027,6 +4213,11 @@ class CustomDocumentEnrichmentConfiguration < Struct.new( # data source. # @return [Types::JiraConfiguration] # + # @!attribute [rw] git_hub_configuration + # Provides the configuration information to connect to GitHub as your + # data source. + # @return [Types::GitHubConfiguration] + # # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation # class DataSourceConfiguration < Struct.new( @@ -4044,7 +4235,8 @@ class DataSourceConfiguration < Struct.new( :slack_configuration, :box_configuration, :quip_configuration, - :jira_configuration) + :jira_configuration, + :git_hub_configuration) SENSITIVE = [] include Aws::Structure end @@ -5623,6 +5815,12 @@ class DisassociatePersonasFromEntitiesResponse < Struct.new( # # @!attribute [rw] id # A unique identifier of the document in the index. + # + # Note, each document ID must be unique per index. You cannot create a + # data source to index your documents with their unique IDs and then + # use the `BatchPutDocument` API to index the same documents, or vice + # versa. You can delete a data source and then use the + # `BatchPutDocument` API to index the same documents, or vice versa. # @return [String] # # @!attribute [rw] title @@ -6831,6 +7029,413 @@ class GetSnapshotsResponse < Struct.new( include Aws::Structure end + # Provides the configuration information to connect to GitHub as your + # data source. + # + # @note When making an API call, you may pass GitHubConfiguration + # data as a hash: + # + # { + # saa_s_configuration: { + # organization_name: "OrganizationName", # required + # host_url: "Url", # required + # }, + # on_premise_configuration: { + # host_url: "Url", # required + # organization_name: "OrganizationName", # required + # ssl_certificate_s3_path: { # required + # bucket: "S3BucketName", # required + # key: "S3ObjectKey", # required + # }, + # }, + # type: "SAAS", # accepts SAAS, ON_PREMISE + # secret_arn: "SecretArn", # required + # use_change_log: false, + # git_hub_document_crawl_properties: { + # crawl_repository_documents: false, + # crawl_issue: false, + # crawl_issue_comment: false, + # crawl_issue_comment_attachment: false, + # crawl_pull_request: false, + # crawl_pull_request_comment: false, + # crawl_pull_request_comment_attachment: false, + # }, + # repository_filter: ["RepositoryName"], + # inclusion_folder_name_patterns: ["String"], + # inclusion_file_type_patterns: ["String"], + # inclusion_file_name_patterns: ["String"], + # exclusion_folder_name_patterns: ["String"], + # exclusion_file_type_patterns: ["String"], + # exclusion_file_name_patterns: ["String"], + # vpc_configuration: { + # subnet_ids: ["SubnetId"], # required + # security_group_ids: ["VpcSecurityGroupId"], # required + # }, + # git_hub_repository_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_commit_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_issue_document_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_issue_comment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_issue_attachment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_pull_request_comment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_pull_request_document_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_pull_request_document_attachment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # } + # + # @!attribute [rw] saa_s_configuration + # Configuration information to connect to GitHub Enterprise Cloud + # (SaaS). + # @return [Types::SaaSConfiguration] + # + # @!attribute [rw] on_premise_configuration + # Configuration information to connect to GitHub Enterprise Server (on + # premises). + # @return [Types::OnPremiseConfiguration] + # + # @!attribute [rw] type + # The type of GitHub service you want to connect to—GitHub Enterprise + # Cloud (SaaS) or GitHub Enterprise Server (on premises). + # @return [String] + # + # @!attribute [rw] secret_arn + # The Amazon Resource Name (ARN) of an Secrets Manager secret that + # contains the key-value pairs required to connect to your GitHub. The + # secret must contain a JSON structure with the following keys: + # + # * githubToken—The access token created in GitHub. For more + # information on creating a token in GitHub, see [Authentication for + # a GitHub data source][1]. + # + # ^ + # + # + # + # [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-github.html#github-authentication + # @return [String] + # + # @!attribute [rw] use_change_log + # `TRUE` to use the GitHub change log to determine which documents + # require updating in the index. Depending on the GitHub change log's + # size, it may take longer for Amazon Kendra to use the change log + # than to scan all of your documents in GitHub. + # @return [Boolean] + # + # @!attribute [rw] git_hub_document_crawl_properties + # Configuration information to include certain types of GitHub + # content. You can configure to index repository files only, or also + # include issues and pull requests, comments, and comment attachments. + # @return [Types::GitHubDocumentCrawlProperties] + # + # @!attribute [rw] repository_filter + # A list of names of the specific repositories you want to index. + # @return [Array] + # + # @!attribute [rw] inclusion_folder_name_patterns + # A list of regular expression patterns to include certain folder + # names in your GitHub repository or repositories. Folder names that + # match the patterns are included in the index. Folder names that + # don't match the patterns are excluded from the index. If a folder + # matches both an inclusion and exclusion pattern, the exclusion + # pattern takes precedence and the folder isn't included in the + # index. + # @return [Array] + # + # @!attribute [rw] inclusion_file_type_patterns + # A list of regular expression patterns to include certain file types + # in your GitHub repository or repositories. File types that match the + # patterns are included in the index. File types that don't match the + # patterns are excluded from the index. If a file matches both an + # inclusion and exclusion pattern, the exclusion pattern takes + # precedence and the file isn't included in the index. + # @return [Array] + # + # @!attribute [rw] inclusion_file_name_patterns + # A list of regular expression patterns to include certain file names + # in your GitHub repository or repositories. File names that match the + # patterns are included in the index. File names that don't match the + # patterns are excluded from the index. If a file matches both an + # inclusion and exclusion pattern, the exclusion pattern takes + # precedence and the file isn't included in the index. + # @return [Array] + # + # @!attribute [rw] exclusion_folder_name_patterns + # A list of regular expression patterns to exclude certain folder + # names in your GitHub repository or repositories. Folder names that + # match the patterns are excluded from the index. Folder names that + # don't match the patterns are included in the index. If a folder + # matches both an exclusion and inclusion pattern, the exclusion + # pattern takes precedence and the folder isn't included in the + # index. + # @return [Array] + # + # @!attribute [rw] exclusion_file_type_patterns + # A list of regular expression patterns to exclude certain file types + # in your GitHub repository or repositories. File types that match the + # patterns are excluded from the index. File types that don't match + # the patterns are included in the index. If a file matches both an + # exclusion and inclusion pattern, the exclusion pattern takes + # precedence and the file isn't included in the index. + # @return [Array] + # + # @!attribute [rw] exclusion_file_name_patterns + # A list of regular expression patterns to exclude certain file names + # in your GitHub repository or repositories. File names that match the + # patterns are excluded from the index. File names that don't match + # the patterns are included in the index. If a file matches both an + # exclusion and inclusion pattern, the exclusion pattern takes + # precedence and the file isn't included in the index. + # @return [Array] + # + # @!attribute [rw] vpc_configuration + # Configuration information of an Amazon Virtual Private Cloud to + # connect to your GitHub. For more information, see [Configuring a + # VPC][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html + # @return [Types::DataSourceVpcConfiguration] + # + # @!attribute [rw] git_hub_repository_configuration_field_mappings + # A list of `DataSourceToIndexFieldMapping` objects that map GitHub + # repository attributes or field names to Amazon Kendra index field + # names. To create custom fields, use the `UpdateIndex` API before you + # map to GitHub fields. For more information, see [Mapping data source + # fields][1]. The GitHub data source field names must exist in your + # GitHub custom metadata. + # + # + # + # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html + # @return [Array] + # + # @!attribute [rw] git_hub_commit_configuration_field_mappings + # A list of `DataSourceToIndexFieldMapping` objects that map + # attributes or field names of GitHub commits to Amazon Kendra index + # field names. To create custom fields, use the `UpdateIndex` API + # before you map to GitHub fields. For more information, see [Mapping + # data source fields][1]. The GitHub data source field names must + # exist in your GitHub custom metadata. + # + # + # + # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html + # @return [Array] + # + # @!attribute [rw] git_hub_issue_document_configuration_field_mappings + # A list of `DataSourceToIndexFieldMapping` objects that map + # attributes or field names of GitHub issues to Amazon Kendra index + # field names. To create custom fields, use the `UpdateIndex` API + # before you map to GitHub fields. For more information, see [Mapping + # data source fields][1]. The GitHub data source field names must + # exist in your GitHub custom metadata. + # + # + # + # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html + # @return [Array] + # + # @!attribute [rw] git_hub_issue_comment_configuration_field_mappings + # A list of `DataSourceToIndexFieldMapping` objects that map + # attributes or field names of GitHub issue comments to Amazon Kendra + # index field names. To create custom fields, use the `UpdateIndex` + # API before you map to GitHub fields. For more information, see + # [Mapping data source fields][1]. The GitHub data source field names + # must exist in your GitHub custom metadata. + # + # + # + # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html + # @return [Array] + # + # @!attribute [rw] git_hub_issue_attachment_configuration_field_mappings + # A list of `DataSourceToIndexFieldMapping` objects that map + # attributes or field names of GitHub issue attachments to Amazon + # Kendra index field names. To create custom fields, use the + # `UpdateIndex` API before you map to GitHub fields. For more + # information, see [Mapping data source fields][1]. The GitHub data + # source field names must exist in your GitHub custom metadata. + # + # + # + # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html + # @return [Array] + # + # @!attribute [rw] git_hub_pull_request_comment_configuration_field_mappings + # A list of `DataSourceToIndexFieldMapping` objects that map + # attributes or field names of GitHub pull request comments to Amazon + # Kendra index field names. To create custom fields, use the + # `UpdateIndex` API before you map to GitHub fields. For more + # information, see [Mapping data source fields][1]. The GitHub data + # source field names must exist in your GitHub custom metadata. + # + # + # + # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html + # @return [Array] + # + # @!attribute [rw] git_hub_pull_request_document_configuration_field_mappings + # A list of `DataSourceToIndexFieldMapping` objects that map + # attributes or field names of GitHub pull requests to Amazon Kendra + # index field names. To create custom fields, use the `UpdateIndex` + # API before you map to GitHub fields. For more information, see + # [Mapping data source fields][1]. The GitHub data source field names + # must exist in your GitHub custom metadata. + # + # + # + # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html + # @return [Array] + # + # @!attribute [rw] git_hub_pull_request_document_attachment_configuration_field_mappings + # A list of `DataSourceToIndexFieldMapping` objects that map + # attributes or field names of GitHub pull request attachments to + # Amazon Kendra index field names. To create custom fields, use the + # `UpdateIndex` API before you map to GitHub fields. For more + # information, see [Mapping data source fields][1]. The GitHub data + # source field names must exist in your GitHub custom metadata. + # + # + # + # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GitHubConfiguration AWS API Documentation + # + class GitHubConfiguration < Struct.new( + :saa_s_configuration, + :on_premise_configuration, + :type, + :secret_arn, + :use_change_log, + :git_hub_document_crawl_properties, + :repository_filter, + :inclusion_folder_name_patterns, + :inclusion_file_type_patterns, + :inclusion_file_name_patterns, + :exclusion_folder_name_patterns, + :exclusion_file_type_patterns, + :exclusion_file_name_patterns, + :vpc_configuration, + :git_hub_repository_configuration_field_mappings, + :git_hub_commit_configuration_field_mappings, + :git_hub_issue_document_configuration_field_mappings, + :git_hub_issue_comment_configuration_field_mappings, + :git_hub_issue_attachment_configuration_field_mappings, + :git_hub_pull_request_comment_configuration_field_mappings, + :git_hub_pull_request_document_configuration_field_mappings, + :git_hub_pull_request_document_attachment_configuration_field_mappings) + SENSITIVE = [] + include Aws::Structure + end + + # Provides the configuration information to include certain types of + # GitHub content. You can configure to index repository files only, or + # also include issues and pull requests, comments, and comment + # attachments. + # + # @note When making an API call, you may pass GitHubDocumentCrawlProperties + # data as a hash: + # + # { + # crawl_repository_documents: false, + # crawl_issue: false, + # crawl_issue_comment: false, + # crawl_issue_comment_attachment: false, + # crawl_pull_request: false, + # crawl_pull_request_comment: false, + # crawl_pull_request_comment_attachment: false, + # } + # + # @!attribute [rw] crawl_repository_documents + # `TRUE` to index all files with a repository. + # @return [Boolean] + # + # @!attribute [rw] crawl_issue + # `TRUE` to index all issues within a repository. + # @return [Boolean] + # + # @!attribute [rw] crawl_issue_comment + # `TRUE` to index all comments on issues. + # @return [Boolean] + # + # @!attribute [rw] crawl_issue_comment_attachment + # `TRUE` to include all comment attachments for issues. + # @return [Boolean] + # + # @!attribute [rw] crawl_pull_request + # `TRUE` to index all pull requests within a repository. + # @return [Boolean] + # + # @!attribute [rw] crawl_pull_request_comment + # `TRUE` to index all comments on pull requests. + # @return [Boolean] + # + # @!attribute [rw] crawl_pull_request_comment_attachment + # `TRUE` to include all comment attachments for pull requests. + # @return [Boolean] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GitHubDocumentCrawlProperties AWS API Documentation + # + class GitHubDocumentCrawlProperties < Struct.new( + :crawl_repository_documents, + :crawl_issue, + :crawl_issue_comment, + :crawl_issue_comment_attachment, + :crawl_pull_request, + :crawl_pull_request_comment, + :crawl_pull_request_comment_attachment) + SENSITIVE = [] + include Aws::Structure + end + # Provides the configuration information to connect to Google Drive as # your data source. # @@ -7355,6 +7960,9 @@ class InvalidRequestException < Struct.new( include Aws::Structure end + # Provides the configuration information to connect to Jira as your data + # source. + # # @note When making an API call, you may pass JiraConfiguration # data as a hash: # @@ -7421,8 +8029,7 @@ class InvalidRequestException < Struct.new( # source. The secret must contain a JSON structure with the following # keys: # - # * jira-id—The Active Directory user name, along with the Domain Name - # System (DNS) domain name. For example, *user@corp.example.com*. + # * jira-id—The ID of the Jira account. # # * jiraCredentials—The password of the Jira account user. # @return [String] @@ -8324,6 +8931,47 @@ class MemberUser < Struct.new( include Aws::Structure end + # Provides the configuration information to connect to GitHub Enterprise + # Server (on premises). + # + # @note When making an API call, you may pass OnPremiseConfiguration + # data as a hash: + # + # { + # host_url: "Url", # required + # organization_name: "OrganizationName", # required + # ssl_certificate_s3_path: { # required + # bucket: "S3BucketName", # required + # key: "S3ObjectKey", # required + # }, + # } + # + # @!attribute [rw] host_url + # The GitHub host URL or API endpoint URL. For example, + # *https://on-prem-host-url/api/v3/* + # @return [String] + # + # @!attribute [rw] organization_name + # The name of the organization of the GitHub Enterprise Server + # (in-premise) account you want to connect to. You can find your + # organization name by logging into GitHub desktop and selecting + # **Your organizations** under your profile picture dropdown. + # @return [String] + # + # @!attribute [rw] ssl_certificate_s3_path + # Information required to find a specific file in an Amazon S3 bucket. + # @return [Types::S3Path] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/OnPremiseConfiguration AWS API Documentation + # + class OnPremiseConfiguration < Struct.new( + :host_url, + :organization_name, + :ssl_certificate_s3_path) + SENSITIVE = [] + include Aws::Structure + end + # Provides the configuration information to connect to OneDrive as your # data source. # @@ -9588,6 +10236,38 @@ class S3Path < Struct.new( include Aws::Structure end + # Provides the configuration information to connect to GitHub Enterprise + # Cloud (SaaS). + # + # @note When making an API call, you may pass SaaSConfiguration + # data as a hash: + # + # { + # organization_name: "OrganizationName", # required + # host_url: "Url", # required + # } + # + # @!attribute [rw] organization_name + # The name of the organization of the GitHub Enterprise Cloud (SaaS) + # account you want to connect to. You can find your organization name + # by logging into GitHub desktop and selecting **Your organizations** + # under your profile picture dropdown. + # @return [String] + # + # @!attribute [rw] host_url + # The GitHub host URL or API endpoint URL. For example, + # *https://api.github.com*. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SaaSConfiguration AWS API Documentation + # + class SaaSConfiguration < Struct.new( + :organization_name, + :host_url) + SENSITIVE = [] + include Aws::Structure + end + # The configuration information for syncing a Salesforce chatter feed. # The contents of the object comes from the Salesforce FeedItem table. # @@ -10191,9 +10871,8 @@ class SeedUrlConfiguration < Struct.new( include Aws::Structure end - # Provides the identifier of the KMScustomer master key (CMK) used to - # encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support - # asymmetric CMKs. + # Provides the identifier of the KMS key used to encrypt data indexed by + # Amazon Kendra. Amazon Kendra doesn't support asymmetric keys. # # @note When making an API call, you may pass ServerSideEncryptionConfiguration # data as a hash: @@ -10203,8 +10882,8 @@ class SeedUrlConfiguration < Struct.new( # } # # @!attribute [rw] kms_key_id - # The identifier of the KMScustomer master key (CMK). Amazon Kendra - # doesn't support asymmetric CMKs. + # The identifier of the KMS key. Amazon Kendra doesn't support + # asymmetric keys. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServerSideEncryptionConfiguration AWS API Documentation @@ -11931,6 +12610,99 @@ class UntagResourceResponse < Aws::EmptyStructure; end # security_group_ids: ["VpcSecurityGroupId"], # required # }, # }, + # git_hub_configuration: { + # saa_s_configuration: { + # organization_name: "OrganizationName", # required + # host_url: "Url", # required + # }, + # on_premise_configuration: { + # host_url: "Url", # required + # organization_name: "OrganizationName", # required + # ssl_certificate_s3_path: { # required + # bucket: "S3BucketName", # required + # key: "S3ObjectKey", # required + # }, + # }, + # type: "SAAS", # accepts SAAS, ON_PREMISE + # secret_arn: "SecretArn", # required + # use_change_log: false, + # git_hub_document_crawl_properties: { + # crawl_repository_documents: false, + # crawl_issue: false, + # crawl_issue_comment: false, + # crawl_issue_comment_attachment: false, + # crawl_pull_request: false, + # crawl_pull_request_comment: false, + # crawl_pull_request_comment_attachment: false, + # }, + # repository_filter: ["RepositoryName"], + # inclusion_folder_name_patterns: ["String"], + # inclusion_file_type_patterns: ["String"], + # inclusion_file_name_patterns: ["String"], + # exclusion_folder_name_patterns: ["String"], + # exclusion_file_type_patterns: ["String"], + # exclusion_file_name_patterns: ["String"], + # vpc_configuration: { + # subnet_ids: ["SubnetId"], # required + # security_group_ids: ["VpcSecurityGroupId"], # required + # }, + # git_hub_repository_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_commit_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_issue_document_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_issue_comment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_issue_attachment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_pull_request_comment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_pull_request_document_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # git_hub_pull_request_document_attachment_configuration_field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # }, # }, # description: "Description", # schedule: "ScanSchedule", diff --git a/gems/aws-sdk-proton/CHANGELOG.md b/gems/aws-sdk-proton/CHANGELOG.md index 18ff1429db9..63234dcfa27 100644 --- a/gems/aws-sdk-proton/CHANGELOG.md +++ b/gems/aws-sdk-proton/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.16.0 (2022-06-02) +------------------ + +* Feature - Add new "Components" API to enable users to Create, Delete and Update AWS Proton components. + 1.15.0 (2022-04-04) ------------------ diff --git a/gems/aws-sdk-proton/VERSION b/gems/aws-sdk-proton/VERSION index 141f2e805be..15b989e398f 100644 --- a/gems/aws-sdk-proton/VERSION +++ b/gems/aws-sdk-proton/VERSION @@ -1 +1 @@ -1.15.0 +1.16.0 diff --git a/gems/aws-sdk-proton/lib/aws-sdk-proton.rb b/gems/aws-sdk-proton/lib/aws-sdk-proton.rb index 0fbf38531fa..0fc88332f68 100644 --- a/gems/aws-sdk-proton/lib/aws-sdk-proton.rb +++ b/gems/aws-sdk-proton/lib/aws-sdk-proton.rb @@ -49,6 +49,6 @@ # @!group service module Aws::Proton - GEM_VERSION = '1.15.0' + GEM_VERSION = '1.16.0' end diff --git a/gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb b/gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb index 4d11495233d..8c9e6d6e870 100644 --- a/gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb +++ b/gems/aws-sdk-proton/lib/aws-sdk-proton/client.rb @@ -389,6 +389,7 @@ def initialize(*args) # @example Response structure # # resp.environment_account_connection.arn #=> String + # resp.environment_account_connection.component_role_arn #=> String # resp.environment_account_connection.environment_account_id #=> String # resp.environment_account_connection.environment_name #=> String # resp.environment_account_connection.id #=> String @@ -407,6 +408,54 @@ def accept_environment_account_connection(params = {}, options = {}) req.send_request(options) end + # Attempts to cancel a component deployment (for a component that is in + # the `IN_PROGRESS` deployment status). + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # + # @option params [required, String] :component_name + # The name of the component with the deployment to cancel. + # + # @return [Types::CancelComponentDeploymentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::CancelComponentDeploymentOutput#component #component} => Types::Component + # + # @example Request syntax with placeholder values + # + # resp = client.cancel_component_deployment({ + # component_name: "ResourceName", # required + # }) + # + # @example Response structure + # + # resp.component.arn #=> String + # resp.component.created_at #=> Time + # resp.component.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED" + # resp.component.deployment_status_message #=> String + # resp.component.description #=> String + # resp.component.environment_name #=> String + # resp.component.last_deployment_attempted_at #=> Time + # resp.component.last_deployment_succeeded_at #=> Time + # resp.component.last_modified_at #=> Time + # resp.component.name #=> String + # resp.component.service_instance_name #=> String + # resp.component.service_name #=> String + # resp.component.service_spec #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CancelComponentDeployment AWS API Documentation + # + # @overload cancel_component_deployment(params = {}) + # @param [Hash] params ({}) + def cancel_component_deployment(params = {}, options = {}) + req = build_request(:cancel_component_deployment, params) + req.send_request(options) + end + # Attempts to cancel an environment deployment on an UpdateEnvironment # action, if the deployment is `IN_PROGRESS`. For more information, see # [Update an environment][1] in the *Proton Administrator guide*. @@ -443,6 +492,7 @@ def accept_environment_account_connection(params = {}, options = {}) # @example Response structure # # resp.environment.arn #=> String + # resp.environment.component_role_arn #=> String # resp.environment.created_at #=> Time # resp.environment.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED" # resp.environment.deployment_status_message #=> String @@ -595,6 +645,118 @@ def cancel_service_pipeline_deployment(params = {}, options = {}) req.send_request(options) end + # Create an Proton component. A component is an infrastructure extension + # for a service instance. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # + # @option params [String] :description + # An optional customer-provided description of the component. + # + # @option params [String] :environment_name + # The name of the Proton environment that you want to associate this + # component with. You must specify this when you don't specify + # `serviceInstanceName` and `serviceName`. + # + # @option params [required, String] :manifest + # A path to a manifest file that lists the Infrastructure as Code (IaC) + # file, template language, and rendering engine for infrastructure that + # a custom component provisions. + # + # @option params [required, String] :name + # The customer-provided name of the component. + # + # @option params [String] :service_instance_name + # The name of the service instance that you want to attach this + # component to. If you don't specify this, the component isn't + # attached to any service instance. Specify both `serviceInstanceName` + # and `serviceName` or neither of them. + # + # @option params [String] :service_name + # The name of the service that `serviceInstanceName` is associated with. + # If you don't specify this, the component isn't attached to any + # service instance. Specify both `serviceInstanceName` and `serviceName` + # or neither of them. + # + # @option params [String] :service_spec + # The service spec that you want the component to use to access service + # inputs. Set this only when you attach the component to a service + # instance. + # + # @option params [Array] :tags + # An optional list of metadata items that you can associate with the + # Proton component. A tag is a key-value pair. + # + # For more information, see *Proton resources and tagging* in the + # [Proton Administrator Guide][1] or [Proton User Guide][2]. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/resources.html + # [2]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html + # + # @option params [required, String] :template_file + # A path to the Infrastructure as Code (IaC) file describing + # infrastructure that a custom component provisions. + # + # Components support a single IaC file, even if you use Terraform as + # your template language. + # + # + # + # @return [Types::CreateComponentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::CreateComponentOutput#component #component} => Types::Component + # + # @example Request syntax with placeholder values + # + # resp = client.create_component({ + # description: "Description", + # environment_name: "ResourceName", + # manifest: "TemplateManifestContents", # required + # name: "ResourceName", # required + # service_instance_name: "ResourceName", + # service_name: "ResourceName", + # service_spec: "SpecContents", + # tags: [ + # { + # key: "TagKey", # required + # value: "TagValue", # required + # }, + # ], + # template_file: "TemplateFileContents", # required + # }) + # + # @example Response structure + # + # resp.component.arn #=> String + # resp.component.created_at #=> Time + # resp.component.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED" + # resp.component.deployment_status_message #=> String + # resp.component.description #=> String + # resp.component.environment_name #=> String + # resp.component.last_deployment_attempted_at #=> Time + # resp.component.last_deployment_succeeded_at #=> Time + # resp.component.last_modified_at #=> Time + # resp.component.name #=> String + # resp.component.service_instance_name #=> String + # resp.component.service_name #=> String + # resp.component.service_spec #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateComponent AWS API Documentation + # + # @overload create_component(params = {}) + # @param [Hash] params ({}) + def create_component(params = {}, options = {}) + req = build_request(:create_component, params) + req.send_request(options) + end + # Deploy a new environment. An Proton environment is created from an # environment template that defines infrastructure and resources that # can be shared across services. @@ -616,6 +778,22 @@ def cancel_service_pipeline_deployment(params = {}, options = {}) # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-environments.html # [2]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-works-prov-methods.html # + # @option params [String] :component_role_arn + # The Amazon Resource Name (ARN) of the IAM service role that Proton + # uses when provisioning directly defined components in this + # environment. It determines the scope of infrastructure that a + # component can provision. + # + # You must specify `componentRoleArn` to allow directly defined + # components to be associated with this environment. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # # @option params [String] :description # A description of the environment that's being created and deployed. # @@ -696,6 +874,7 @@ def cancel_service_pipeline_deployment(params = {}, options = {}) # @example Request syntax with placeholder values # # resp = client.create_environment({ + # component_role_arn: "Arn", # description: "Description", # environment_account_connection_id: "EnvironmentAccountConnectionId", # name: "ResourceName", # required @@ -720,6 +899,7 @@ def cancel_service_pipeline_deployment(params = {}, options = {}) # @example Response structure # # resp.environment.arn #=> String + # resp.environment.component_role_arn #=> String # resp.environment.created_at #=> Time # resp.environment.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED" # resp.environment.deployment_status_message #=> String @@ -771,6 +951,23 @@ def create_environment(params = {}, options = {}) # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** # + # @option params [String] :component_role_arn + # The Amazon Resource Name (ARN) of the IAM service role that Proton + # uses when provisioning directly defined components in the associated + # environment account. It determines the scope of infrastructure that a + # component can provision in the account. + # + # You must specify `componentRoleArn` to allow directly defined + # components to be associated with any environments running in this + # account. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # # @option params [required, String] :environment_name # The name of the Proton environment that's created in the associated # management account. @@ -807,6 +1004,7 @@ def create_environment(params = {}, options = {}) # # resp = client.create_environment_account_connection({ # client_token: "ClientToken", + # component_role_arn: "Arn", # environment_name: "ResourceName", # required # management_account_id: "AwsAccountId", # required # role_arn: "Arn", # required @@ -821,6 +1019,7 @@ def create_environment(params = {}, options = {}) # @example Response structure # # resp.environment_account_connection.arn #=> String + # resp.environment_account_connection.component_role_arn #=> String # resp.environment_account_connection.environment_account_id #=> String # resp.environment_account_connection.environment_name #=> String # resp.environment_account_connection.id #=> String @@ -1339,8 +1538,10 @@ def create_service_template(params = {}, options = {}) # not need to pass this option.** # # @option params [required, Array] :compatible_environment_templates - # An array of compatible environment template objects for the new - # version of a service template. + # An array of environment template objects that are compatible with the + # new service template version. A service instance based on this service + # template version can run in environments based on compatible + # templates. # # @option params [String] :description # A description of the new version of a service template. @@ -1356,6 +1557,18 @@ def create_service_template(params = {}, options = {}) # An object that includes the template bundle S3 bucket path and name # for the new version of a service template. # + # @option params [Array] :supported_component_sources + # An array of supported component sources. Components with supported + # sources can be attached to service instances based on this service + # template version. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # # @option params [Array] :tags # An optional list of metadata items that you can associate with the # Proton service template version. A tag is a key-value pair. @@ -1393,6 +1606,7 @@ def create_service_template(params = {}, options = {}) # key: "S3Key", # required # }, # }, + # supported_component_sources: ["DIRECTLY_DEFINED"], # accepts DIRECTLY_DEFINED # tags: [ # { # key: "TagKey", # required @@ -1417,6 +1631,8 @@ def create_service_template(params = {}, options = {}) # resp.service_template_version.schema #=> String # resp.service_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED" # resp.service_template_version.status_message #=> String + # resp.service_template_version.supported_component_sources #=> Array + # resp.service_template_version.supported_component_sources[0] #=> String, one of "DIRECTLY_DEFINED" # resp.service_template_version.template_name #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateServiceTemplateVersion AWS API Documentation @@ -1494,6 +1710,53 @@ def create_template_sync_config(params = {}, options = {}) req.send_request(options) end + # Delete an Proton component resource. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # + # @option params [required, String] :name + # The name of the component to delete. + # + # @return [Types::DeleteComponentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::DeleteComponentOutput#component #component} => Types::Component + # + # @example Request syntax with placeholder values + # + # resp = client.delete_component({ + # name: "ResourceName", # required + # }) + # + # @example Response structure + # + # resp.component.arn #=> String + # resp.component.created_at #=> Time + # resp.component.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED" + # resp.component.deployment_status_message #=> String + # resp.component.description #=> String + # resp.component.environment_name #=> String + # resp.component.last_deployment_attempted_at #=> Time + # resp.component.last_deployment_succeeded_at #=> Time + # resp.component.last_modified_at #=> Time + # resp.component.name #=> String + # resp.component.service_instance_name #=> String + # resp.component.service_name #=> String + # resp.component.service_spec #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteComponent AWS API Documentation + # + # @overload delete_component(params = {}) + # @param [Hash] params ({}) + def delete_component(params = {}, options = {}) + req = build_request(:delete_component, params) + req.send_request(options) + end + # Delete an environment. # # @option params [required, String] :name @@ -1512,6 +1775,7 @@ def create_template_sync_config(params = {}, options = {}) # @example Response structure # # resp.environment.arn #=> String + # resp.environment.component_role_arn #=> String # resp.environment.created_at #=> Time # resp.environment.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED" # resp.environment.deployment_status_message #=> String @@ -1573,6 +1837,7 @@ def delete_environment(params = {}, options = {}) # @example Response structure # # resp.environment_account_connection.arn #=> String + # resp.environment_account_connection.component_role_arn #=> String # resp.environment_account_connection.environment_account_id #=> String # resp.environment_account_connection.environment_name #=> String # resp.environment_account_connection.id #=> String @@ -1721,7 +1986,19 @@ def delete_repository(params = {}, options = {}) req.send_request(options) end - # Delete a service. + # Delete a service, with its instances and pipeline. + # + # You can't delete a service if it has any service instances that have + # components attached to them. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html # # @option params [required, String] :name # The name of the service to delete. @@ -1856,6 +2133,8 @@ def delete_service_template(params = {}, options = {}) # resp.service_template_version.schema #=> String # resp.service_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED" # resp.service_template_version.status_message #=> String + # resp.service_template_version.supported_component_sources #=> Array + # resp.service_template_version.supported_component_sources[0] #=> String, one of "DIRECTLY_DEFINED" # resp.service_template_version.template_name #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteServiceTemplateVersion AWS API Documentation @@ -1927,10 +2206,64 @@ def get_account_settings(params = {}, options = {}) req.send_request(options) end - # Get detail data for an environment. + # Get detailed data for a component. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # + # @option params [required, String] :name + # The name of the component that you want to get the detailed data for. + # + # @return [Types::GetComponentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::GetComponentOutput#component #component} => Types::Component + # + # @example Request syntax with placeholder values + # + # resp = client.get_component({ + # name: "ResourceName", # required + # }) + # + # @example Response structure + # + # resp.component.arn #=> String + # resp.component.created_at #=> Time + # resp.component.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED" + # resp.component.deployment_status_message #=> String + # resp.component.description #=> String + # resp.component.environment_name #=> String + # resp.component.last_deployment_attempted_at #=> Time + # resp.component.last_deployment_succeeded_at #=> Time + # resp.component.last_modified_at #=> Time + # resp.component.name #=> String + # resp.component.service_instance_name #=> String + # resp.component.service_name #=> String + # resp.component.service_spec #=> String + # + # + # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage): + # + # * component_deleted + # * component_deployed + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetComponent AWS API Documentation + # + # @overload get_component(params = {}) + # @param [Hash] params ({}) + def get_component(params = {}, options = {}) + req = build_request(:get_component, params) + req.send_request(options) + end + + # Get detailed data for an environment. # # @option params [required, String] :name - # The name of the environment that you want to get the detail data for. + # The name of the environment that you want to get the detailed data + # for. # # @return [Types::GetEnvironmentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -1945,6 +2278,7 @@ def get_account_settings(params = {}, options = {}) # @example Response structure # # resp.environment.arn #=> String + # resp.environment.component_role_arn #=> String # resp.environment.created_at #=> Time # resp.environment.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED" # resp.environment.deployment_status_message #=> String @@ -1979,7 +2313,7 @@ def get_environment(params = {}, options = {}) req.send_request(options) end - # In an environment account, view the detail data for an environment + # In an environment account, get the detailed data for an environment # account connection. # # For more information, see [Environment account connections][1] in the @@ -1990,7 +2324,8 @@ def get_environment(params = {}, options = {}) # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html # # @option params [required, String] :id - # The ID of the environment account connection. + # The ID of the environment account connection that you want to get the + # detailed data for. # # @return [Types::GetEnvironmentAccountConnectionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -2005,6 +2340,7 @@ def get_environment(params = {}, options = {}) # @example Response structure # # resp.environment_account_connection.arn #=> String + # resp.environment_account_connection.component_role_arn #=> String # resp.environment_account_connection.environment_account_id #=> String # resp.environment_account_connection.environment_name #=> String # resp.environment_account_connection.id #=> String @@ -2023,10 +2359,10 @@ def get_environment_account_connection(params = {}, options = {}) req.send_request(options) end - # Get detail data for an environment template. + # Get detailed data for an environment template. # # @option params [required, String] :name - # The name of the environment template that you want to get the detail + # The name of the environment template that you want to get the detailed # data for. # # @return [Types::GetEnvironmentTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -2060,19 +2396,20 @@ def get_environment_template(params = {}, options = {}) req.send_request(options) end - # View detail data for a major or minor version of an environment + # Get detailed data for a major or minor version of an environment # template. # # @option params [required, String] :major_version - # To view environment template major version detail data, include `major + # To get environment template major version detail data, include `major # Version`. # # @option params [required, String] :minor_version - # To view environment template minor version detail data, include + # To get environment template minor version detail data, include # `minorVersion`. # # @option params [required, String] :template_name - # The name of the environment template. + # The name of the environment template a version of which you want to + # get detailed data for.. # # @return [Types::GetEnvironmentTemplateVersionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -2212,10 +2549,10 @@ def get_repository_sync_status(params = {}, options = {}) req.send_request(options) end - # Get detail data for a service. + # Get detailed data for a service. # # @option params [required, String] :name - # The name of the service that you want to get the detail data for. + # The name of the service that you want to get the detailed data for. # # @return [Types::GetServiceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -2269,12 +2606,12 @@ def get_service(params = {}, options = {}) req.send_request(options) end - # Get detail data for a service instance. A service instance is an + # Get detailed data for a service instance. A service instance is an # instantiation of service template and it runs in a specific # environment. # # @option params [required, String] :name - # The name of a service instance that you want to get the detail data + # The name of a service instance that you want to get the detailed data # for. # # @option params [required, String] :service_name @@ -2321,10 +2658,11 @@ def get_service_instance(params = {}, options = {}) req.send_request(options) end - # Get detail data for a service template. + # Get detailed data for a service template. # # @option params [required, String] :name - # The name of the service template that you want to get detail data for. + # The name of the service template that you want to get detailed data + # for. # # @return [Types::GetServiceTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -2357,18 +2695,19 @@ def get_service_template(params = {}, options = {}) req.send_request(options) end - # View detail data for a major or minor version of a service template. + # Get detailed data for a major or minor version of a service template. # # @option params [required, String] :major_version - # To view service template major version detail data, include `major + # To get service template major version detail data, include `major # Version`. # # @option params [required, String] :minor_version - # To view service template minor version detail data, include + # To get service template minor version detail data, include # `minorVersion`. # # @option params [required, String] :template_name - # The name of the service template. + # The name of the service template a version of which you want to get + # detailed data for. # # @return [Types::GetServiceTemplateVersionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -2397,6 +2736,8 @@ def get_service_template(params = {}, options = {}) # resp.service_template_version.schema #=> String # resp.service_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED" # resp.service_template_version.status_message #=> String + # resp.service_template_version.supported_component_sources #=> Array + # resp.service_template_version.supported_component_sources[0] #=> String, one of "DIRECTLY_DEFINED" # resp.service_template_version.template_name #=> String # # @@ -2528,6 +2869,173 @@ def get_template_sync_status(params = {}, options = {}) req.send_request(options) end + # Get a list of component Infrastructure as Code (IaC) outputs. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # + # @option params [required, String] :component_name + # The name of the component whose outputs you want. + # + # @option params [String] :next_token + # A token that indicates the location of the next output in the array of + # outputs, after the list of outputs that was previously requested. + # + # @return [Types::ListComponentOutputsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListComponentOutputsOutput#next_token #next_token} => String + # * {Types::ListComponentOutputsOutput#outputs #outputs} => Array<Types::Output> + # + # 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_component_outputs({ + # component_name: "ResourceName", # required + # next_token: "EmptyNextToken", + # }) + # + # @example Response structure + # + # resp.next_token #=> String + # resp.outputs #=> Array + # resp.outputs[0].key #=> String + # resp.outputs[0].value_string #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListComponentOutputs AWS API Documentation + # + # @overload list_component_outputs(params = {}) + # @param [Hash] params ({}) + def list_component_outputs(params = {}, options = {}) + req = build_request(:list_component_outputs, params) + req.send_request(options) + end + + # List provisioned resources for a component with details. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # + # @option params [required, String] :component_name + # The name of the component whose provisioned resources you want. + # + # @option params [String] :next_token + # A token that indicates the location of the next provisioned resource + # in the array of provisioned resources, after the list of provisioned + # resources that was previously requested. + # + # @return [Types::ListComponentProvisionedResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListComponentProvisionedResourcesOutput#next_token #next_token} => String + # * {Types::ListComponentProvisionedResourcesOutput#provisioned_resources #provisioned_resources} => Array<Types::ProvisionedResource> + # + # 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_component_provisioned_resources({ + # component_name: "ResourceName", # required + # next_token: "EmptyNextToken", + # }) + # + # @example Response structure + # + # resp.next_token #=> String + # resp.provisioned_resources #=> Array + # resp.provisioned_resources[0].identifier #=> String + # resp.provisioned_resources[0].name #=> String + # resp.provisioned_resources[0].provisioning_engine #=> String, one of "CLOUDFORMATION", "TERRAFORM" + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListComponentProvisionedResources AWS API Documentation + # + # @overload list_component_provisioned_resources(params = {}) + # @param [Hash] params ({}) + def list_component_provisioned_resources(params = {}, options = {}) + req = build_request(:list_component_provisioned_resources, params) + req.send_request(options) + end + + # List components with summary data. You can filter the result list by + # environment, service, or a single service instance. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # + # @option params [String] :environment_name + # The name of an environment for result list filtering. Proton returns + # components associated with the environment or attached to service + # instances running in it. + # + # @option params [Integer] :max_results + # The maximum number of components to list. + # + # @option params [String] :next_token + # A token that indicates the location of the next component in the array + # of components, after the list of components that was previously + # requested. + # + # @option params [String] :service_instance_name + # The name of a service instance for result list filtering. Proton + # returns the component attached to the service instance, if any. + # + # @option params [String] :service_name + # The name of a service for result list filtering. Proton returns + # components attached to service instances of the service. + # + # @return [Types::ListComponentsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListComponentsOutput#components #components} => Array<Types::ComponentSummary> + # * {Types::ListComponentsOutput#next_token #next_token} => String + # + # 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_components({ + # environment_name: "ResourceName", + # max_results: 1, + # next_token: "NextToken", + # service_instance_name: "ResourceName", + # service_name: "ResourceName", + # }) + # + # @example Response structure + # + # resp.components #=> Array + # resp.components[0].arn #=> String + # resp.components[0].created_at #=> Time + # resp.components[0].deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED" + # resp.components[0].deployment_status_message #=> String + # resp.components[0].environment_name #=> String + # resp.components[0].last_deployment_attempted_at #=> Time + # resp.components[0].last_deployment_succeeded_at #=> Time + # resp.components[0].last_modified_at #=> Time + # resp.components[0].name #=> String + # resp.components[0].service_instance_name #=> String + # resp.components[0].service_name #=> String + # resp.next_token #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListComponents AWS API Documentation + # + # @overload list_components(params = {}) + # @param [Hash] params ({}) + def list_components(params = {}, options = {}) + req = build_request(:list_components, params) + req.send_request(options) + end + # View a list of environment account connections. # # For more information, see [Environment account connections][1] in the @@ -2577,6 +3085,7 @@ def get_template_sync_status(params = {}, options = {}) # # resp.environment_account_connections #=> Array # resp.environment_account_connections[0].arn #=> String + # resp.environment_account_connections[0].component_role_arn #=> String # resp.environment_account_connections[0].environment_account_id #=> String # resp.environment_account_connections[0].environment_name #=> String # resp.environment_account_connections[0].id #=> String @@ -2824,6 +3333,7 @@ def list_environment_templates(params = {}, options = {}) # # resp.environments #=> Array # resp.environments[0].arn #=> String + # resp.environments[0].component_role_arn #=> String # resp.environments[0].created_at #=> Time # resp.environments[0].deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED" # resp.environments[0].deployment_status_message #=> String @@ -2940,18 +3450,17 @@ def list_repository_sync_definitions(params = {}, options = {}) req.send_request(options) end - # View a list service instance infrastructure as code outputs with - # detail data. + # Get a list service of instance Infrastructure as Code (IaC) outputs. # # @option params [String] :next_token # A token that indicates the location of the next output in the array of # outputs, after the list of outputs that was previously requested. # # @option params [required, String] :service_instance_name - # The service instance name. + # The name of the service instance whose outputs you want. # # @option params [required, String] :service_name - # The service name. + # The name of the service that `serviceInstanceName` is associated to. # # @return [Types::ListServiceInstanceOutputsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -2992,10 +3501,10 @@ def list_service_instance_outputs(params = {}, options = {}) # resources that was previously requested. # # @option params [required, String] :service_instance_name - # The service instance name. + # The name of the service instance whose provisioned resources you want. # # @option params [required, String] :service_name - # The service name. + # The name of the service that `serviceInstanceName` is associated to. # # @return [Types::ListServiceInstanceProvisionedResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -3029,7 +3538,7 @@ def list_service_instance_provisioned_resources(params = {}, options = {}) req.send_request(options) end - # List service instances with summaries of detail data. + # List service instances with summary data. # # @option params [Integer] :max_results # The maximum number of service instances to list. @@ -3083,15 +3592,14 @@ def list_service_instances(params = {}, options = {}) req.send_request(options) end - # View a list service pipeline infrastructure as code outputs with - # detail. + # Get a list of service pipeline Infrastructure as Code (IaC) outputs. # # @option params [String] :next_token # A token that indicates the location of the next output in the array of # outputs, after the list of outputs that was previously requested. # # @option params [required, String] :service_name - # The service name. + # The name of the service whose pipeline's outputs you want. # # @return [Types::ListServicePipelineOutputsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -3131,7 +3639,8 @@ def list_service_pipeline_outputs(params = {}, options = {}) # resources that was previously requested. # # @option params [required, String] :service_name - # The service name. + # The name of the service whose pipeline's provisioned resources you + # want. # # @return [Types::ListServicePipelineProvisionedResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -3407,7 +3916,7 @@ def list_tags_for_resource(params = {}, options = {}) # ], # resource_arn: "Arn", # required # status: "IN_PROGRESS", # required, accepts IN_PROGRESS, FAILED, SUCCEEDED - # status_message: "SyntheticNotifyResourceDeploymentStatusChangeInputString", + # status_message: "NotifyResourceDeploymentStatusChangeInputStatusMessageString", # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/NotifyResourceDeploymentStatusChange AWS API Documentation @@ -3451,6 +3960,7 @@ def notify_resource_deployment_status_change(params = {}, options = {}) # @example Response structure # # resp.environment_account_connection.arn #=> String + # resp.environment_account_connection.component_role_arn #=> String # resp.environment_account_connection.environment_account_id #=> String # resp.environment_account_connection.environment_name #=> String # resp.environment_account_connection.id #=> String @@ -3592,6 +4102,120 @@ def update_account_settings(params = {}, options = {}) req.send_request(options) end + # Update a component. + # + # There are a few modes for updating a component. The `deploymentType` + # field defines the mode. + # + # You can't update a component while its deployment status, or the + # deployment status of a service instance attached to it, is + # `IN_PROGRESS`. + # + # + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # + # @option params [required, String] :deployment_type + # The deployment type. It defines the mode for updating a component, as + # follows: + # + # + # + # : `NONE` + # + # In this mode, a deployment *doesn't* occur. Only the requested + # metadata parameters are updated. You can only specify `description` + # in this mode. + # + # + # + # : `CURRENT_VERSION` + # + # In this mode, the component is deployed and updated with the new + # `serviceSpec`, `templateSource`, and/or `type` that you provide. + # Only requested parameters are updated. + # + # @option params [String] :description + # An optional customer-provided description of the component. + # + # @option params [required, String] :name + # The name of the component to update. + # + # @option params [String] :service_instance_name + # The name of the service instance that you want to attach this + # component to. Don't specify to keep the component's current service + # instance attachment. Specify an empty string to detach the component + # from the service instance it's attached to. Specify non-empty values + # for both `serviceInstanceName` and `serviceName` or for neither of + # them. + # + # @option params [String] :service_name + # The name of the service that `serviceInstanceName` is associated with. + # Don't specify to keep the component's current service instance + # attachment. Specify an empty string to detach the component from the + # service instance it's attached to. Specify non-empty values for both + # `serviceInstanceName` and `serviceName` or for neither of them. + # + # @option params [String] :service_spec + # The service spec that you want the component to use to access service + # inputs. Set this only when the component is attached to a service + # instance. + # + # @option params [String] :template_file + # A path to the Infrastructure as Code (IaC) file describing + # infrastructure that a custom component provisions. + # + # Components support a single IaC file, even if you use Terraform as + # your template language. + # + # + # + # @return [Types::UpdateComponentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::UpdateComponentOutput#component #component} => Types::Component + # + # @example Request syntax with placeholder values + # + # resp = client.update_component({ + # deployment_type: "NONE", # required, accepts NONE, CURRENT_VERSION + # description: "Description", + # name: "ResourceName", # required + # service_instance_name: "ResourceNameOrEmpty", + # service_name: "ResourceNameOrEmpty", + # service_spec: "SpecContents", + # template_file: "TemplateFileContents", + # }) + # + # @example Response structure + # + # resp.component.arn #=> String + # resp.component.created_at #=> Time + # resp.component.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED" + # resp.component.deployment_status_message #=> String + # resp.component.description #=> String + # resp.component.environment_name #=> String + # resp.component.last_deployment_attempted_at #=> Time + # resp.component.last_deployment_succeeded_at #=> Time + # resp.component.last_modified_at #=> Time + # resp.component.name #=> String + # resp.component.service_instance_name #=> String + # resp.component.service_name #=> String + # resp.component.service_spec #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateComponent AWS API Documentation + # + # @overload update_component(params = {}) + # @param [Hash] params ({}) + def update_component(params = {}, options = {}) + req = build_request(:update_component, params) + req.send_request(options) + end + # Update an environment. # # If the environment is associated with an environment account @@ -3667,6 +4291,22 @@ def update_account_settings(params = {}, options = {}) # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-environments.html # [2]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-works-prov-methods.html # + # @option params [String] :component_role_arn + # The Amazon Resource Name (ARN) of the IAM service role that Proton + # uses when provisioning directly defined components in this + # environment. It determines the scope of infrastructure that a + # component can provision. + # + # The environment must have a `componentRoleArn` to allow directly + # defined components to be associated with the environment. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # # @option params [required, String] :deployment_type # There are four modes for updating an environment. The `deploymentType` # field defines the mode. @@ -3744,6 +4384,7 @@ def update_account_settings(params = {}, options = {}) # @example Request syntax with placeholder values # # resp = client.update_environment({ + # component_role_arn: "Arn", # deployment_type: "NONE", # required, accepts NONE, CURRENT_VERSION, MINOR_VERSION, MAJOR_VERSION # description: "Description", # environment_account_connection_id: "EnvironmentAccountConnectionId", @@ -3762,6 +4403,7 @@ def update_account_settings(params = {}, options = {}) # @example Response structure # # resp.environment.arn #=> String + # resp.environment.component_role_arn #=> String # resp.environment.created_at #=> Time # resp.environment.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED" # resp.environment.deployment_status_message #=> String @@ -3801,10 +4443,27 @@ def update_environment(params = {}, options = {}) # # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html # + # @option params [String] :component_role_arn + # The Amazon Resource Name (ARN) of the IAM service role that Proton + # uses when provisioning directly defined components in the associated + # environment account. It determines the scope of infrastructure that a + # component can provision in the account. + # + # The environment account connection must have a `componentRoleArn` to + # allow directly defined components to be associated with any + # environments running in the account. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # # @option params [required, String] :id # The ID of the environment account connection to update. # - # @option params [required, String] :role_arn + # @option params [String] :role_arn # The Amazon Resource Name (ARN) of the IAM service role that's # associated with the environment account connection to update. # @@ -3815,13 +4474,15 @@ def update_environment(params = {}, options = {}) # @example Request syntax with placeholder values # # resp = client.update_environment_account_connection({ + # component_role_arn: "Arn", # id: "EnvironmentAccountConnectionId", # required - # role_arn: "Arn", # required + # role_arn: "Arn", # }) # # @example Response structure # # resp.environment_account_connection.arn #=> String + # resp.environment_account_connection.component_role_arn #=> String # resp.environment_account_connection.environment_account_id #=> String # resp.environment_account_connection.environment_name #=> String # resp.environment_account_connection.id #=> String @@ -3953,6 +4614,18 @@ def update_environment_template_version(params = {}, options = {}) # # Edit the `spec` parameter to add or delete instances. # + # You can't delete a service instance (remove it from the spec) if it + # has an attached component. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # # @option params [String] :description # The edited service description. # @@ -4019,49 +4692,24 @@ def update_service(params = {}, options = {}) # Update a service instance. # - # There are four modes for updating a service instance. The + # There are a few modes for updating a service instance. The # `deploymentType` field defines the mode. # + # You can't update a service instance while its deployment status, or + # the deployment status of a component attached to it, is `IN_PROGRESS`. # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. # - # : `NONE` - # - # In this mode, a deployment *doesn't* occur. Only the requested - # metadata parameters are updated. - # - # - # - # : `CURRENT_VERSION` - # - # In this mode, the service instance is deployed and updated with the - # new spec that you provide. Only requested parameters are updated. - # *Don’t* include minor or major version parameters when you use this - # `deployment-type`. - # - # - # - # : `MINOR_VERSION` - # - # In this mode, the service instance is deployed and updated with the - # published, recommended (latest) minor version of the current major - # version in use, by default. You can also specify a different minor - # version of the current major version in use. + # # # # - # : `MAJOR_VERSION` - # - # In this mode, the service instance is deployed and updated with the - # published, recommended (latest) major and minor version of the - # current template, by default. You can also specify a different major - # version that's higher than the major version in use and a minor - # version. + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html # # @option params [required, String] :deployment_type - # The deployment type. - # - # There are four modes for updating a service instance. The - # `deploymentType` field defines the mode. + # The deployment type. It defines the mode for updating a service + # instance, as follows: # # # @@ -4077,7 +4725,7 @@ def update_service(params = {}, options = {}) # In this mode, the service instance is deployed and updated with the # new spec that you provide. Only requested parameters are updated. # *Don’t* include major or minor version parameters when you use this - # `deployment-type`. + # deployment type. # # # @@ -4332,8 +4980,10 @@ def update_service_template(params = {}, options = {}) # Update a major or minor version of a service template. # # @option params [Array] :compatible_environment_templates - # An array of compatible environment names for a service template major - # or minor version to update. + # An array of environment template objects that are compatible with this + # service template version. A service instance based on this service + # template version can run in environments based on compatible + # templates. # # @option params [String] :description # A description of a service template version to update. @@ -4349,6 +4999,24 @@ def update_service_template(params = {}, options = {}) # @option params [String] :status # The status of the service template minor version to update. # + # @option params [Array] :supported_component_sources + # An array of supported component sources. Components with supported + # sources can be attached to service instances based on this service + # template version. + # + # A change to `supportedComponentSources` doesn't impact existing + # component attachments to instances based on this template version. A + # change only affects later associations. + # + # + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # # @option params [required, String] :template_name # The name of the service template. # @@ -4369,6 +5037,7 @@ def update_service_template(params = {}, options = {}) # major_version: "TemplateVersionPart", # required # minor_version: "TemplateVersionPart", # required # status: "REGISTRATION_IN_PROGRESS", # accepts REGISTRATION_IN_PROGRESS, REGISTRATION_FAILED, DRAFT, PUBLISHED + # supported_component_sources: ["DIRECTLY_DEFINED"], # accepts DIRECTLY_DEFINED # template_name: "ResourceName", # required # }) # @@ -4387,6 +5056,8 @@ def update_service_template(params = {}, options = {}) # resp.service_template_version.schema #=> String # resp.service_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED" # resp.service_template_version.status_message #=> String + # resp.service_template_version.supported_component_sources #=> Array + # resp.service_template_version.supported_component_sources[0] #=> String, one of "DIRECTLY_DEFINED" # resp.service_template_version.template_name #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceTemplateVersion AWS API Documentation @@ -4466,7 +5137,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-proton' - context[:gem_version] = '1.15.0' + context[:gem_version] = '1.16.0' Seahorse::Client::Request.new(handlers, context) end @@ -4534,6 +5205,8 @@ def build_request(operation_name, params = {}) # # | waiter_name | params | :delay | :max_attempts | # | --------------------------------------- | ----------------------------------------- | -------- | ------------- | + # | component_deleted | {Client#get_component} | 5 | 999 | + # | component_deployed | {Client#get_component} | 5 | 999 | # | environment_deployed | {Client#get_environment} | 5 | 999 | # | environment_template_version_registered | {Client#get_environment_template_version} | 2 | 150 | # | service_created | {Client#get_service} | 5 | 999 | @@ -4592,6 +5265,8 @@ def waiter(waiter_name, options = {}) def waiters { + component_deleted: Waiters::ComponentDeleted, + component_deployed: Waiters::ComponentDeployed, environment_deployed: Waiters::EnvironmentDeployed, environment_template_version_registered: Waiters::EnvironmentTemplateVersionRegistered, service_created: Waiters::ServiceCreated, diff --git a/gems/aws-sdk-proton/lib/aws-sdk-proton/client_api.rb b/gems/aws-sdk-proton/lib/aws-sdk-proton/client_api.rb index ee48ec81a31..5766223f1b4 100644 --- a/gems/aws-sdk-proton/lib/aws-sdk-proton/client_api.rb +++ b/gems/aws-sdk-proton/lib/aws-sdk-proton/client_api.rb @@ -19,6 +19,8 @@ module ClientApi AccountSettings = Shapes::StructureShape.new(name: 'AccountSettings') Arn = Shapes::StringShape.new(name: 'Arn') AwsAccountId = Shapes::StringShape.new(name: 'AwsAccountId') + CancelComponentDeploymentInput = Shapes::StructureShape.new(name: 'CancelComponentDeploymentInput') + CancelComponentDeploymentOutput = Shapes::StructureShape.new(name: 'CancelComponentDeploymentOutput') CancelEnvironmentDeploymentInput = Shapes::StructureShape.new(name: 'CancelEnvironmentDeploymentInput') CancelEnvironmentDeploymentOutput = Shapes::StructureShape.new(name: 'CancelEnvironmentDeploymentOutput') CancelServiceInstanceDeploymentInput = Shapes::StructureShape.new(name: 'CancelServiceInstanceDeploymentInput') @@ -30,7 +32,14 @@ module ClientApi CompatibleEnvironmentTemplateInput = Shapes::StructureShape.new(name: 'CompatibleEnvironmentTemplateInput') CompatibleEnvironmentTemplateInputList = Shapes::ListShape.new(name: 'CompatibleEnvironmentTemplateInputList') CompatibleEnvironmentTemplateList = Shapes::ListShape.new(name: 'CompatibleEnvironmentTemplateList') + Component = Shapes::StructureShape.new(name: 'Component') + ComponentArn = Shapes::StringShape.new(name: 'ComponentArn') + ComponentDeploymentUpdateType = Shapes::StringShape.new(name: 'ComponentDeploymentUpdateType') + ComponentSummary = Shapes::StructureShape.new(name: 'ComponentSummary') + ComponentSummaryList = Shapes::ListShape.new(name: 'ComponentSummaryList') ConflictException = Shapes::StructureShape.new(name: 'ConflictException') + CreateComponentInput = Shapes::StructureShape.new(name: 'CreateComponentInput') + CreateComponentOutput = Shapes::StructureShape.new(name: 'CreateComponentOutput') CreateEnvironmentAccountConnectionInput = Shapes::StructureShape.new(name: 'CreateEnvironmentAccountConnectionInput') CreateEnvironmentAccountConnectionOutput = Shapes::StructureShape.new(name: 'CreateEnvironmentAccountConnectionOutput') CreateEnvironmentInput = Shapes::StructureShape.new(name: 'CreateEnvironmentInput') @@ -49,6 +58,8 @@ module ClientApi CreateServiceTemplateVersionOutput = Shapes::StructureShape.new(name: 'CreateServiceTemplateVersionOutput') CreateTemplateSyncConfigInput = Shapes::StructureShape.new(name: 'CreateTemplateSyncConfigInput') CreateTemplateSyncConfigOutput = Shapes::StructureShape.new(name: 'CreateTemplateSyncConfigOutput') + DeleteComponentInput = Shapes::StructureShape.new(name: 'DeleteComponentInput') + DeleteComponentOutput = Shapes::StructureShape.new(name: 'DeleteComponentOutput') DeleteEnvironmentAccountConnectionInput = Shapes::StructureShape.new(name: 'DeleteEnvironmentAccountConnectionInput') DeleteEnvironmentAccountConnectionOutput = Shapes::StructureShape.new(name: 'DeleteEnvironmentAccountConnectionOutput') DeleteEnvironmentInput = Shapes::StructureShape.new(name: 'DeleteEnvironmentInput') @@ -99,6 +110,8 @@ module ClientApi FullTemplateVersionNumber = Shapes::StringShape.new(name: 'FullTemplateVersionNumber') GetAccountSettingsInput = Shapes::StructureShape.new(name: 'GetAccountSettingsInput') GetAccountSettingsOutput = Shapes::StructureShape.new(name: 'GetAccountSettingsOutput') + GetComponentInput = Shapes::StructureShape.new(name: 'GetComponentInput') + GetComponentOutput = Shapes::StructureShape.new(name: 'GetComponentOutput') GetEnvironmentAccountConnectionInput = Shapes::StructureShape.new(name: 'GetEnvironmentAccountConnectionInput') GetEnvironmentAccountConnectionOutput = Shapes::StructureShape.new(name: 'GetEnvironmentAccountConnectionOutput') GetEnvironmentInput = Shapes::StructureShape.new(name: 'GetEnvironmentInput') @@ -125,6 +138,12 @@ module ClientApi GetTemplateSyncStatusOutput = Shapes::StructureShape.new(name: 'GetTemplateSyncStatusOutput') GitBranchName = Shapes::StringShape.new(name: 'GitBranchName') InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException') + ListComponentOutputsInput = Shapes::StructureShape.new(name: 'ListComponentOutputsInput') + ListComponentOutputsOutput = Shapes::StructureShape.new(name: 'ListComponentOutputsOutput') + ListComponentProvisionedResourcesInput = Shapes::StructureShape.new(name: 'ListComponentProvisionedResourcesInput') + ListComponentProvisionedResourcesOutput = Shapes::StructureShape.new(name: 'ListComponentProvisionedResourcesOutput') + ListComponentsInput = Shapes::StructureShape.new(name: 'ListComponentsInput') + ListComponentsOutput = Shapes::StructureShape.new(name: 'ListComponentsOutput') ListEnvironmentAccountConnectionsInput = Shapes::StructureShape.new(name: 'ListEnvironmentAccountConnectionsInput') ListEnvironmentAccountConnectionsOutput = Shapes::StructureShape.new(name: 'ListEnvironmentAccountConnectionsOutput') ListEnvironmentOutputsInput = Shapes::StructureShape.new(name: 'ListEnvironmentOutputsInput') @@ -163,6 +182,7 @@ module ClientApi NextToken = Shapes::StringShape.new(name: 'NextToken') NotifyResourceDeploymentStatusChangeInput = Shapes::StructureShape.new(name: 'NotifyResourceDeploymentStatusChangeInput') NotifyResourceDeploymentStatusChangeInputOutputsList = Shapes::ListShape.new(name: 'NotifyResourceDeploymentStatusChangeInputOutputsList') + NotifyResourceDeploymentStatusChangeInputStatusMessageString = Shapes::StringShape.new(name: 'NotifyResourceDeploymentStatusChangeInputStatusMessageString') NotifyResourceDeploymentStatusChangeOutput = Shapes::StructureShape.new(name: 'NotifyResourceDeploymentStatusChangeOutput') Output = Shapes::StructureShape.new(name: 'Output') OutputKey = Shapes::StringShape.new(name: 'OutputKey') @@ -194,6 +214,7 @@ module ClientApi RepositorySyncStatus = Shapes::StringShape.new(name: 'RepositorySyncStatus') ResourceDeploymentStatus = Shapes::StringShape.new(name: 'ResourceDeploymentStatus') ResourceName = Shapes::StringShape.new(name: 'ResourceName') + ResourceNameOrEmpty = Shapes::StringShape.new(name: 'ResourceNameOrEmpty') ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException') ResourceSyncAttempt = Shapes::StructureShape.new(name: 'ResourceSyncAttempt') ResourceSyncEvent = Shapes::StructureShape.new(name: 'ResourceSyncEvent') @@ -219,6 +240,8 @@ module ClientApi ServiceTemplateArn = Shapes::StringShape.new(name: 'ServiceTemplateArn') ServiceTemplateSummary = Shapes::StructureShape.new(name: 'ServiceTemplateSummary') ServiceTemplateSummaryList = Shapes::ListShape.new(name: 'ServiceTemplateSummaryList') + ServiceTemplateSupportedComponentSourceInputList = Shapes::ListShape.new(name: 'ServiceTemplateSupportedComponentSourceInputList') + ServiceTemplateSupportedComponentSourceType = Shapes::StringShape.new(name: 'ServiceTemplateSupportedComponentSourceType') ServiceTemplateVersion = Shapes::StructureShape.new(name: 'ServiceTemplateVersion') ServiceTemplateVersionArn = Shapes::StringShape.new(name: 'ServiceTemplateVersionArn') ServiceTemplateVersionSummary = Shapes::StructureShape.new(name: 'ServiceTemplateVersionSummary') @@ -228,7 +251,6 @@ module ClientApi String = Shapes::StringShape.new(name: 'String') Subdirectory = Shapes::StringShape.new(name: 'Subdirectory') SyncType = Shapes::StringShape.new(name: 'SyncType') - SyntheticNotifyResourceDeploymentStatusChangeInputString = Shapes::StringShape.new(name: 'SyntheticNotifyResourceDeploymentStatusChangeInputString') Tag = Shapes::StructureShape.new(name: 'Tag') TagKey = Shapes::StringShape.new(name: 'TagKey') TagKeyList = Shapes::ListShape.new(name: 'TagKeyList') @@ -236,6 +258,8 @@ module ClientApi TagResourceInput = Shapes::StructureShape.new(name: 'TagResourceInput') TagResourceOutput = Shapes::StructureShape.new(name: 'TagResourceOutput') TagValue = Shapes::StringShape.new(name: 'TagValue') + TemplateFileContents = Shapes::StringShape.new(name: 'TemplateFileContents') + TemplateManifestContents = Shapes::StringShape.new(name: 'TemplateManifestContents') TemplateSchema = Shapes::StringShape.new(name: 'TemplateSchema') TemplateSyncConfig = Shapes::StructureShape.new(name: 'TemplateSyncConfig') TemplateType = Shapes::StringShape.new(name: 'TemplateType') @@ -248,6 +272,8 @@ module ClientApi UntagResourceOutput = Shapes::StructureShape.new(name: 'UntagResourceOutput') UpdateAccountSettingsInput = Shapes::StructureShape.new(name: 'UpdateAccountSettingsInput') UpdateAccountSettingsOutput = Shapes::StructureShape.new(name: 'UpdateAccountSettingsOutput') + UpdateComponentInput = Shapes::StructureShape.new(name: 'UpdateComponentInput') + UpdateComponentOutput = Shapes::StructureShape.new(name: 'UpdateComponentOutput') UpdateEnvironmentAccountConnectionInput = Shapes::StructureShape.new(name: 'UpdateEnvironmentAccountConnectionInput') UpdateEnvironmentAccountConnectionOutput = Shapes::StructureShape.new(name: 'UpdateEnvironmentAccountConnectionOutput') UpdateEnvironmentInput = Shapes::StructureShape.new(name: 'UpdateEnvironmentInput') @@ -283,6 +309,12 @@ module ClientApi AccountSettings.add_member(:pipeline_service_role_arn, Shapes::ShapeRef.new(shape: PipelineRoleArn, location_name: "pipelineServiceRoleArn")) AccountSettings.struct_class = Types::AccountSettings + CancelComponentDeploymentInput.add_member(:component_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "componentName")) + CancelComponentDeploymentInput.struct_class = Types::CancelComponentDeploymentInput + + CancelComponentDeploymentOutput.add_member(:component, Shapes::ShapeRef.new(shape: Component, required: true, location_name: "component")) + CancelComponentDeploymentOutput.struct_class = Types::CancelComponentDeploymentOutput + CancelEnvironmentDeploymentInput.add_member(:environment_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "environmentName")) CancelEnvironmentDeploymentInput.struct_class = Types::CancelEnvironmentDeploymentInput @@ -314,10 +346,55 @@ module ClientApi CompatibleEnvironmentTemplateList.member = Shapes::ShapeRef.new(shape: CompatibleEnvironmentTemplate) + Component.add_member(:arn, Shapes::ShapeRef.new(shape: ComponentArn, required: true, location_name: "arn")) + Component.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "createdAt")) + Component.add_member(:deployment_status, Shapes::ShapeRef.new(shape: DeploymentStatus, required: true, location_name: "deploymentStatus")) + Component.add_member(:deployment_status_message, Shapes::ShapeRef.new(shape: StatusMessage, location_name: "deploymentStatusMessage")) + Component.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description")) + Component.add_member(:environment_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "environmentName")) + Component.add_member(:last_deployment_attempted_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastDeploymentAttemptedAt")) + Component.add_member(:last_deployment_succeeded_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastDeploymentSucceededAt")) + Component.add_member(:last_modified_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "lastModifiedAt")) + Component.add_member(:name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "name")) + Component.add_member(:service_instance_name, Shapes::ShapeRef.new(shape: ResourceName, location_name: "serviceInstanceName")) + Component.add_member(:service_name, Shapes::ShapeRef.new(shape: ResourceName, location_name: "serviceName")) + Component.add_member(:service_spec, Shapes::ShapeRef.new(shape: SpecContents, location_name: "serviceSpec")) + Component.struct_class = Types::Component + + ComponentSummary.add_member(:arn, Shapes::ShapeRef.new(shape: ComponentArn, required: true, location_name: "arn")) + ComponentSummary.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "createdAt")) + ComponentSummary.add_member(:deployment_status, Shapes::ShapeRef.new(shape: DeploymentStatus, required: true, location_name: "deploymentStatus")) + ComponentSummary.add_member(:deployment_status_message, Shapes::ShapeRef.new(shape: StatusMessage, location_name: "deploymentStatusMessage")) + ComponentSummary.add_member(:environment_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "environmentName")) + ComponentSummary.add_member(:last_deployment_attempted_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastDeploymentAttemptedAt")) + ComponentSummary.add_member(:last_deployment_succeeded_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastDeploymentSucceededAt")) + ComponentSummary.add_member(:last_modified_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "lastModifiedAt")) + ComponentSummary.add_member(:name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "name")) + ComponentSummary.add_member(:service_instance_name, Shapes::ShapeRef.new(shape: ResourceName, location_name: "serviceInstanceName")) + ComponentSummary.add_member(:service_name, Shapes::ShapeRef.new(shape: ResourceName, location_name: "serviceName")) + ComponentSummary.struct_class = Types::ComponentSummary + + ComponentSummaryList.member = Shapes::ShapeRef.new(shape: ComponentSummary) + ConflictException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, required: true, location_name: "message")) ConflictException.struct_class = Types::ConflictException + CreateComponentInput.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description")) + CreateComponentInput.add_member(:environment_name, Shapes::ShapeRef.new(shape: ResourceName, location_name: "environmentName")) + CreateComponentInput.add_member(:manifest, Shapes::ShapeRef.new(shape: TemplateManifestContents, required: true, location_name: "manifest")) + CreateComponentInput.add_member(:name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "name")) + CreateComponentInput.add_member(:service_instance_name, Shapes::ShapeRef.new(shape: ResourceName, location_name: "serviceInstanceName")) + CreateComponentInput.add_member(:service_name, Shapes::ShapeRef.new(shape: ResourceName, location_name: "serviceName")) + CreateComponentInput.add_member(:service_spec, Shapes::ShapeRef.new(shape: SpecContents, location_name: "serviceSpec")) + CreateComponentInput.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "tags")) + CreateComponentInput.add_member(:template_file, Shapes::ShapeRef.new(shape: TemplateFileContents, required: true, location_name: "templateFile")) + CreateComponentInput.struct_class = Types::CreateComponentInput + + CreateComponentOutput.add_member(:component, Shapes::ShapeRef.new(shape: Component, required: true, location_name: "component")) + CreateComponentOutput.struct_class = Types::CreateComponentOutput + CreateEnvironmentAccountConnectionInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true})) + CreateEnvironmentAccountConnectionInput.add_member(:component_role_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "componentRoleArn")) CreateEnvironmentAccountConnectionInput.add_member(:environment_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "environmentName")) CreateEnvironmentAccountConnectionInput.add_member(:management_account_id, Shapes::ShapeRef.new(shape: AwsAccountId, required: true, location_name: "managementAccountId")) CreateEnvironmentAccountConnectionInput.add_member(:role_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "roleArn")) @@ -327,6 +404,7 @@ module ClientApi CreateEnvironmentAccountConnectionOutput.add_member(:environment_account_connection, Shapes::ShapeRef.new(shape: EnvironmentAccountConnection, required: true, location_name: "environmentAccountConnection")) CreateEnvironmentAccountConnectionOutput.struct_class = Types::CreateEnvironmentAccountConnectionOutput + CreateEnvironmentInput.add_member(:component_role_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "componentRoleArn")) CreateEnvironmentInput.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description")) CreateEnvironmentInput.add_member(:environment_account_connection_id, Shapes::ShapeRef.new(shape: EnvironmentAccountConnectionId, location_name: "environmentAccountConnectionId")) CreateEnvironmentInput.add_member(:name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "name")) @@ -405,6 +483,7 @@ module ClientApi CreateServiceTemplateVersionInput.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description")) CreateServiceTemplateVersionInput.add_member(:major_version, Shapes::ShapeRef.new(shape: TemplateVersionPart, location_name: "majorVersion")) CreateServiceTemplateVersionInput.add_member(:source, Shapes::ShapeRef.new(shape: TemplateVersionSourceInput, required: true, location_name: "source")) + CreateServiceTemplateVersionInput.add_member(:supported_component_sources, Shapes::ShapeRef.new(shape: ServiceTemplateSupportedComponentSourceInputList, location_name: "supportedComponentSources")) CreateServiceTemplateVersionInput.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "tags")) CreateServiceTemplateVersionInput.add_member(:template_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "templateName")) CreateServiceTemplateVersionInput.struct_class = Types::CreateServiceTemplateVersionInput @@ -423,6 +502,12 @@ module ClientApi CreateTemplateSyncConfigOutput.add_member(:template_sync_config, Shapes::ShapeRef.new(shape: TemplateSyncConfig, location_name: "templateSyncConfig")) CreateTemplateSyncConfigOutput.struct_class = Types::CreateTemplateSyncConfigOutput + DeleteComponentInput.add_member(:name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "name")) + DeleteComponentInput.struct_class = Types::DeleteComponentInput + + DeleteComponentOutput.add_member(:component, Shapes::ShapeRef.new(shape: Component, location_name: "component")) + DeleteComponentOutput.struct_class = Types::DeleteComponentOutput + DeleteEnvironmentAccountConnectionInput.add_member(:id, Shapes::ShapeRef.new(shape: EnvironmentAccountConnectionId, required: true, location_name: "id")) DeleteEnvironmentAccountConnectionInput.struct_class = Types::DeleteEnvironmentAccountConnectionInput @@ -484,6 +569,7 @@ module ClientApi DeleteTemplateSyncConfigOutput.struct_class = Types::DeleteTemplateSyncConfigOutput Environment.add_member(:arn, Shapes::ShapeRef.new(shape: EnvironmentArn, required: true, location_name: "arn")) + Environment.add_member(:component_role_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "componentRoleArn")) Environment.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "createdAt")) Environment.add_member(:deployment_status, Shapes::ShapeRef.new(shape: DeploymentStatus, required: true, location_name: "deploymentStatus")) Environment.add_member(:deployment_status_message, Shapes::ShapeRef.new(shape: StatusMessage, location_name: "deploymentStatusMessage")) @@ -503,6 +589,7 @@ module ClientApi Environment.struct_class = Types::Environment EnvironmentAccountConnection.add_member(:arn, Shapes::ShapeRef.new(shape: EnvironmentAccountConnectionArn, required: true, location_name: "arn")) + EnvironmentAccountConnection.add_member(:component_role_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "componentRoleArn")) EnvironmentAccountConnection.add_member(:environment_account_id, Shapes::ShapeRef.new(shape: AwsAccountId, required: true, location_name: "environmentAccountId")) EnvironmentAccountConnection.add_member(:environment_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "environmentName")) EnvironmentAccountConnection.add_member(:id, Shapes::ShapeRef.new(shape: EnvironmentAccountConnectionId, required: true, location_name: "id")) @@ -516,6 +603,7 @@ module ClientApi EnvironmentAccountConnectionStatusList.member = Shapes::ShapeRef.new(shape: EnvironmentAccountConnectionStatus) EnvironmentAccountConnectionSummary.add_member(:arn, Shapes::ShapeRef.new(shape: EnvironmentAccountConnectionArn, required: true, location_name: "arn")) + EnvironmentAccountConnectionSummary.add_member(:component_role_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "componentRoleArn")) EnvironmentAccountConnectionSummary.add_member(:environment_account_id, Shapes::ShapeRef.new(shape: AwsAccountId, required: true, location_name: "environmentAccountId")) EnvironmentAccountConnectionSummary.add_member(:environment_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "environmentName")) EnvironmentAccountConnectionSummary.add_member(:id, Shapes::ShapeRef.new(shape: EnvironmentAccountConnectionId, required: true, location_name: "id")) @@ -529,6 +617,7 @@ module ClientApi EnvironmentAccountConnectionSummaryList.member = Shapes::ShapeRef.new(shape: EnvironmentAccountConnectionSummary) EnvironmentSummary.add_member(:arn, Shapes::ShapeRef.new(shape: EnvironmentArn, required: true, location_name: "arn")) + EnvironmentSummary.add_member(:component_role_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "componentRoleArn")) EnvironmentSummary.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "createdAt")) EnvironmentSummary.add_member(:deployment_status, Shapes::ShapeRef.new(shape: DeploymentStatus, required: true, location_name: "deploymentStatus")) EnvironmentSummary.add_member(:deployment_status_message, Shapes::ShapeRef.new(shape: StatusMessage, location_name: "deploymentStatusMessage")) @@ -608,6 +697,12 @@ module ClientApi GetAccountSettingsOutput.add_member(:account_settings, Shapes::ShapeRef.new(shape: AccountSettings, location_name: "accountSettings")) GetAccountSettingsOutput.struct_class = Types::GetAccountSettingsOutput + GetComponentInput.add_member(:name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "name")) + GetComponentInput.struct_class = Types::GetComponentInput + + GetComponentOutput.add_member(:component, Shapes::ShapeRef.new(shape: Component, location_name: "component")) + GetComponentOutput.struct_class = Types::GetComponentOutput + GetEnvironmentAccountConnectionInput.add_member(:id, Shapes::ShapeRef.new(shape: EnvironmentAccountConnectionId, required: true, location_name: "id")) GetEnvironmentAccountConnectionInput.struct_class = Types::GetEnvironmentAccountConnectionInput @@ -697,6 +792,33 @@ module ClientApi InternalServerException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, required: true, location_name: "message")) InternalServerException.struct_class = Types::InternalServerException + ListComponentOutputsInput.add_member(:component_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "componentName")) + ListComponentOutputsInput.add_member(:next_token, Shapes::ShapeRef.new(shape: EmptyNextToken, location_name: "nextToken")) + ListComponentOutputsInput.struct_class = Types::ListComponentOutputsInput + + ListComponentOutputsOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: EmptyNextToken, location_name: "nextToken")) + ListComponentOutputsOutput.add_member(:outputs, Shapes::ShapeRef.new(shape: OutputsList, required: true, location_name: "outputs")) + ListComponentOutputsOutput.struct_class = Types::ListComponentOutputsOutput + + ListComponentProvisionedResourcesInput.add_member(:component_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "componentName")) + ListComponentProvisionedResourcesInput.add_member(:next_token, Shapes::ShapeRef.new(shape: EmptyNextToken, location_name: "nextToken")) + ListComponentProvisionedResourcesInput.struct_class = Types::ListComponentProvisionedResourcesInput + + ListComponentProvisionedResourcesOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: EmptyNextToken, location_name: "nextToken")) + ListComponentProvisionedResourcesOutput.add_member(:provisioned_resources, Shapes::ShapeRef.new(shape: ProvisionedResourceList, required: true, location_name: "provisionedResources")) + ListComponentProvisionedResourcesOutput.struct_class = Types::ListComponentProvisionedResourcesOutput + + ListComponentsInput.add_member(:environment_name, Shapes::ShapeRef.new(shape: ResourceName, location_name: "environmentName")) + ListComponentsInput.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxPageResults, location_name: "maxResults")) + ListComponentsInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken")) + ListComponentsInput.add_member(:service_instance_name, Shapes::ShapeRef.new(shape: ResourceName, location_name: "serviceInstanceName")) + ListComponentsInput.add_member(:service_name, Shapes::ShapeRef.new(shape: ResourceName, location_name: "serviceName")) + ListComponentsInput.struct_class = Types::ListComponentsInput + + ListComponentsOutput.add_member(:components, Shapes::ShapeRef.new(shape: ComponentSummaryList, required: true, location_name: "components")) + ListComponentsOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken")) + ListComponentsOutput.struct_class = Types::ListComponentsOutput + ListEnvironmentAccountConnectionsInput.add_member(:environment_name, Shapes::ShapeRef.new(shape: ResourceName, location_name: "environmentName")) ListEnvironmentAccountConnectionsInput.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxPageResults, location_name: "maxResults")) ListEnvironmentAccountConnectionsInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken")) @@ -851,7 +973,7 @@ module ClientApi NotifyResourceDeploymentStatusChangeInput.add_member(:outputs, Shapes::ShapeRef.new(shape: NotifyResourceDeploymentStatusChangeInputOutputsList, location_name: "outputs")) NotifyResourceDeploymentStatusChangeInput.add_member(:resource_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "resourceArn")) NotifyResourceDeploymentStatusChangeInput.add_member(:status, Shapes::ShapeRef.new(shape: ResourceDeploymentStatus, required: true, location_name: "status")) - NotifyResourceDeploymentStatusChangeInput.add_member(:status_message, Shapes::ShapeRef.new(shape: SyntheticNotifyResourceDeploymentStatusChangeInputString, location_name: "statusMessage")) + NotifyResourceDeploymentStatusChangeInput.add_member(:status_message, Shapes::ShapeRef.new(shape: NotifyResourceDeploymentStatusChangeInputStatusMessageString, location_name: "statusMessage")) NotifyResourceDeploymentStatusChangeInput.struct_class = Types::NotifyResourceDeploymentStatusChangeInput NotifyResourceDeploymentStatusChangeInputOutputsList.member = Shapes::ShapeRef.new(shape: Output) @@ -1049,6 +1171,8 @@ module ClientApi ServiceTemplateSummaryList.member = Shapes::ShapeRef.new(shape: ServiceTemplateSummary) + ServiceTemplateSupportedComponentSourceInputList.member = Shapes::ShapeRef.new(shape: ServiceTemplateSupportedComponentSourceType) + ServiceTemplateVersion.add_member(:arn, Shapes::ShapeRef.new(shape: ServiceTemplateVersionArn, required: true, location_name: "arn")) ServiceTemplateVersion.add_member(:compatible_environment_templates, Shapes::ShapeRef.new(shape: CompatibleEnvironmentTemplateList, required: true, location_name: "compatibleEnvironmentTemplates")) ServiceTemplateVersion.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "createdAt")) @@ -1060,6 +1184,7 @@ module ClientApi ServiceTemplateVersion.add_member(:schema, Shapes::ShapeRef.new(shape: TemplateSchema, location_name: "schema")) ServiceTemplateVersion.add_member(:status, Shapes::ShapeRef.new(shape: TemplateVersionStatus, required: true, location_name: "status")) ServiceTemplateVersion.add_member(:status_message, Shapes::ShapeRef.new(shape: StatusMessage, location_name: "statusMessage")) + ServiceTemplateVersion.add_member(:supported_component_sources, Shapes::ShapeRef.new(shape: ServiceTemplateSupportedComponentSourceInputList, location_name: "supportedComponentSources")) ServiceTemplateVersion.add_member(:template_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "templateName")) ServiceTemplateVersion.struct_class = Types::ServiceTemplateVersion @@ -1121,13 +1246,27 @@ module ClientApi UpdateAccountSettingsOutput.add_member(:account_settings, Shapes::ShapeRef.new(shape: AccountSettings, required: true, location_name: "accountSettings")) UpdateAccountSettingsOutput.struct_class = Types::UpdateAccountSettingsOutput + UpdateComponentInput.add_member(:deployment_type, Shapes::ShapeRef.new(shape: ComponentDeploymentUpdateType, required: true, location_name: "deploymentType")) + UpdateComponentInput.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description")) + UpdateComponentInput.add_member(:name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "name")) + UpdateComponentInput.add_member(:service_instance_name, Shapes::ShapeRef.new(shape: ResourceNameOrEmpty, location_name: "serviceInstanceName")) + UpdateComponentInput.add_member(:service_name, Shapes::ShapeRef.new(shape: ResourceNameOrEmpty, location_name: "serviceName")) + UpdateComponentInput.add_member(:service_spec, Shapes::ShapeRef.new(shape: SpecContents, location_name: "serviceSpec")) + UpdateComponentInput.add_member(:template_file, Shapes::ShapeRef.new(shape: TemplateFileContents, location_name: "templateFile")) + UpdateComponentInput.struct_class = Types::UpdateComponentInput + + UpdateComponentOutput.add_member(:component, Shapes::ShapeRef.new(shape: Component, required: true, location_name: "component")) + UpdateComponentOutput.struct_class = Types::UpdateComponentOutput + + UpdateEnvironmentAccountConnectionInput.add_member(:component_role_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "componentRoleArn")) UpdateEnvironmentAccountConnectionInput.add_member(:id, Shapes::ShapeRef.new(shape: EnvironmentAccountConnectionId, required: true, location_name: "id")) - UpdateEnvironmentAccountConnectionInput.add_member(:role_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "roleArn")) + UpdateEnvironmentAccountConnectionInput.add_member(:role_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "roleArn")) UpdateEnvironmentAccountConnectionInput.struct_class = Types::UpdateEnvironmentAccountConnectionInput UpdateEnvironmentAccountConnectionOutput.add_member(:environment_account_connection, Shapes::ShapeRef.new(shape: EnvironmentAccountConnection, required: true, location_name: "environmentAccountConnection")) UpdateEnvironmentAccountConnectionOutput.struct_class = Types::UpdateEnvironmentAccountConnectionOutput + UpdateEnvironmentInput.add_member(:component_role_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "componentRoleArn")) UpdateEnvironmentInput.add_member(:deployment_type, Shapes::ShapeRef.new(shape: DeploymentUpdateType, required: true, location_name: "deploymentType")) UpdateEnvironmentInput.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description")) UpdateEnvironmentInput.add_member(:environment_account_connection_id, Shapes::ShapeRef.new(shape: EnvironmentAccountConnectionId, location_name: "environmentAccountConnectionId")) @@ -1202,6 +1341,7 @@ module ClientApi UpdateServiceTemplateVersionInput.add_member(:major_version, Shapes::ShapeRef.new(shape: TemplateVersionPart, required: true, location_name: "majorVersion")) UpdateServiceTemplateVersionInput.add_member(:minor_version, Shapes::ShapeRef.new(shape: TemplateVersionPart, required: true, location_name: "minorVersion")) UpdateServiceTemplateVersionInput.add_member(:status, Shapes::ShapeRef.new(shape: TemplateVersionStatus, location_name: "status")) + UpdateServiceTemplateVersionInput.add_member(:supported_component_sources, Shapes::ShapeRef.new(shape: ServiceTemplateSupportedComponentSourceInputList, location_name: "supportedComponentSources")) UpdateServiceTemplateVersionInput.add_member(:template_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "templateName")) UpdateServiceTemplateVersionInput.struct_class = Types::UpdateServiceTemplateVersionInput @@ -1255,6 +1395,20 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: InternalServerException) end) + api.add_operation(:cancel_component_deployment, Seahorse::Model::Operation.new.tap do |o| + o.name = "CancelComponentDeployment" + o.http_method = "POST" + o.http_request_uri = "/" + o.input = Shapes::ShapeRef.new(shape: CancelComponentDeploymentInput) + o.output = Shapes::ShapeRef.new(shape: CancelComponentDeploymentOutput) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ConflictException) + o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + end) + api.add_operation(:cancel_environment_deployment, Seahorse::Model::Operation.new.tap do |o| o.name = "CancelEnvironmentDeployment" o.http_method = "POST" @@ -1297,6 +1451,21 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: InternalServerException) end) + api.add_operation(:create_component, Seahorse::Model::Operation.new.tap do |o| + o.name = "CreateComponent" + o.http_method = "POST" + o.http_request_uri = "/" + o.input = Shapes::ShapeRef.new(shape: CreateComponentInput) + o.output = Shapes::ShapeRef.new(shape: CreateComponentOutput) + o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ConflictException) + o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + end) + api.add_operation(:create_environment, Seahorse::Model::Operation.new.tap do |o| o.name = "CreateEnvironment" o.http_method = "POST" @@ -1427,6 +1596,20 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: InternalServerException) end) + api.add_operation(:delete_component, Seahorse::Model::Operation.new.tap do |o| + o.name = "DeleteComponent" + o.http_method = "POST" + o.http_request_uri = "/" + o.input = Shapes::ShapeRef.new(shape: DeleteComponentInput) + o.output = Shapes::ShapeRef.new(shape: DeleteComponentOutput) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ConflictException) + o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + end) + api.add_operation(:delete_environment, Seahorse::Model::Operation.new.tap do |o| o.name = "DeleteEnvironment" o.http_method = "POST" @@ -1566,6 +1749,19 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: InternalServerException) end) + api.add_operation(:get_component, Seahorse::Model::Operation.new.tap do |o| + o.name = "GetComponent" + o.http_method = "POST" + o.http_request_uri = "/" + o.input = Shapes::ShapeRef.new(shape: GetComponentInput) + o.output = Shapes::ShapeRef.new(shape: GetComponentOutput) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + end) + api.add_operation(:get_environment, Seahorse::Model::Operation.new.tap do |o| o.name = "GetEnvironment" o.http_method = "POST" @@ -1722,6 +1918,60 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: InternalServerException) end) + api.add_operation(:list_component_outputs, Seahorse::Model::Operation.new.tap do |o| + o.name = "ListComponentOutputs" + o.http_method = "POST" + o.http_request_uri = "/" + o.input = Shapes::ShapeRef.new(shape: ListComponentOutputsInput) + o.output = Shapes::ShapeRef.new(shape: ListComponentOutputsOutput) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + o[:pager] = Aws::Pager.new( + tokens: { + "next_token" => "next_token" + } + ) + end) + + api.add_operation(:list_component_provisioned_resources, Seahorse::Model::Operation.new.tap do |o| + o.name = "ListComponentProvisionedResources" + o.http_method = "POST" + o.http_request_uri = "/" + o.input = Shapes::ShapeRef.new(shape: ListComponentProvisionedResourcesInput) + o.output = Shapes::ShapeRef.new(shape: ListComponentProvisionedResourcesOutput) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + o[:pager] = Aws::Pager.new( + tokens: { + "next_token" => "next_token" + } + ) + end) + + api.add_operation(:list_components, Seahorse::Model::Operation.new.tap do |o| + o.name = "ListComponents" + o.http_method = "POST" + o.http_request_uri = "/" + o.input = Shapes::ShapeRef.new(shape: ListComponentsInput) + o.output = Shapes::ShapeRef.new(shape: ListComponentsOutput) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + o[:pager] = Aws::Pager.new( + limit_key: "max_results", + tokens: { + "next_token" => "next_token" + } + ) + end) + api.add_operation(:list_environment_account_connections, Seahorse::Model::Operation.new.tap do |o| o.name = "ListEnvironmentAccountConnections" o.http_method = "POST" @@ -2103,6 +2353,21 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: InternalServerException) end) + api.add_operation(:update_component, Seahorse::Model::Operation.new.tap do |o| + o.name = "UpdateComponent" + o.http_method = "POST" + o.http_request_uri = "/" + o.input = Shapes::ShapeRef.new(shape: UpdateComponentInput) + o.output = Shapes::ShapeRef.new(shape: UpdateComponentOutput) + o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ConflictException) + o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + end) + api.add_operation(:update_environment, Seahorse::Model::Operation.new.tap do |o| o.name = "UpdateEnvironment" o.http_method = "POST" diff --git a/gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb b/gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb index 712fabf380e..f2f84ead483 100644 --- a/gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb +++ b/gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb @@ -80,6 +80,38 @@ class AccountSettings < Struct.new( include Aws::Structure end + # @note When making an API call, you may pass CancelComponentDeploymentInput + # data as a hash: + # + # { + # component_name: "ResourceName", # required + # } + # + # @!attribute [rw] component_name + # The name of the component with the deployment to cancel. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CancelComponentDeploymentInput AWS API Documentation + # + class CancelComponentDeploymentInput < Struct.new( + :component_name) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] component + # The detailed data of the component with the deployment that is being + # canceled. + # @return [Types::Component] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CancelComponentDeploymentOutput AWS API Documentation + # + class CancelComponentDeploymentOutput < Struct.new( + :component) + SENSITIVE = [] + include Aws::Structure + end + # @note When making an API call, you may pass CancelEnvironmentDeploymentInput # data as a hash: # @@ -227,6 +259,165 @@ class CompatibleEnvironmentTemplateInput < Struct.new( include Aws::Structure end + # Detailed data of an Proton component resource. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # + # @!attribute [rw] arn + # The Amazon Resource Name (ARN) of the component. + # @return [String] + # + # @!attribute [rw] created_at + # The time when the component was created. + # @return [Time] + # + # @!attribute [rw] deployment_status + # The component deployment status. + # @return [String] + # + # @!attribute [rw] deployment_status_message + # The message associated with the component deployment status. + # @return [String] + # + # @!attribute [rw] description + # A description of the component. + # @return [String] + # + # @!attribute [rw] environment_name + # The name of the Proton environment that this component is associated + # with. + # @return [String] + # + # @!attribute [rw] last_deployment_attempted_at + # The time when a deployment of the component was last attempted. + # @return [Time] + # + # @!attribute [rw] last_deployment_succeeded_at + # The time when the component was last deployed successfully. + # @return [Time] + # + # @!attribute [rw] last_modified_at + # The time when the component was last modified. + # @return [Time] + # + # @!attribute [rw] name + # The name of the component. + # @return [String] + # + # @!attribute [rw] service_instance_name + # The name of the service instance that this component is attached to. + # Provided when a component is attached to a service instance. + # @return [String] + # + # @!attribute [rw] service_name + # The name of the service that `serviceInstanceName` is associated + # with. Provided when a component is attached to a service instance. + # @return [String] + # + # @!attribute [rw] service_spec + # The service spec that the component uses to access service inputs. + # Provided when a component is attached to a service instance. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/Component AWS API Documentation + # + class Component < Struct.new( + :arn, + :created_at, + :deployment_status, + :deployment_status_message, + :description, + :environment_name, + :last_deployment_attempted_at, + :last_deployment_succeeded_at, + :last_modified_at, + :name, + :service_instance_name, + :service_name, + :service_spec) + SENSITIVE = [:deployment_status_message, :description, :service_spec] + include Aws::Structure + end + + # Summary data of an Proton component resource. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # + # @!attribute [rw] arn + # The Amazon Resource Name (ARN) of the component. + # @return [String] + # + # @!attribute [rw] created_at + # The time when the component was created. + # @return [Time] + # + # @!attribute [rw] deployment_status + # The component deployment status. + # @return [String] + # + # @!attribute [rw] deployment_status_message + # The message associated with the component deployment status. + # @return [String] + # + # @!attribute [rw] environment_name + # The name of the Proton environment that this component is associated + # with. + # @return [String] + # + # @!attribute [rw] last_deployment_attempted_at + # The time when a deployment of the component was last attempted. + # @return [Time] + # + # @!attribute [rw] last_deployment_succeeded_at + # The time when the component was last deployed successfully. + # @return [Time] + # + # @!attribute [rw] last_modified_at + # The time when the component was last modified. + # @return [Time] + # + # @!attribute [rw] name + # The name of the component. + # @return [String] + # + # @!attribute [rw] service_instance_name + # The name of the service instance that this component is attached to. + # Provided when a component is attached to a service instance. + # @return [String] + # + # @!attribute [rw] service_name + # The name of the service that `serviceInstanceName` is associated + # with. Provided when a component is attached to a service instance. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ComponentSummary AWS API Documentation + # + class ComponentSummary < Struct.new( + :arn, + :created_at, + :deployment_status, + :deployment_status_message, + :environment_name, + :last_deployment_attempted_at, + :last_deployment_succeeded_at, + :last_modified_at, + :name, + :service_instance_name, + :service_name) + SENSITIVE = [:deployment_status_message] + include Aws::Structure + end + # The request *couldn't* be made due to a conflicting operation or # resource. # @@ -241,11 +432,123 @@ class ConflictException < Struct.new( include Aws::Structure end + # @note When making an API call, you may pass CreateComponentInput + # data as a hash: + # + # { + # description: "Description", + # environment_name: "ResourceName", + # manifest: "TemplateManifestContents", # required + # name: "ResourceName", # required + # service_instance_name: "ResourceName", + # service_name: "ResourceName", + # service_spec: "SpecContents", + # tags: [ + # { + # key: "TagKey", # required + # value: "TagValue", # required + # }, + # ], + # template_file: "TemplateFileContents", # required + # } + # + # @!attribute [rw] description + # An optional customer-provided description of the component. + # @return [String] + # + # @!attribute [rw] environment_name + # The name of the Proton environment that you want to associate this + # component with. You must specify this when you don't specify + # `serviceInstanceName` and `serviceName`. + # @return [String] + # + # @!attribute [rw] manifest + # A path to a manifest file that lists the Infrastructure as Code + # (IaC) file, template language, and rendering engine for + # infrastructure that a custom component provisions. + # @return [String] + # + # @!attribute [rw] name + # The customer-provided name of the component. + # @return [String] + # + # @!attribute [rw] service_instance_name + # The name of the service instance that you want to attach this + # component to. If you don't specify this, the component isn't + # attached to any service instance. Specify both `serviceInstanceName` + # and `serviceName` or neither of them. + # @return [String] + # + # @!attribute [rw] service_name + # The name of the service that `serviceInstanceName` is associated + # with. If you don't specify this, the component isn't attached to + # any service instance. Specify both `serviceInstanceName` and + # `serviceName` or neither of them. + # @return [String] + # + # @!attribute [rw] service_spec + # The service spec that you want the component to use to access + # service inputs. Set this only when you attach the component to a + # service instance. + # @return [String] + # + # @!attribute [rw] tags + # An optional list of metadata items that you can associate with the + # Proton component. A tag is a key-value pair. + # + # For more information, see *Proton resources and tagging* in the + # [Proton Administrator Guide][1] or [Proton User Guide][2]. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/resources.html + # [2]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html + # @return [Array] + # + # @!attribute [rw] template_file + # A path to the Infrastructure as Code (IaC) file describing + # infrastructure that a custom component provisions. + # + # Components support a single IaC file, even if you use Terraform as + # your template language. + # + # + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateComponentInput AWS API Documentation + # + class CreateComponentInput < Struct.new( + :description, + :environment_name, + :manifest, + :name, + :service_instance_name, + :service_name, + :service_spec, + :tags, + :template_file) + SENSITIVE = [:description, :manifest, :service_spec, :template_file] + include Aws::Structure + end + + # @!attribute [rw] component + # The detailed data of the created component. + # @return [Types::Component] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateComponentOutput AWS API Documentation + # + class CreateComponentOutput < Struct.new( + :component) + SENSITIVE = [] + include Aws::Structure + end + # @note When making an API call, you may pass CreateEnvironmentAccountConnectionInput # data as a hash: # # { # client_token: "ClientToken", + # component_role_arn: "Arn", # environment_name: "ResourceName", # required # management_account_id: "AwsAccountId", # required # role_arn: "Arn", # required @@ -266,6 +569,24 @@ class ConflictException < Struct.new( # not need to pass this option. # @return [String] # + # @!attribute [rw] component_role_arn + # The Amazon Resource Name (ARN) of the IAM service role that Proton + # uses when provisioning directly defined components in the associated + # environment account. It determines the scope of infrastructure that + # a component can provision in the account. + # + # You must specify `componentRoleArn` to allow directly defined + # components to be associated with any environments running in this + # account. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # @return [String] + # # @!attribute [rw] environment_name # The name of the Proton environment that's created in the associated # management account. @@ -303,6 +624,7 @@ class ConflictException < Struct.new( # class CreateEnvironmentAccountConnectionInput < Struct.new( :client_token, + :component_role_arn, :environment_name, :management_account_id, :role_arn, @@ -328,6 +650,7 @@ class CreateEnvironmentAccountConnectionOutput < Struct.new( # data as a hash: # # { + # component_role_arn: "Arn", # description: "Description", # environment_account_connection_id: "EnvironmentAccountConnectionId", # name: "ResourceName", # required @@ -349,6 +672,23 @@ class CreateEnvironmentAccountConnectionOutput < Struct.new( # template_name: "ResourceName", # required # } # + # @!attribute [rw] component_role_arn + # The Amazon Resource Name (ARN) of the IAM service role that Proton + # uses when provisioning directly defined components in this + # environment. It determines the scope of infrastructure that a + # component can provision. + # + # You must specify `componentRoleArn` to allow directly defined + # components to be associated with this environment. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # @return [String] + # # @!attribute [rw] description # A description of the environment that's being created and deployed. # @return [String] @@ -435,6 +775,7 @@ class CreateEnvironmentAccountConnectionOutput < Struct.new( # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateEnvironmentInput AWS API Documentation # class CreateEnvironmentInput < Struct.new( + :component_role_arn, :description, :environment_account_connection_id, :name, @@ -930,6 +1271,7 @@ class CreateServiceTemplateOutput < Struct.new( # key: "S3Key", # required # }, # }, + # supported_component_sources: ["DIRECTLY_DEFINED"], # accepts DIRECTLY_DEFINED # tags: [ # { # key: "TagKey", # required @@ -949,8 +1291,10 @@ class CreateServiceTemplateOutput < Struct.new( # @return [String] # # @!attribute [rw] compatible_environment_templates - # An array of compatible environment template objects for the new - # version of a service template. + # An array of environment template objects that are compatible with + # the new service template version. A service instance based on this + # service template version can run in environments based on compatible + # templates. # @return [Array] # # @!attribute [rw] description @@ -970,6 +1314,19 @@ class CreateServiceTemplateOutput < Struct.new( # for the new version of a service template. # @return [Types::TemplateVersionSourceInput] # + # @!attribute [rw] supported_component_sources + # An array of supported component sources. Components with supported + # sources can be attached to service instances based on this service + # template version. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # @return [Array] + # # @!attribute [rw] tags # An optional list of metadata items that you can associate with the # Proton service template version. A tag is a key-value pair. @@ -995,6 +1352,7 @@ class CreateServiceTemplateVersionInput < Struct.new( :description, :major_version, :source, + :supported_component_sources, :tags, :template_name) SENSITIVE = [:description] @@ -1078,6 +1436,37 @@ class CreateTemplateSyncConfigOutput < Struct.new( include Aws::Structure end + # @note When making an API call, you may pass DeleteComponentInput + # data as a hash: + # + # { + # name: "ResourceName", # required + # } + # + # @!attribute [rw] name + # The name of the component to delete. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteComponentInput AWS API Documentation + # + class DeleteComponentInput < Struct.new( + :name) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] component + # The detailed data of the component being deleted. + # @return [Types::Component] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteComponentOutput AWS API Documentation + # + class DeleteComponentOutput < Struct.new( + :component) + SENSITIVE = [] + include Aws::Structure + end + # @note When making an API call, you may pass DeleteEnvironmentAccountConnectionInput # data as a hash: # @@ -1098,8 +1487,8 @@ class DeleteEnvironmentAccountConnectionInput < Struct.new( end # @!attribute [rw] environment_account_connection - # The environment account connection detail data that's returned by - # Proton. + # The detailed data of the environment account connection being + # deleted. # @return [Types::EnvironmentAccountConnection] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironmentAccountConnectionOutput AWS API Documentation @@ -1130,7 +1519,7 @@ class DeleteEnvironmentInput < Struct.new( end # @!attribute [rw] environment - # The environment detail data that's returned by Proton. + # The detailed data of the environment being deleted. # @return [Types::Environment] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironmentOutput AWS API Documentation @@ -1161,7 +1550,7 @@ class DeleteEnvironmentTemplateInput < Struct.new( end # @!attribute [rw] environment_template - # The environment template detail data that's returned by Proton. + # The detailed data of the environment template being deleted. # @return [Types::EnvironmentTemplate] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironmentTemplateOutput AWS API Documentation @@ -1204,8 +1593,7 @@ class DeleteEnvironmentTemplateVersionInput < Struct.new( end # @!attribute [rw] environment_template_version - # The environment template version detail data that's returned by - # Proton. + # The detailed data of the environment template version being deleted. # @return [Types::EnvironmentTemplateVersion] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironmentTemplateVersionOutput AWS API Documentation @@ -1273,7 +1661,7 @@ class DeleteServiceInput < Struct.new( end # @!attribute [rw] service - # The service detail data that's returned by Proton. + # The detailed data of the service being deleted. # @return [Types::Service] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteServiceOutput AWS API Documentation @@ -1304,7 +1692,7 @@ class DeleteServiceTemplateInput < Struct.new( end # @!attribute [rw] service_template - # The service template detail data that's returned by Proton. + # The detailed data of the service template being deleted. # @return [Types::ServiceTemplate] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteServiceTemplateOutput AWS API Documentation @@ -1347,7 +1735,7 @@ class DeleteServiceTemplateVersionInput < Struct.new( end # @!attribute [rw] service_template_version - # The service template version detail data that's returned by Proton. + # The detailed data of the service template version being deleted. # @return [Types::ServiceTemplateVersion] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteServiceTemplateVersionOutput AWS API Documentation @@ -1396,13 +1784,30 @@ class DeleteTemplateSyncConfigOutput < Struct.new( include Aws::Structure end - # The environment detail data. An Proton environment is a set resources - # shared across an Proton service. + # Detailed data of an Proton environment resource. An Proton environment + # is a set of resources shared across Proton services. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the environment. # @return [String] # + # @!attribute [rw] component_role_arn + # The Amazon Resource Name (ARN) of the IAM service role that Proton + # uses when provisioning directly defined components in this + # environment. It determines the scope of infrastructure that a + # component can provision. + # + # The environment must have a `componentRoleArn` to allow directly + # defined components to be associated with the environment. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # @return [String] + # # @!attribute [rw] created_at # The time when the environment was created. # @return [Time] @@ -1476,6 +1881,7 @@ class DeleteTemplateSyncConfigOutput < Struct.new( # class Environment < Struct.new( :arn, + :component_role_arn, :created_at, :deployment_status, :deployment_status_message, @@ -1496,13 +1902,31 @@ class Environment < Struct.new( include Aws::Structure end - # The environment account connection detail data. + # Detailed data of an Proton environment account connection resource. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the environment account # connection. # @return [String] # + # @!attribute [rw] component_role_arn + # The Amazon Resource Name (ARN) of the IAM service role that Proton + # uses when provisioning directly defined components in the associated + # environment account. It determines the scope of infrastructure that + # a component can provision in the account. + # + # The environment account connection must have a `componentRoleArn` to + # allow directly defined components to be associated with any + # environments running in the account. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # @return [String] + # # @!attribute [rw] environment_account_id # The environment account that's connected to the environment account # connection. @@ -1543,6 +1967,7 @@ class Environment < Struct.new( # class EnvironmentAccountConnection < Struct.new( :arn, + :component_role_arn, :environment_account_id, :environment_name, :id, @@ -1555,13 +1980,31 @@ class EnvironmentAccountConnection < Struct.new( include Aws::Structure end - # A summary of the environment account connection detail data. + # Summary data of an Proton environment account connection resource. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the environment account # connection. # @return [String] # + # @!attribute [rw] component_role_arn + # The Amazon Resource Name (ARN) of the IAM service role that Proton + # uses when provisioning directly defined components in the associated + # environment account. It determines the scope of infrastructure that + # a component can provision in the account. + # + # The environment account connection must have a `componentRoleArn` to + # allow directly defined components to be associated with any + # environments running in the account. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # @return [String] + # # @!attribute [rw] environment_account_id # The ID of the environment account that's connected to the # environment account connection. @@ -1602,6 +2045,7 @@ class EnvironmentAccountConnection < Struct.new( # class EnvironmentAccountConnectionSummary < Struct.new( :arn, + :component_role_arn, :environment_account_id, :environment_name, :id, @@ -1614,10 +2058,28 @@ class EnvironmentAccountConnectionSummary < Struct.new( include Aws::Structure end - # A summary of the environment detail data. + # Summary data of an Proton environment resource. An Proton environment + # is a set of resources shared across Proton services. + # + # @!attribute [rw] arn + # The Amazon Resource Name (ARN) of the environment. + # @return [String] + # + # @!attribute [rw] component_role_arn + # The Amazon Resource Name (ARN) of the IAM service role that Proton + # uses when provisioning directly defined components in this + # environment. It determines the scope of infrastructure that a + # component can provision. # - # @!attribute [rw] arn - # The Amazon Resource Name (ARN) of the environment. + # The environment must have a `componentRoleArn` to allow directly + # defined components to be associated with the environment. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html # @return [String] # # @!attribute [rw] created_at @@ -1684,6 +2146,7 @@ class EnvironmentAccountConnectionSummary < Struct.new( # class EnvironmentSummary < Struct.new( :arn, + :component_role_arn, :created_at, :deployment_status, :deployment_status_message, @@ -1984,6 +2447,38 @@ class GetAccountSettingsOutput < Struct.new( include Aws::Structure end + # @note When making an API call, you may pass GetComponentInput + # data as a hash: + # + # { + # name: "ResourceName", # required + # } + # + # @!attribute [rw] name + # The name of the component that you want to get the detailed data + # for. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetComponentInput AWS API Documentation + # + class GetComponentInput < Struct.new( + :name) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] component + # The detailed data of the requested component. + # @return [Types::Component] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetComponentOutput AWS API Documentation + # + class GetComponentOutput < Struct.new( + :component) + SENSITIVE = [] + include Aws::Structure + end + # @note When making an API call, you may pass GetEnvironmentAccountConnectionInput # data as a hash: # @@ -1992,7 +2487,8 @@ class GetAccountSettingsOutput < Struct.new( # } # # @!attribute [rw] id - # The ID of the environment account connection. + # The ID of the environment account connection that you want to get + # the detailed data for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentAccountConnectionInput AWS API Documentation @@ -2004,8 +2500,7 @@ class GetEnvironmentAccountConnectionInput < Struct.new( end # @!attribute [rw] environment_account_connection - # The environment account connection detail data that's returned by - # Proton. + # The detailed data of the requested environment account connection. # @return [Types::EnvironmentAccountConnection] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentAccountConnectionOutput AWS API Documentation @@ -2024,7 +2519,7 @@ class GetEnvironmentAccountConnectionOutput < Struct.new( # } # # @!attribute [rw] name - # The name of the environment that you want to get the detail data + # The name of the environment that you want to get the detailed data # for. # @return [String] # @@ -2037,7 +2532,7 @@ class GetEnvironmentInput < Struct.new( end # @!attribute [rw] environment - # The environment detail data that's returned by Proton. + # The detailed data of the requested environment. # @return [Types::Environment] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentOutput AWS API Documentation @@ -2056,8 +2551,8 @@ class GetEnvironmentOutput < Struct.new( # } # # @!attribute [rw] name - # The name of the environment template that you want to get the detail - # data for. + # The name of the environment template that you want to get the + # detailed data for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentTemplateInput AWS API Documentation @@ -2069,7 +2564,7 @@ class GetEnvironmentTemplateInput < Struct.new( end # @!attribute [rw] environment_template - # The environment template detail data that's returned by Proton. + # The detailed data of the requested environment template. # @return [Types::EnvironmentTemplate] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentTemplateOutput AWS API Documentation @@ -2090,17 +2585,18 @@ class GetEnvironmentTemplateOutput < Struct.new( # } # # @!attribute [rw] major_version - # To view environment template major version detail data, include + # To get environment template major version detail data, include # `major Version`. # @return [String] # # @!attribute [rw] minor_version - # To view environment template minor version detail data, include + # To get environment template minor version detail data, include # `minorVersion`. # @return [String] # # @!attribute [rw] template_name - # The name of the environment template. + # The name of the environment template a version of which you want to + # get detailed data for.. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentTemplateVersionInput AWS API Documentation @@ -2114,8 +2610,7 @@ class GetEnvironmentTemplateVersionInput < Struct.new( end # @!attribute [rw] environment_template_version - # The environment template version detail data that's returned by - # Proton. + # The detailed data of the requested environment template version. # @return [Types::EnvironmentTemplateVersion] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentTemplateVersionOutput AWS API Documentation @@ -2220,7 +2715,7 @@ class GetRepositorySyncStatusOutput < Struct.new( # } # # @!attribute [rw] name - # The name of the service that you want to get the detail data for. + # The name of the service that you want to get the detailed data for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceInput AWS API Documentation @@ -2240,8 +2735,8 @@ class GetServiceInput < Struct.new( # } # # @!attribute [rw] name - # The name of a service instance that you want to get the detail data - # for. + # The name of a service instance that you want to get the detailed + # data for. # @return [String] # # @!attribute [rw] service_name @@ -2258,7 +2753,7 @@ class GetServiceInstanceInput < Struct.new( end # @!attribute [rw] service_instance - # The service instance detail data that's returned by Proton. + # The detailed data of the requested service instance. # @return [Types::ServiceInstance] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceInstanceOutput AWS API Documentation @@ -2270,7 +2765,7 @@ class GetServiceInstanceOutput < Struct.new( end # @!attribute [rw] service - # The service detail data that's returned by Proton. + # The detailed data of the requested service. # @return [Types::Service] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceOutput AWS API Documentation @@ -2289,7 +2784,7 @@ class GetServiceOutput < Struct.new( # } # # @!attribute [rw] name - # The name of the service template that you want to get detail data + # The name of the service template that you want to get detailed data # for. # @return [String] # @@ -2302,7 +2797,7 @@ class GetServiceTemplateInput < Struct.new( end # @!attribute [rw] service_template - # The service template detail data that's returned by Proton. + # The detailed data of the requested service template. # @return [Types::ServiceTemplate] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceTemplateOutput AWS API Documentation @@ -2323,17 +2818,18 @@ class GetServiceTemplateOutput < Struct.new( # } # # @!attribute [rw] major_version - # To view service template major version detail data, include `major + # To get service template major version detail data, include `major # Version`. # @return [String] # # @!attribute [rw] minor_version - # To view service template minor version detail data, include + # To get service template minor version detail data, include # `minorVersion`. # @return [String] # # @!attribute [rw] template_name - # The name of the service template. + # The name of the service template a version of which you want to get + # detailed data for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceTemplateVersionInput AWS API Documentation @@ -2347,7 +2843,7 @@ class GetServiceTemplateVersionInput < Struct.new( end # @!attribute [rw] service_template_version - # The service template version detail data that's returned by Proton. + # The detailed data of the requested service template version. # @return [Types::ServiceTemplateVersion] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceTemplateVersionOutput AWS API Documentation @@ -2462,6 +2958,163 @@ class InternalServerException < Struct.new( include Aws::Structure end + # @note When making an API call, you may pass ListComponentOutputsInput + # data as a hash: + # + # { + # component_name: "ResourceName", # required + # next_token: "EmptyNextToken", + # } + # + # @!attribute [rw] component_name + # The name of the component whose outputs you want. + # @return [String] + # + # @!attribute [rw] next_token + # A token that indicates the location of the next output in the array + # of outputs, after the list of outputs that was previously requested. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListComponentOutputsInput AWS API Documentation + # + class ListComponentOutputsInput < Struct.new( + :component_name, + :next_token) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] next_token + # A token that indicates the location of the next output in the array + # of outputs, after the list of outputs that was previously requested. + # @return [String] + # + # @!attribute [rw] outputs + # An array of component Infrastructure as Code (IaC) outputs. + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListComponentOutputsOutput AWS API Documentation + # + class ListComponentOutputsOutput < Struct.new( + :next_token, + :outputs) + SENSITIVE = [] + include Aws::Structure + end + + # @note When making an API call, you may pass ListComponentProvisionedResourcesInput + # data as a hash: + # + # { + # component_name: "ResourceName", # required + # next_token: "EmptyNextToken", + # } + # + # @!attribute [rw] component_name + # The name of the component whose provisioned resources you want. + # @return [String] + # + # @!attribute [rw] next_token + # A token that indicates the location of the next provisioned resource + # in the array of provisioned resources, after the list of provisioned + # resources that was previously requested. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListComponentProvisionedResourcesInput AWS API Documentation + # + class ListComponentProvisionedResourcesInput < Struct.new( + :component_name, + :next_token) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] next_token + # A token that indicates the location of the next provisioned resource + # in the array of provisioned resources, after the current requested + # list of provisioned resources. + # @return [String] + # + # @!attribute [rw] provisioned_resources + # An array of provisioned resources for a component. + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListComponentProvisionedResourcesOutput AWS API Documentation + # + class ListComponentProvisionedResourcesOutput < Struct.new( + :next_token, + :provisioned_resources) + SENSITIVE = [] + include Aws::Structure + end + + # @note When making an API call, you may pass ListComponentsInput + # data as a hash: + # + # { + # environment_name: "ResourceName", + # max_results: 1, + # next_token: "NextToken", + # service_instance_name: "ResourceName", + # service_name: "ResourceName", + # } + # + # @!attribute [rw] environment_name + # The name of an environment for result list filtering. Proton returns + # components associated with the environment or attached to service + # instances running in it. + # @return [String] + # + # @!attribute [rw] max_results + # The maximum number of components to list. + # @return [Integer] + # + # @!attribute [rw] next_token + # A token that indicates the location of the next component in the + # array of components, after the list of components that was + # previously requested. + # @return [String] + # + # @!attribute [rw] service_instance_name + # The name of a service instance for result list filtering. Proton + # returns the component attached to the service instance, if any. + # @return [String] + # + # @!attribute [rw] service_name + # The name of a service for result list filtering. Proton returns + # components attached to service instances of the service. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListComponentsInput AWS API Documentation + # + class ListComponentsInput < Struct.new( + :environment_name, + :max_results, + :next_token, + :service_instance_name, + :service_name) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] components + # An array of components with summary data. + # @return [Array] + # + # @!attribute [rw] next_token + # A token that indicates the location of the next component in the + # array of components, after the current requested list of components. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListComponentsOutput AWS API Documentation + # + class ListComponentsOutput < Struct.new( + :components, + :next_token) + SENSITIVE = [] + include Aws::Structure + end + # @note When making an API call, you may pass ListEnvironmentAccountConnectionsInput # data as a hash: # @@ -2911,11 +3564,11 @@ class ListRepositorySyncDefinitionsOutput < Struct.new( # @return [String] # # @!attribute [rw] service_instance_name - # The service instance name. + # The name of the service instance whose outputs you want. # @return [String] # # @!attribute [rw] service_name - # The service name. + # The name of the service that `serviceInstanceName` is associated to. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceInstanceOutputsInput AWS API Documentation @@ -2934,7 +3587,7 @@ class ListServiceInstanceOutputsInput < Struct.new( # @return [String] # # @!attribute [rw] outputs - # An array of service instance infrastructure as code outputs. + # An array of service instance Infrastructure as Code (IaC) outputs. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceInstanceOutputsOutput AWS API Documentation @@ -2962,11 +3615,12 @@ class ListServiceInstanceOutputsOutput < Struct.new( # @return [String] # # @!attribute [rw] service_instance_name - # The service instance name. + # The name of the service instance whose provisioned resources you + # want. # @return [String] # # @!attribute [rw] service_name - # The service name. + # The name of the service that `serviceInstanceName` is associated to. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceInstanceProvisionedResourcesInput AWS API Documentation @@ -3038,7 +3692,7 @@ class ListServiceInstancesInput < Struct.new( # @return [String] # # @!attribute [rw] service_instances - # An array of service instances with summaries of detail data. + # An array of service instances with summary data. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceInstancesOutput AWS API Documentation @@ -3064,7 +3718,7 @@ class ListServiceInstancesOutput < Struct.new( # @return [String] # # @!attribute [rw] service_name - # The service name. + # The name of the service whose pipeline's outputs you want. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServicePipelineOutputsInput AWS API Documentation @@ -3082,7 +3736,7 @@ class ListServicePipelineOutputsInput < Struct.new( # @return [String] # # @!attribute [rw] outputs - # An array of outputs. + # An array of service pipeline Infrastructure as Code (IaC) outputs. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServicePipelineOutputsOutput AWS API Documentation @@ -3109,7 +3763,8 @@ class ListServicePipelineOutputsOutput < Struct.new( # @return [String] # # @!attribute [rw] service_name - # The service name. + # The name of the service whose pipeline's provisioned resources you + # want. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServicePipelineProvisionedResourcesInput AWS API Documentation @@ -3362,7 +4017,7 @@ class ListTagsForResourceOutput < Struct.new( # ], # resource_arn: "Arn", # required # status: "IN_PROGRESS", # required, accepts IN_PROGRESS, FAILED, SUCCEEDED - # status_message: "SyntheticNotifyResourceDeploymentStatusChangeInputString", + # status_message: "NotifyResourceDeploymentStatusChangeInputStatusMessageString", # } # # @!attribute [rw] deployment_id @@ -3494,7 +4149,7 @@ class RejectEnvironmentAccountConnectionOutput < Struct.new( include Aws::Structure end - # Detail date for a repository that has been registered with Proton. + # Detailed data of a repository that has been registered with Proton. # # @!attribute [rw] arn # The repository Amazon Resource Name (ARN). @@ -3591,7 +4246,7 @@ class RepositoryBranchInput < Struct.new( include Aws::Structure end - # A summary of detail data for a registered repository. + # Summary data of a repository that has been registered with Proton. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) for a repository. @@ -3843,7 +4498,7 @@ class S3ObjectSource < Struct.new( include Aws::Structure end - # The service detail data. + # Detailed data of an Proton service resource. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the service. @@ -3859,7 +4514,7 @@ class S3ObjectSource < Struct.new( # @return [Time] # # @!attribute [rw] description - # A description of a service. + # A description of the service. # @return [String] # # @!attribute [rw] last_modified_at @@ -3926,7 +4581,7 @@ class Service < Struct.new( include Aws::Structure end - # The service instance detail data. + # Detailed data of an Proton service instance resource. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the service instance. @@ -3941,7 +4596,7 @@ class Service < Struct.new( # @return [String] # # @!attribute [rw] deployment_status_message - # A service instance deployment status message. + # The message associated with the service instance deployment status. # @return [String] # # @!attribute [rw] environment_name @@ -4005,7 +4660,7 @@ class ServiceInstance < Struct.new( include Aws::Structure end - # A summary of the service instance detail data. + # Summary data of an Proton service instance resource. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the service instance. @@ -4075,7 +4730,7 @@ class ServiceInstanceSummary < Struct.new( include Aws::Structure end - # The service pipeline detail data. + # Detailed data of an Proton service instance pipeline resource. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the service pipeline. @@ -4156,7 +4811,7 @@ class ServiceQuotaExceededException < Struct.new( include Aws::Structure end - # A summary of the service detail data. + # Summary data of an Proton service resource. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the service. @@ -4205,7 +4860,7 @@ class ServiceSummary < Struct.new( include Aws::Structure end - # The service template detail data. + # Detailed data of an Proton service template resource. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the service template. @@ -4262,7 +4917,7 @@ class ServiceTemplate < Struct.new( include Aws::Structure end - # The service template summary data. + # Summary data of an Proton service template resource. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the service template. @@ -4313,7 +4968,7 @@ class ServiceTemplateSummary < Struct.new( include Aws::Structure end - # The version of a service template detail data. + # Detailed data of an Proton service template version resource. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the version of a service template. @@ -4361,6 +5016,19 @@ class ServiceTemplateSummary < Struct.new( # A service template version status message. # @return [String] # + # @!attribute [rw] supported_component_sources + # An array of supported component sources. Components with supported + # sources can be attached to service instances based on this service + # template version. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # @return [Array] + # # @!attribute [rw] template_name # The name of the version of a service template. # @return [String] @@ -4379,12 +5047,13 @@ class ServiceTemplateVersion < Struct.new( :schema, :status, :status_message, + :supported_component_sources, :template_name) SENSITIVE = [:description, :schema, :status_message] include Aws::Structure end - # A summary of the service template version detail data. + # Summary data of an Proton service template version resource. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the version of a service template. @@ -4658,14 +5327,135 @@ class UpdateAccountSettingsOutput < Struct.new( include Aws::Structure end + # @note When making an API call, you may pass UpdateComponentInput + # data as a hash: + # + # { + # deployment_type: "NONE", # required, accepts NONE, CURRENT_VERSION + # description: "Description", + # name: "ResourceName", # required + # service_instance_name: "ResourceNameOrEmpty", + # service_name: "ResourceNameOrEmpty", + # service_spec: "SpecContents", + # template_file: "TemplateFileContents", + # } + # + # @!attribute [rw] deployment_type + # The deployment type. It defines the mode for updating a component, + # as follows: + # + # + # + # : `NONE` + # + # In this mode, a deployment *doesn't* occur. Only the requested + # metadata parameters are updated. You can only specify + # `description` in this mode. + # + # + # + # : `CURRENT_VERSION` + # + # In this mode, the component is deployed and updated with the new + # `serviceSpec`, `templateSource`, and/or `type` that you provide. + # Only requested parameters are updated. + # @return [String] + # + # @!attribute [rw] description + # An optional customer-provided description of the component. + # @return [String] + # + # @!attribute [rw] name + # The name of the component to update. + # @return [String] + # + # @!attribute [rw] service_instance_name + # The name of the service instance that you want to attach this + # component to. Don't specify to keep the component's current + # service instance attachment. Specify an empty string to detach the + # component from the service instance it's attached to. Specify + # non-empty values for both `serviceInstanceName` and `serviceName` or + # for neither of them. + # @return [String] + # + # @!attribute [rw] service_name + # The name of the service that `serviceInstanceName` is associated + # with. Don't specify to keep the component's current service + # instance attachment. Specify an empty string to detach the component + # from the service instance it's attached to. Specify non-empty + # values for both `serviceInstanceName` and `serviceName` or for + # neither of them. + # @return [String] + # + # @!attribute [rw] service_spec + # The service spec that you want the component to use to access + # service inputs. Set this only when the component is attached to a + # service instance. + # @return [String] + # + # @!attribute [rw] template_file + # A path to the Infrastructure as Code (IaC) file describing + # infrastructure that a custom component provisions. + # + # Components support a single IaC file, even if you use Terraform as + # your template language. + # + # + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateComponentInput AWS API Documentation + # + class UpdateComponentInput < Struct.new( + :deployment_type, + :description, + :name, + :service_instance_name, + :service_name, + :service_spec, + :template_file) + SENSITIVE = [:description, :service_spec, :template_file] + include Aws::Structure + end + + # @!attribute [rw] component + # The detailed data of the updated component. + # @return [Types::Component] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateComponentOutput AWS API Documentation + # + class UpdateComponentOutput < Struct.new( + :component) + SENSITIVE = [] + include Aws::Structure + end + # @note When making an API call, you may pass UpdateEnvironmentAccountConnectionInput # data as a hash: # # { + # component_role_arn: "Arn", # id: "EnvironmentAccountConnectionId", # required - # role_arn: "Arn", # required + # role_arn: "Arn", # } # + # @!attribute [rw] component_role_arn + # The Amazon Resource Name (ARN) of the IAM service role that Proton + # uses when provisioning directly defined components in the associated + # environment account. It determines the scope of infrastructure that + # a component can provision in the account. + # + # The environment account connection must have a `componentRoleArn` to + # allow directly defined components to be associated with any + # environments running in the account. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # @return [String] + # # @!attribute [rw] id # The ID of the environment account connection to update. # @return [String] @@ -4678,6 +5468,7 @@ class UpdateAccountSettingsOutput < Struct.new( # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateEnvironmentAccountConnectionInput AWS API Documentation # class UpdateEnvironmentAccountConnectionInput < Struct.new( + :component_role_arn, :id, :role_arn) SENSITIVE = [] @@ -4701,6 +5492,7 @@ class UpdateEnvironmentAccountConnectionOutput < Struct.new( # data as a hash: # # { + # component_role_arn: "Arn", # deployment_type: "NONE", # required, accepts NONE, CURRENT_VERSION, MINOR_VERSION, MAJOR_VERSION # description: "Description", # environment_account_connection_id: "EnvironmentAccountConnectionId", @@ -4716,6 +5508,23 @@ class UpdateEnvironmentAccountConnectionOutput < Struct.new( # template_minor_version: "TemplateVersionPart", # } # + # @!attribute [rw] component_role_arn + # The Amazon Resource Name (ARN) of the IAM service role that Proton + # uses when provisioning directly defined components in this + # environment. It determines the scope of infrastructure that a + # component can provision. + # + # The environment must have a `componentRoleArn` to allow directly + # defined components to be associated with the environment. + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # @return [String] + # # @!attribute [rw] deployment_type # There are four modes for updating an environment. The # `deploymentType` field defines the mode. @@ -4798,6 +5607,7 @@ class UpdateEnvironmentAccountConnectionOutput < Struct.new( # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateEnvironmentInput AWS API Documentation # class UpdateEnvironmentInput < Struct.new( + :component_role_arn, :deployment_type, :description, :environment_account_connection_id, @@ -4978,10 +5788,8 @@ class UpdateServiceInput < Struct.new( # } # # @!attribute [rw] deployment_type - # The deployment type. - # - # There are four modes for updating a service instance. The - # `deploymentType` field defines the mode. + # The deployment type. It defines the mode for updating a service + # instance, as follows: # # # @@ -4997,7 +5805,7 @@ class UpdateServiceInput < Struct.new( # In this mode, the service instance is deployed and updated with # the new spec that you provide. Only requested parameters are # updated. *Don’t* include major or minor version parameters when - # you use this `deployment-type`. + # you use this deployment type. # # # @@ -5230,12 +6038,15 @@ class UpdateServiceTemplateOutput < Struct.new( # major_version: "TemplateVersionPart", # required # minor_version: "TemplateVersionPart", # required # status: "REGISTRATION_IN_PROGRESS", # accepts REGISTRATION_IN_PROGRESS, REGISTRATION_FAILED, DRAFT, PUBLISHED + # supported_component_sources: ["DIRECTLY_DEFINED"], # accepts DIRECTLY_DEFINED # template_name: "ResourceName", # required # } # # @!attribute [rw] compatible_environment_templates - # An array of compatible environment names for a service template - # major or minor version to update. + # An array of environment template objects that are compatible with + # this service template version. A service instance based on this + # service template version can run in environments based on compatible + # templates. # @return [Array] # # @!attribute [rw] description @@ -5256,6 +6067,25 @@ class UpdateServiceTemplateOutput < Struct.new( # The status of the service template minor version to update. # @return [String] # + # @!attribute [rw] supported_component_sources + # An array of supported component sources. Components with supported + # sources can be attached to service instances based on this service + # template version. + # + # A change to `supportedComponentSources` doesn't impact existing + # component attachments to instances based on this template version. A + # change only affects later associations. + # + # + # + # For more information about components, see [Proton components][1] in + # the *Proton Administrator Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html + # @return [Array] + # # @!attribute [rw] template_name # The name of the service template. # @return [String] @@ -5268,6 +6098,7 @@ class UpdateServiceTemplateVersionInput < Struct.new( :major_version, :minor_version, :status, + :supported_component_sources, :template_name) SENSITIVE = [:description] include Aws::Structure diff --git a/gems/aws-sdk-proton/lib/aws-sdk-proton/waiters.rb b/gems/aws-sdk-proton/lib/aws-sdk-proton/waiters.rb index 8b0475610f5..0c17b48f0de 100644 --- a/gems/aws-sdk-proton/lib/aws-sdk-proton/waiters.rb +++ b/gems/aws-sdk-proton/lib/aws-sdk-proton/waiters.rb @@ -69,6 +69,8 @@ module Aws::Proton # # | waiter_name | params | :delay | :max_attempts | # | --------------------------------------- | ----------------------------------------- | -------- | ------------- | + # | component_deleted | {Client#get_component} | 5 | 999 | + # | component_deployed | {Client#get_component} | 5 | 999 | # | environment_deployed | {Client#get_environment} | 5 | 999 | # | environment_template_version_registered | {Client#get_environment_template_version} | 2 | 150 | # | service_created | {Client#get_service} | 5 | 999 | @@ -80,6 +82,95 @@ module Aws::Proton # module Waiters + # Wait until a Component is deleted. Use this after invoking DeleteComponent + class ComponentDeleted + + # @param [Hash] options + # @option options [required, Client] :client + # @option options [Integer] :max_attempts (999) + # @option options [Integer] :delay (5) + # @option options [Proc] :before_attempt + # @option options [Proc] :before_wait + def initialize(options) + @client = options.fetch(:client) + @waiter = Aws::Waiters::Waiter.new({ + max_attempts: 999, + delay: 5, + poller: Aws::Waiters::Poller.new( + operation_name: :get_component, + acceptors: [ + { + "matcher" => "error", + "state" => "success", + "expected" => "ResourceNotFoundException" + }, + { + "matcher" => "path", + "argument" => "component.deployment_status", + "state" => "failure", + "expected" => "DELETE_FAILED" + } + ] + ) + }.merge(options)) + end + + # @option (see Client#get_component) + # @return (see Client#get_component) + def wait(params = {}) + @waiter.wait(client: @client, params: params) + end + + # @api private + attr_reader :waiter + + end + + # Wait until a Component is deployed. Use this after invoking CreateComponent or UpdateComponent + class ComponentDeployed + + # @param [Hash] options + # @option options [required, Client] :client + # @option options [Integer] :max_attempts (999) + # @option options [Integer] :delay (5) + # @option options [Proc] :before_attempt + # @option options [Proc] :before_wait + def initialize(options) + @client = options.fetch(:client) + @waiter = Aws::Waiters::Waiter.new({ + max_attempts: 999, + delay: 5, + poller: Aws::Waiters::Poller.new( + operation_name: :get_component, + acceptors: [ + { + "matcher" => "path", + "argument" => "component.deployment_status", + "state" => "success", + "expected" => "SUCCEEDED" + }, + { + "matcher" => "path", + "argument" => "component.deployment_status", + "state" => "failure", + "expected" => "FAILED" + } + ] + ) + }.merge(options)) + end + + # @option (see Client#get_component) + # @return (see Client#get_component) + def wait(params = {}) + @waiter.wait(client: @client, params: params) + end + + # @api private + attr_reader :waiter + + end + # Wait until an Environment is deployed. Use this after invoking CreateEnvironment or UpdateEnvironment class EnvironmentDeployed diff --git a/gems/aws-sdk-voiceid/CHANGELOG.md b/gems/aws-sdk-voiceid/CHANGELOG.md index f2cbaadac02..680c719f1be 100644 --- a/gems/aws-sdk-voiceid/CHANGELOG.md +++ b/gems/aws-sdk-voiceid/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.8.0 (2022-06-02) +------------------ + +* Feature - Added a new attribute ServerSideEncryptionUpdateDetails to Domain and DomainSummary. + 1.7.0 (2022-05-25) ------------------ diff --git a/gems/aws-sdk-voiceid/VERSION b/gems/aws-sdk-voiceid/VERSION index bd8bf882d06..27f9cd322bb 100644 --- a/gems/aws-sdk-voiceid/VERSION +++ b/gems/aws-sdk-voiceid/VERSION @@ -1 +1 @@ -1.7.0 +1.8.0 diff --git a/gems/aws-sdk-voiceid/lib/aws-sdk-voiceid.rb b/gems/aws-sdk-voiceid/lib/aws-sdk-voiceid.rb index 165be0eceff..1da427eff13 100644 --- a/gems/aws-sdk-voiceid/lib/aws-sdk-voiceid.rb +++ b/gems/aws-sdk-voiceid/lib/aws-sdk-voiceid.rb @@ -48,6 +48,6 @@ # @!group service module Aws::VoiceID - GEM_VERSION = '1.7.0' + GEM_VERSION = '1.8.0' end diff --git a/gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb b/gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb index 1f2dc79dfc5..3abf7d61208 100644 --- a/gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb +++ b/gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb @@ -378,10 +378,10 @@ def initialize(*args) # The name of the domain. # # @option params [required, Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration - # The configuration, containing the KMS Key Identifier, to be used by + # The configuration, containing the KMS key identifier, to be used by # Voice ID for the server-side encryption of your data. Refer to [ - # Amazon Connect VoiceID encryption at rest][1] for more details on how - # the KMS Key is used. + # Amazon Connect Voice ID encryption at rest][1] for more details on how + # the KMS key is used. # # # @@ -420,6 +420,9 @@ def initialize(*args) # resp.domain.domain_status #=> String, one of "ACTIVE", "PENDING", "SUSPENDED" # resp.domain.name #=> String # resp.domain.server_side_encryption_configuration.kms_key_id #=> String + # resp.domain.server_side_encryption_update_details.message #=> String + # resp.domain.server_side_encryption_update_details.old_kms_key_id #=> String + # resp.domain.server_side_encryption_update_details.update_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED" # resp.domain.updated_at #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/CreateDomain AWS API Documentation @@ -431,7 +434,7 @@ def create_domain(params = {}, options = {}) req.send_request(options) end - # Deletes the specified domain from the Amazon Connect Voice ID system. + # Deletes the specified domain from Voice ID. # # @option params [required, String] :domain_id # The identifier of the domain you want to delete. @@ -453,8 +456,7 @@ def delete_domain(params = {}, options = {}) req.send_request(options) end - # Deletes the specified fraudster from the Amazon Connect Voice ID - # system. + # Deletes the specified fraudster from Voice ID. # # @option params [required, String] :domain_id # The identifier of the domain containing the fraudster. @@ -480,7 +482,7 @@ def delete_fraudster(params = {}, options = {}) req.send_request(options) end - # Deletes the specified speaker from the Amazon Connect Voice ID system. + # Deletes the specified speaker from Voice ID. # # @option params [required, String] :domain_id # The identifier of the domain containing the speaker. @@ -530,6 +532,9 @@ def delete_speaker(params = {}, options = {}) # resp.domain.domain_status #=> String, one of "ACTIVE", "PENDING", "SUSPENDED" # resp.domain.name #=> String # resp.domain.server_side_encryption_configuration.kms_key_id #=> String + # resp.domain.server_side_encryption_update_details.message #=> String + # resp.domain.server_side_encryption_update_details.old_kms_key_id #=> String + # resp.domain.server_side_encryption_update_details.update_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED" # resp.domain.updated_at #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeDomain AWS API Documentation @@ -804,6 +809,9 @@ def evaluate_session(params = {}, options = {}) # resp.domain_summaries[0].domain_status #=> String, one of "ACTIVE", "PENDING", "SUSPENDED" # resp.domain_summaries[0].name #=> String # resp.domain_summaries[0].server_side_encryption_configuration.kms_key_id #=> String + # resp.domain_summaries[0].server_side_encryption_update_details.message #=> String + # resp.domain_summaries[0].server_side_encryption_update_details.old_kms_key_id #=> String + # resp.domain_summaries[0].server_side_encryption_update_details.update_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED" # resp.domain_summaries[0].updated_at #=> Time # resp.next_token #=> String # @@ -1023,13 +1031,13 @@ def list_tags_for_resource(params = {}, options = {}) req.send_request(options) end - # Opts out a speaker from Voice ID system. A speaker can be opted out - # regardless of whether or not they already exist in the system. If they + # Opts out a speaker from Voice ID. A speaker can be opted out + # regardless of whether or not they already exist in Voice ID. If they # don't yet exist, a new speaker is created in an opted out state. If # they already exist, their existing status is overridden and they are # opted out. Enrollment and evaluation authentication requests are # rejected for opted out speakers, and opted out speakers have no voice - # embeddings stored in the system. + # embeddings stored in Voice ID. # # @option params [required, String] :domain_id # The identifier of the domain containing the speaker. @@ -1100,7 +1108,7 @@ def opt_out_speaker(params = {}, options = {}) # # @option params [required, Types::OutputDataConfig] :output_data_config # The output data config containing the S3 location where Voice ID - # writes the job output file; you must also include a KMS Key ID to + # writes the job output file; you must also include a KMS key ID to # encrypt the file. # # @option params [Types::RegistrationConfig] :registration_config @@ -1185,8 +1193,8 @@ def start_fraudster_registration_job(params = {}, options = {}) # # @option params [Types::EnrollmentConfig] :enrollment_config # The enrollment config that contains details such as the action to take - # when a speaker is already enrolled in the Voice ID system or when a - # speaker is identified as a fraudster. + # when a speaker is already enrolled in Voice ID or when a speaker is + # identified as a fraudster. # # @option params [required, Types::InputDataConfig] :input_data_config # The input data config containing the S3 location for the input @@ -1197,7 +1205,7 @@ def start_fraudster_registration_job(params = {}, options = {}) # # @option params [required, Types::OutputDataConfig] :output_data_config # The output data config containing the S3 location where Voice ID - # writes the job output file; you must also include a KMS Key ID to + # writes the job output file; you must also include a KMS key ID to # encrypt the file. # # @return [Types::StartSpeakerEnrollmentJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -1255,8 +1263,7 @@ def start_speaker_enrollment_job(params = {}, options = {}) req.send_request(options) end - # Tags an Amazon Connect Voice ID resource with the provided list of - # tags. + # Tags a Voice ID resource with the provided list of tags. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) of the Voice ID resource you want to @@ -1330,7 +1337,7 @@ def untag_resource(params = {}, options = {}) # The name of the domain. # # @option params [required, Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration - # The configuration, containing the KMS Key Identifier, to be used by + # The configuration, containing the KMS key identifier, to be used by # Voice ID for the server-side encryption of your data. Note that all # the existing data in the domain are still encrypted using the existing # key, only the data added to domain after updating the key is encrypted @@ -1360,6 +1367,9 @@ def untag_resource(params = {}, options = {}) # resp.domain.domain_status #=> String, one of "ACTIVE", "PENDING", "SUSPENDED" # resp.domain.name #=> String # resp.domain.server_side_encryption_configuration.kms_key_id #=> String + # resp.domain.server_side_encryption_update_details.message #=> String + # resp.domain.server_side_encryption_update_details.old_kms_key_id #=> String + # resp.domain.server_side_encryption_update_details.update_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED" # resp.domain.updated_at #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/UpdateDomain AWS API Documentation @@ -1384,7 +1394,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-voiceid' - context[:gem_version] = '1.7.0' + context[:gem_version] = '1.8.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client_api.rb b/gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client_api.rb index 3b562940729..02337e4977a 100644 --- a/gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client_api.rb +++ b/gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client_api.rb @@ -98,6 +98,8 @@ module ClientApi S3Uri = Shapes::StringShape.new(name: 'S3Uri') Score = Shapes::IntegerShape.new(name: 'Score') ServerSideEncryptionConfiguration = Shapes::StructureShape.new(name: 'ServerSideEncryptionConfiguration') + ServerSideEncryptionUpdateDetails = Shapes::StructureShape.new(name: 'ServerSideEncryptionUpdateDetails') + ServerSideEncryptionUpdateStatus = Shapes::StringShape.new(name: 'ServerSideEncryptionUpdateStatus') ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException') SessionId = Shapes::StringShape.new(name: 'SessionId') SessionName = Shapes::StringShape.new(name: 'SessionName') @@ -215,6 +217,7 @@ module ClientApi Domain.add_member(:domain_status, Shapes::ShapeRef.new(shape: DomainStatus, location_name: "DomainStatus")) Domain.add_member(:name, Shapes::ShapeRef.new(shape: DomainName, location_name: "Name")) Domain.add_member(:server_side_encryption_configuration, Shapes::ShapeRef.new(shape: ServerSideEncryptionConfiguration, location_name: "ServerSideEncryptionConfiguration")) + Domain.add_member(:server_side_encryption_update_details, Shapes::ShapeRef.new(shape: ServerSideEncryptionUpdateDetails, location_name: "ServerSideEncryptionUpdateDetails")) Domain.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "UpdatedAt")) Domain.struct_class = Types::Domain @@ -227,6 +230,7 @@ module ClientApi DomainSummary.add_member(:domain_status, Shapes::ShapeRef.new(shape: DomainStatus, location_name: "DomainStatus")) DomainSummary.add_member(:name, Shapes::ShapeRef.new(shape: DomainName, location_name: "Name")) DomainSummary.add_member(:server_side_encryption_configuration, Shapes::ShapeRef.new(shape: ServerSideEncryptionConfiguration, location_name: "ServerSideEncryptionConfiguration")) + DomainSummary.add_member(:server_side_encryption_update_details, Shapes::ShapeRef.new(shape: ServerSideEncryptionUpdateDetails, location_name: "ServerSideEncryptionUpdateDetails")) DomainSummary.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "UpdatedAt")) DomainSummary.struct_class = Types::DomainSummary @@ -380,6 +384,11 @@ module ClientApi ServerSideEncryptionConfiguration.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, required: true, location_name: "KmsKeyId")) ServerSideEncryptionConfiguration.struct_class = Types::ServerSideEncryptionConfiguration + ServerSideEncryptionUpdateDetails.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message")) + ServerSideEncryptionUpdateDetails.add_member(:old_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "OldKmsKeyId")) + ServerSideEncryptionUpdateDetails.add_member(:update_status, Shapes::ShapeRef.new(shape: ServerSideEncryptionUpdateStatus, location_name: "UpdateStatus")) + ServerSideEncryptionUpdateDetails.struct_class = Types::ServerSideEncryptionUpdateDetails + ServiceQuotaExceededException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message")) ServiceQuotaExceededException.struct_class = Types::ServiceQuotaExceededException @@ -544,6 +553,7 @@ module ClientApi o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure)) o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: ConflictException) o.errors << Shapes::ShapeRef.new(shape: InternalServerException) o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) @@ -636,6 +646,7 @@ module ClientApi o.output = Shapes::ShapeRef.new(shape: EvaluateSessionResponse) o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: ConflictException) o.errors << Shapes::ShapeRef.new(shape: InternalServerException) o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) diff --git a/gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb b/gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb index 64956e29daa..6361b7453f5 100644 --- a/gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb +++ b/gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/types.rb @@ -175,10 +175,10 @@ class ConflictException < Struct.new( # @return [String] # # @!attribute [rw] server_side_encryption_configuration - # The configuration, containing the KMS Key Identifier, to be used by + # The configuration, containing the KMS key identifier, to be used by # Voice ID for the server-side encryption of your data. Refer to [ - # Amazon Connect VoiceID encryption at rest][1] for more details on - # how the KMS Key is used. + # Amazon Connect Voice ID encryption at rest][1] for more details on + # how the KMS key is used. # # # @@ -490,10 +490,18 @@ class DescribeSpeakerResponse < Struct.new( # @return [String] # # @!attribute [rw] server_side_encryption_configuration - # The server-side encryption configuration containing the KMS Key - # Identifier you want Voice ID to use to encrypt your data. + # The server-side encryption configuration containing the KMS key + # identifier you want Voice ID to use to encrypt your data. # @return [Types::ServerSideEncryptionConfiguration] # + # @!attribute [rw] server_side_encryption_update_details + # Details about the most recent server-side encryption configuration + # update. When the server-side encryption configuration is changed, + # dependency on the old KMS key is removed through an asynchronous + # process. When this update is complete, the domain's data can only + # be accessed using the new KMS key. + # @return [Types::ServerSideEncryptionUpdateDetails] + # # @!attribute [rw] updated_at # The timestamp showing the domain's last update. # @return [Time] @@ -508,6 +516,7 @@ class Domain < Struct.new( :domain_status, :name, :server_side_encryption_configuration, + :server_side_encryption_update_details, :updated_at) SENSITIVE = [:description, :name] include Aws::Structure @@ -540,10 +549,18 @@ class Domain < Struct.new( # @return [String] # # @!attribute [rw] server_side_encryption_configuration - # The server-side encryption configuration containing the KMS Key - # Identifier you want Voice ID to use to encrypt your data.. + # The server-side encryption configuration containing the KMS key + # identifier you want Voice ID to use to encrypt your data. # @return [Types::ServerSideEncryptionConfiguration] # + # @!attribute [rw] server_side_encryption_update_details + # Details about the most recent server-side encryption configuration + # update. When the server-side encryption configuration is changed, + # dependency on the old KMS key is removed through an asynchronous + # process. When this update is complete, the domain’s data can only be + # accessed using the new KMS key. + # @return [Types::ServerSideEncryptionUpdateDetails] + # # @!attribute [rw] updated_at # The timestamp showing the domain's last update. # @return [Time] @@ -558,6 +575,7 @@ class DomainSummary < Struct.new( :domain_status, :name, :server_side_encryption_configuration, + :server_side_encryption_update_details, :updated_at) SENSITIVE = [:description, :name] include Aws::Structure @@ -690,7 +708,7 @@ class EvaluateSessionRequest < Struct.new( # Detection results are empty or the decision is `NOT_ENOUGH_SPEECH`. # In this situation, if the `StreamingStatus` is # `ONGOING/PENDING_CONFIGURATION`, it can mean that the client should - # call the API again later, once Voice ID has enough audio to produce + # call the API again later, after Voice ID has enough audio to produce # a result. If the decision remains `NOT_ENOUGH_SPEECH` even after # `StreamingStatus` is `ENDED`, it means that the previously streamed # session did not have enough speech to perform evaluation, and a new @@ -882,7 +900,7 @@ class Fraudster < Struct.new( # @return [String] # # @!attribute [rw] job_name - # The client-provied name for the fraudster registration job. + # The client-provided name for the fraudster registration job. # @return [String] # # @!attribute [rw] job_progress @@ -897,7 +915,7 @@ class Fraudster < Struct.new( # @!attribute [rw] output_data_config # The output data config containing the S3 location where you want # Voice ID to write your job output file; you must also include a KMS - # Key ID in order to encrypt the file. + # key iD in order to encrypt the file. # @return [Types::OutputDataConfig] # # @!attribute [rw] registration_config @@ -1382,9 +1400,9 @@ class OptOutSpeakerResponse < Struct.new( # @return [String] # # @!attribute [rw] s3_uri - # The S3 path of the folder to which Voice ID writes the job output - # file, which has a `*.out` extension. For example, if the input file - # name is `input-file.json` and the output folder path is + # The S3 path of the folder where Voice ID writes the job output file. + # It has a `*.out` extension. For example, if the input file name is + # `input-file.json` and the output folder path is # `s3://output-bucket/output-folder`, the full output file path is # `s3://output-bucket/output-folder/job-Id/input-file.json.out`. # @return [String] @@ -1398,7 +1416,7 @@ class OutputDataConfig < Struct.new( include Aws::Structure end - # The configuration definining the action to take when a duplicate + # The configuration defining the action to take when a duplicate # fraudster is detected, and the similarity threshold to use for # detecting a duplicate fraudster during a batch fraudster registration # job. @@ -1453,8 +1471,8 @@ class ResourceNotFoundException < Struct.new( include Aws::Structure end - # The configuration containing information about the customer-managed - # KMS Key used for encrypting customer data. + # The configuration containing information about the customer managed + # key used for encrypting customer data. # # @note When making an API call, you may pass ServerSideEncryptionConfiguration # data as a hash: @@ -1464,7 +1482,7 @@ class ResourceNotFoundException < Struct.new( # } # # @!attribute [rw] kms_key_id - # The identifier of the KMS Key you want Voice ID to use to encrypt + # The identifier of the KMS key you want Voice ID to use to encrypt # your data. # @return [String] # @@ -1476,6 +1494,41 @@ class ServerSideEncryptionConfiguration < Struct.new( include Aws::Structure end + # Details about the most recent server-side encryption configuration + # update. When the server-side encryption configuration is changed, + # dependency on the old KMS key is removed through an asynchronous + # process. When this update is complete, the domain’s data can only be + # accessed using the new KMS key. + # + # @!attribute [rw] message + # Message explaining the current UpdateStatus. When the UpdateStatus + # is FAILED, this message explains the cause of the failure. + # @return [String] + # + # @!attribute [rw] old_kms_key_id + # The previous KMS key ID the domain was encrypted with, before + # ServerSideEncryptionConfiguration was updated to a new KMS key ID. + # @return [String] + # + # @!attribute [rw] update_status + # Status of the server-side encryption update. During an update, if + # there is an issue with the domain's current or old KMS key ID, such + # as an inaccessible or disabled key, then the status is FAILED. In + # order to resolve this, the key needs to be made accessible, and then + # an UpdateDomain call with the existing server-side encryption + # configuration will re-attempt this update process. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ServerSideEncryptionUpdateDetails AWS API Documentation + # + class ServerSideEncryptionUpdateDetails < Struct.new( + :message, + :old_kms_key_id, + :update_status) + SENSITIVE = [] + include Aws::Structure + end + # The request exceeded the service quota. Refer to [Voice ID Service # Quotas][1] and try your request again. # @@ -1599,7 +1652,7 @@ class Speaker < Struct.new( # # @!attribute [rw] output_data_config # The output data config containing the S3 location where Voice ID - # writes the job output file; you must also include a KMS Key ID to + # writes the job output file; you must also include a KMS key ID to # encrypt the file. # @return [Types::OutputDataConfig] # @@ -1781,7 +1834,7 @@ class SpeakerSummary < Struct.new( # # @!attribute [rw] output_data_config # The output data config containing the S3 location where Voice ID - # writes the job output file; you must also include a KMS Key ID to + # writes the job output file; you must also include a KMS key ID to # encrypt the file. # @return [Types::OutputDataConfig] # @@ -1868,8 +1921,8 @@ class StartFraudsterRegistrationJobResponse < Struct.new( # # @!attribute [rw] enrollment_config # The enrollment config that contains details such as the action to - # take when a speaker is already enrolled in the Voice ID system or - # when a speaker is identified as a fraudster. + # take when a speaker is already enrolled in Voice ID or when a + # speaker is identified as a fraudster. # @return [Types::EnrollmentConfig] # # @!attribute [rw] input_data_config @@ -1883,7 +1936,7 @@ class StartFraudsterRegistrationJobResponse < Struct.new( # # @!attribute [rw] output_data_config # The output data config containing the S3 location where Voice ID - # writes the job output file; you must also include a KMS Key ID to + # writes the job output file; you must also include a KMS key ID to # encrypt the file. # @return [Types::OutputDataConfig] # @@ -2053,7 +2106,7 @@ class UntagResourceResponse < Aws::EmptyStructure; end # @return [String] # # @!attribute [rw] server_side_encryption_configuration - # The configuration, containing the KMS Key Identifier, to be used by + # The configuration, containing the KMS key identifier, to be used by # Voice ID for the server-side encryption of your data. Note that all # the existing data in the domain are still encrypted using the # existing key, only the data added to domain after updating the key