diff options
author | arcadia-devtools <arcadia-devtools@yandex-team.ru> | 2022-06-17 10:56:56 +0300 |
---|---|---|
committer | arcadia-devtools <arcadia-devtools@yandex-team.ru> | 2022-06-17 10:56:56 +0300 |
commit | 14263edb92185e889ea9e66d400cfd8eb6007125 (patch) | |
tree | c7289085a0cd8835fa39c214da55a37fc9498788 /contrib/python/botocore | |
parent | e91c5c4c2b4265bec65f9042c60ba56c60fa4e3f (diff) | |
download | ydb-14263edb92185e889ea9e66d400cfd8eb6007125.tar.gz |
intermediate changes
ref:d77adbec7a9ebece3ecae6afe7e7d7ca3d5c29e1
Diffstat (limited to 'contrib/python/botocore')
11 files changed, 2009 insertions, 222 deletions
diff --git a/contrib/python/botocore/py3/.dist-info/METADATA b/contrib/python/botocore/py3/.dist-info/METADATA index 54a4148914..1360338cd5 100644 --- a/contrib/python/botocore/py3/.dist-info/METADATA +++ b/contrib/python/botocore/py3/.dist-info/METADATA @@ -1,6 +1,6 @@ Metadata-Version: 2.1 Name: botocore -Version: 1.27.1 +Version: 1.27.2 Summary: Low-level, data-driven core of boto 3. Home-page: https://github.com/boto/botocore Author: Amazon Web Services diff --git a/contrib/python/botocore/py3/botocore/__init__.py b/contrib/python/botocore/py3/botocore/__init__.py index eafe824699..11c585f9de 100644 --- a/contrib/python/botocore/py3/botocore/__init__.py +++ b/contrib/python/botocore/py3/botocore/__init__.py @@ -16,7 +16,7 @@ import logging import os import re -__version__ = '1.27.1' +__version__ = '1.27.2' class NullHandler(logging.Handler): diff --git a/contrib/python/botocore/py3/botocore/data/application-insights/2018-11-25/service-2.json b/contrib/python/botocore/py3/botocore/data/application-insights/2018-11-25/service-2.json index 0fbc10b8d1..00880d0760 100644 --- a/contrib/python/botocore/py3/botocore/data/application-insights/2018-11-25/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/application-insights/2018-11-25/service-2.json @@ -507,8 +507,14 @@ "shape":"Remarks", "documentation":"<p>The issues on the user side that block Application Insights from successfully monitoring an application. Example remarks include:</p> <ul> <li> <p>“Configuring application, detected 1 Errors, 3 Warnings”</p> </li> <li> <p>“Configuring application, detected 1 Unconfigured Components”</p> </li> </ul>" }, - "AutoConfigEnabled":{"shape":"AutoConfigEnabled"}, - "DiscoveryType":{"shape":"DiscoveryType"} + "AutoConfigEnabled":{ + "shape":"AutoConfigEnabled", + "documentation":"<p> Indicates whether auto-configuration is turned on for this application. </p>" + }, + "DiscoveryType":{ + "shape":"DiscoveryType", + "documentation":"<p> The method used by Application Insights to onboard your resources. </p>" + } }, "documentation":"<p>Describes the status of the application.</p>" }, @@ -633,8 +639,18 @@ "shape":"TagList", "documentation":"<p>List of tags to add to the application. tag key (<code>Key</code>) and an associated tag value (<code>Value</code>). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.</p>" }, - "AutoConfigEnabled":{"shape":"AutoConfigEnabled"}, - "AutoCreate":{"shape":"AutoCreate"} + "AutoConfigEnabled":{ + "shape":"AutoConfigEnabled", + "documentation":"<p> Indicates whether Application Insights automatically configures unmonitored resources in the resource group. </p>" + }, + "AutoCreate":{ + "shape":"AutoCreate", + "documentation":"<p> Configures all of the resources in the resource group by applying the recommended configurations. </p>" + }, + "GroupingType":{ + "shape":"GroupingType", + "documentation":"<p>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 <code>ACCOUNT_BASED</code>. </p>" + } } }, "CreateApplicationResponse":{ @@ -825,7 +841,7 @@ }, "Tier":{ "shape":"Tier", - "documentation":"<p>The tier of the application component. Supported tiers include <code>DOT_NET_CORE</code>, <code>DOT_NET_WORKER</code>, <code>DOT_NET_WEB</code>, <code>SQL_SERVER</code>, and <code>DEFAULT</code>.</p>" + "documentation":"<p>The tier of the application component.</p>" } } }, @@ -1029,6 +1045,10 @@ "NOT_USEFUL" ] }, + "GroupingType":{ + "type":"string", + "enum":["ACCOUNT_BASED"] + }, "HealthEventArn":{"type":"string"}, "HealthEventDescription":{"type":"string"}, "HealthEventTypeCategory":{"type":"string"}, @@ -1242,7 +1262,10 @@ "shape":"PaginationToken", "documentation":"<p>The token to request the next page of results.</p>" }, - "ComponentName":{"shape":"ComponentName"} + "ComponentName":{ + "shape":"ComponentName", + "documentation":"<p> The name of the component. </p>" + } } }, "ListProblemsResponse":{ @@ -1256,7 +1279,10 @@ "shape":"PaginationToken", "documentation":"<p>The token used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </p>" }, - "ResourceGroupName":{"shape":"ResourceGroupName"} + "ResourceGroupName":{ + "shape":"ResourceGroupName", + "documentation":"<p> The name of the resource group. </p>" + } } }, "ListTagsForResourceRequest":{ @@ -1606,8 +1632,14 @@ "shape":"Feedback", "documentation":"<p>Feedback provided by the user about the problem.</p>" }, - "RecurringCount":{"shape":"RecurringCount"}, - "LastRecurrenceTime":{"shape":"LastRecurrenceTime"} + "RecurringCount":{ + "shape":"RecurringCount", + "documentation":"<p> The number of times that the same problem reoccurred after the first time it was resolved. </p>" + }, + "LastRecurrenceTime":{ + "shape":"LastRecurrenceTime", + "documentation":"<p> The last time that the problem reoccurred after its last resolution. </p>" + } }, "documentation":"<p>Describes a problem that is detected by correlating observations.</p>" }, @@ -1678,6 +1710,7 @@ "SeverityLevel":{ "type":"string", "enum":[ + "Informative", "Low", "Medium", "High" @@ -1856,7 +1889,10 @@ "shape":"RemoveSNSTopic", "documentation":"<p> Disassociates the SNS topic from the opsItem created for detected problems.</p>" }, - "AutoConfigEnabled":{"shape":"AutoConfigEnabled"} + "AutoConfigEnabled":{ + "shape":"AutoConfigEnabled", + "documentation":"<p> Turns auto-configuration on or off. </p>" + } } }, "UpdateApplicationResponse":{ @@ -1889,13 +1925,16 @@ }, "Tier":{ "shape":"Tier", - "documentation":"<p>The tier of the application component. Supported tiers include <code>DOT_NET_WORKER</code>, <code>DOT_NET_WEB</code>, <code>DOT_NET_CORE</code>, <code>SQL_SERVER</code>, and <code>DEFAULT</code>.</p>" + "documentation":"<p>The tier of the application component.</p>" }, "ComponentConfiguration":{ "shape":"ComponentConfiguration", "documentation":"<p>The configuration settings of the component. The value is the escaped JSON of the configuration. For more information about the JSON format, see <a href=\"https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/working-with-json.html\">Working with JSON</a>. You can send a request to <code>DescribeComponentConfigurationRecommendation</code> to see the recommended configuration for a component. For the complete format of the component configuration file, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/component-config.html\">Component Configuration</a>.</p>" }, - "AutoConfigEnabled":{"shape":"AutoConfigEnabled"} + "AutoConfigEnabled":{ + "shape":"AutoConfigEnabled", + "documentation":"<p> Automatically configures the component by applying the recommended configurations. </p>" + } } }, "UpdateComponentConfigurationResponse":{ diff --git a/contrib/python/botocore/py3/botocore/data/codeartifact/2018-09-22/service-2.json b/contrib/python/botocore/py3/botocore/data/codeartifact/2018-09-22/service-2.json index 43f4b6a1dc..41600f317d 100644 --- a/contrib/python/botocore/py3/botocore/data/codeartifact/2018-09-22/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/codeartifact/2018-09-22/service-2.json @@ -67,7 +67,7 @@ {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], - "documentation":"<p> Creates a domain. CodeArtifact <i>domains</i> 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. </p> <p>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. </p>" + "documentation":"<p> Creates a domain. CodeArtifact <i>domains</i> 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. </p> <p>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. </p>" }, "CreateRepository":{ "name":"CreateRepository", @@ -175,7 +175,7 @@ {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], - "documentation":"<p> 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. </p> <important> <p> Use <code>DeleteRepositoryPermissionsPolicy</code> with caution. After a policy is deleted, AWS users, roles, and accounts lose permissions to perform the repository actions granted by the deleted policy. </p> </important>" + "documentation":"<p> 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. </p> <important> <p> Use <code>DeleteRepositoryPermissionsPolicy</code> 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. </p> </important>" }, "DescribeDomain":{ "name":"DescribeDomain", @@ -281,7 +281,7 @@ {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], - "documentation":"<p> Generates a temporary authorization token for accessing repositories in the domain. This API requires the <code>codeartifact:GetAuthorizationToken</code> and <code>sts:GetServiceBearerToken</code> permissions. For more information about authorization tokens, see <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/tokens-authentication.html\">AWS CodeArtifact authentication and tokens</a>. </p> <note> <p>CodeArtifact authorization tokens are valid for a period of 12 hours when created with the <code>login</code> command. You can call <code>login</code> periodically to refresh the token. When you create an authorization token with the <code>GetAuthorizationToken</code> API, you can set a custom authorization period, up to a maximum of 12 hours, with the <code>durationSeconds</code> parameter.</p> <p>The authorization period begins after <code>login</code> or <code>GetAuthorizationToken</code> is called. If <code>login</code> or <code>GetAuthorizationToken</code> is called while assuming a role, the token lifetime is independent of the maximum session duration of the role. For example, if you call <code>sts assume-role</code> 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.</p> <p>See <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html\">Using IAM Roles</a> for more information on controlling session duration. </p> </note>" + "documentation":"<p> Generates a temporary authorization token for accessing repositories in the domain. This API requires the <code>codeartifact:GetAuthorizationToken</code> and <code>sts:GetServiceBearerToken</code> permissions. For more information about authorization tokens, see <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/tokens-authentication.html\">CodeArtifact authentication and tokens</a>. </p> <note> <p>CodeArtifact authorization tokens are valid for a period of 12 hours when created with the <code>login</code> command. You can call <code>login</code> periodically to refresh the token. When you create an authorization token with the <code>GetAuthorizationToken</code> API, you can set a custom authorization period, up to a maximum of 12 hours, with the <code>durationSeconds</code> parameter.</p> <p>The authorization period begins after <code>login</code> or <code>GetAuthorizationToken</code> is called. If <code>login</code> or <code>GetAuthorizationToken</code> is called while assuming a role, the token lifetime is independent of the maximum session duration of the role. For example, if you call <code>sts assume-role</code> 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.</p> <p>See <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html\">Using IAM Roles</a> for more information on controlling session duration. </p> </note>" }, "GetDomainPermissionsPolicy":{ "name":"GetDomainPermissionsPolicy", @@ -298,7 +298,7 @@ {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], - "documentation":"<p> Returns the resource policy attached to the specified domain. </p> <note> <p> The policy is a resource-based policy, not an identity-based policy. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html\">Identity-based policies and resource-based policies </a> in the <i>AWS Identity and Access Management User Guide</i>. </p> </note>" + "documentation":"<p> Returns the resource policy attached to the specified domain. </p> <note> <p> The policy is a resource-based policy, not an identity-based policy. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html\">Identity-based policies and resource-based policies </a> in the <i>IAM User Guide</i>. </p> </note>" }, "GetPackageVersionAsset":{ "name":"GetPackageVersionAsset", @@ -333,7 +333,7 @@ {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], - "documentation":"<p> 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 <code><description></code> element in the <code>pom.xml</code> file of a Maven package. </p> <p> The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText. </p>" + "documentation":"<p> Gets the readme file or descriptive text for a package version. </p> <p> The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText. </p>" }, "GetRepositoryEndpoint":{ "name":"GetRepositoryEndpoint", @@ -350,7 +350,7 @@ {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], - "documentation":"<p> Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format: </p> <ul> <li> <p> <code>npm</code> </p> </li> <li> <p> <code>pypi</code> </p> </li> <li> <p> <code>maven</code> </p> </li> </ul>" + "documentation":"<p> Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format: </p> <ul> <li> <p> <code>maven</code> </p> </li> <li> <p> <code>npm</code> </p> </li> <li> <p> <code>nuget</code> </p> </li> <li> <p> <code>pypi</code> </p> </li> </ul>" }, "GetRepositoryPermissionsPolicy":{ "name":"GetRepositoryPermissionsPolicy", @@ -383,7 +383,7 @@ {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], - "documentation":"<p> Returns a list of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html\">DomainSummary</a> objects for all domains owned by the AWS account that makes this call. Each returned <code>DomainSummary</code> object contains information about a domain. </p>" + "documentation":"<p> Returns a list of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html\">DomainSummary</a> objects for all domains owned by the Amazon Web Services account that makes this call. Each returned <code>DomainSummary</code> object contains information about a domain. </p>" }, "ListPackageVersionAssets":{ "name":"ListPackageVersionAssets", @@ -467,7 +467,7 @@ {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], - "documentation":"<p> Returns a list of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html\">RepositorySummary</a> objects. Each <code>RepositorySummary</code> contains information about a repository in the specified AWS account and that matches the input parameters. </p>" + "documentation":"<p> Returns a list of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html\">RepositorySummary</a> objects. Each <code>RepositorySummary</code> contains information about a repository in the specified Amazon Web Services account and that matches the input parameters. </p>" }, "ListRepositoriesInDomain":{ "name":"ListRepositoriesInDomain", @@ -500,7 +500,7 @@ {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], - "documentation":"<p>Gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeArtifact.</p>" + "documentation":"<p>Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.</p>" }, "PutDomainPermissionsPolicy":{ "name":"PutDomainPermissionsPolicy", @@ -555,7 +555,7 @@ {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], - "documentation":"<p>Adds or updates tags for a resource in AWS CodeArtifact.</p>" + "documentation":"<p>Adds or updates tags for a resource in CodeArtifact.</p>" }, "UntagResource":{ "name":"UntagResource", @@ -571,7 +571,7 @@ {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], - "documentation":"<p>Removes tags from a resource in AWS CodeArtifact.</p>" + "documentation":"<p>Removes tags from a resource in CodeArtifact.</p>" }, "UpdatePackageVersionsStatus":{ "name":"UpdatePackageVersionsStatus", @@ -589,7 +589,7 @@ {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], - "documentation":"<p> Updates the status of one or more versions of a package. </p>" + "documentation":"<p> Updates the status of one or more versions of a package. Using <code>UpdatePackageVersionsStatus</code>, you can update the status of package versions to <code>Archived</code>, <code>Published</code>, or <code>Unlisted</code>. To set the status of a package version to <code>Disposed</code>, use <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DisposePackageVersions.html\">DisposePackageVersions</a>. </p>" }, "UpdateRepository":{ "name":"UpdateRepository", @@ -688,7 +688,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" }, @@ -700,7 +700,7 @@ }, "externalConnection":{ "shape":"ExternalConnectionName", - "documentation":"<p> The name of the external connection to add to the repository. The following values are supported: </p> <ul> <li> <p> <code>public:npmjs</code> - for the npm public repository. </p> </li> <li> <p> <code>public:pypi</code> - for the Python Package Index. </p> </li> <li> <p> <code>public:maven-central</code> - for Maven Central. </p> </li> <li> <p> <code>public:maven-googleandroid</code> - for the Google Android repository. </p> </li> <li> <p> <code>public:maven-gradleplugins</code> - for the Gradle plugins repository. </p> </li> <li> <p> <code>public:maven-commonsware</code> - for the CommonsWare Android repository. </p> </li> </ul>", + "documentation":"<p> The name of the external connection to add to the repository. The following values are supported: </p> <ul> <li> <p> <code>public:npmjs</code> - for the npm public repository. </p> </li> <li> <p> <code>public:nuget-org</code> - for the NuGet Gallery. </p> </li> <li> <p> <code>public:pypi</code> - for the Python Package Index. </p> </li> <li> <p> <code>public:maven-central</code> - for Maven Central. </p> </li> <li> <p> <code>public:maven-googleandroid</code> - for the Google Android repository. </p> </li> <li> <p> <code>public:maven-gradleplugins</code> - for the Gradle plugins repository. </p> </li> <li> <p> <code>public:maven-commonsware</code> - for the CommonsWare Android repository. </p> </li> </ul>", "location":"querystring", "locationName":"external-connection" } @@ -732,7 +732,7 @@ }, "resourceType":{ "shape":"ResourceType", - "documentation":"<p> The type of AWS resource. </p>" + "documentation":"<p> The type of Amazon Web Services resource. </p>" } }, "documentation":"<p> The operation did not succeed because prerequisites are not met. </p>", @@ -757,7 +757,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" }, @@ -775,7 +775,7 @@ }, "format":{ "shape":"PackageFormat", - "documentation":"<p> The format of the package that is copied. The valid package types are: </p> <ul> <li> <p> <code>npm</code>: A Node Package Manager (npm) package. </p> </li> <li> <p> <code>pypi</code>: A Python Package Index (PyPI) package. </p> </li> <li> <p> <code>maven</code>: A Maven package that contains compiled code in a distributable format, such as a JAR file. </p> </li> </ul>", + "documentation":"<p> The format of the package that is copied. </p>", "location":"querystring", "locationName":"format" }, @@ -828,13 +828,13 @@ "members":{ "domain":{ "shape":"DomainName", - "documentation":"<p> 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. </p>", + "documentation":"<p> 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. </p>", "location":"querystring", "locationName":"domain" }, "encryptionKey":{ "shape":"Arn", - "documentation":"<p> 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 <code>encryptionKey</code>, your IAM role must have <code>kms:DescribeKey</code> and <code>kms:CreateGrant</code> permissions on the encryption key that is used. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestSyntax\">DescribeKey</a> in the <i>AWS Key Management Service API Reference</i> and <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\">AWS KMS API Permissions Reference</a> in the <i>AWS Key Management Service Developer Guide</i>. </p> <important> <p> CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using symmetric and asymmetric keys</a> in the <i>AWS Key Management Service Developer Guide</i>. </p> </important>" + "documentation":"<p> 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 <code>encryptionKey</code>, your IAM role must have <code>kms:DescribeKey</code> and <code>kms:CreateGrant</code> permissions on the encryption key that is used. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestSyntax\">DescribeKey</a> in the <i>Key Management Service API Reference</i> and <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\">Key Management Service API Permissions Reference</a> in the <i>Key Management Service Developer Guide</i>. </p> <important> <p> CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using symmetric and asymmetric keys</a> in the <i>Key Management Service Developer Guide</i>. </p> </important>" }, "tags":{ "shape":"TagList", @@ -866,7 +866,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" }, @@ -882,7 +882,7 @@ }, "upstreams":{ "shape":"UpstreamRepositoryList", - "documentation":"<p> 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 <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html\">Working with upstream repositories</a>. </p>" + "documentation":"<p> 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 <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html\">Working with upstream repositories</a>. </p>" }, "tags":{ "shape":"TagList", @@ -911,7 +911,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" }, @@ -944,7 +944,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" } @@ -977,7 +977,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" }, @@ -989,7 +989,7 @@ }, "format":{ "shape":"PackageFormat", - "documentation":"<p> The format of the package versions to delete. The valid values are: </p> <ul> <li> <p> <code>npm</code> </p> </li> <li> <p> <code>pypi</code> </p> </li> <li> <p> <code>maven</code> </p> </li> </ul>", + "documentation":"<p> The format of the package versions to delete. </p>", "location":"querystring", "locationName":"format" }, @@ -1011,7 +1011,7 @@ }, "expectedStatus":{ "shape":"PackageVersionStatus", - "documentation":"<p> The expected status of the package version to delete. Valid values are: </p> <ul> <li> <p> <code>Published</code> </p> </li> <li> <p> <code>Unfinished</code> </p> </li> <li> <p> <code>Unlisted</code> </p> </li> <li> <p> <code>Archived</code> </p> </li> <li> <p> <code>Disposed</code> </p> </li> </ul>" + "documentation":"<p> The expected status of the package version to delete. </p>" } } }, @@ -1020,7 +1020,7 @@ "members":{ "successfulVersions":{ "shape":"SuccessfulPackageVersionInfoMap", - "documentation":"<p> A list of the package versions that were successfully deleted. </p>" + "documentation":"<p> A list of the package versions that were successfully deleted. The status of every successful version will be <code>Deleted</code>. </p>" }, "failedVersions":{ "shape":"PackageVersionErrorMap", @@ -1043,7 +1043,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" }, @@ -1085,7 +1085,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" }, @@ -1118,7 +1118,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" } @@ -1148,7 +1148,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" }, @@ -1160,7 +1160,7 @@ }, "format":{ "shape":"PackageFormat", - "documentation":"<p> A format that specifies the type of the requested package version. The valid values are: </p> <ul> <li> <p> <code>npm</code> </p> </li> <li> <p> <code>pypi</code> </p> </li> <li> <p> <code>maven</code> </p> </li> </ul>", + "documentation":"<p> A format that specifies the type of the requested package version. </p>", "location":"querystring", "locationName":"format" }, @@ -1209,7 +1209,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" }, @@ -1251,7 +1251,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" }, @@ -1296,7 +1296,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" }, @@ -1308,7 +1308,7 @@ }, "format":{ "shape":"PackageFormat", - "documentation":"<p> A format that specifies the type of package versions you want to dispose. The valid values are: </p> <ul> <li> <p> <code>npm</code> </p> </li> <li> <p> <code>pypi</code> </p> </li> <li> <p> <code>maven</code> </p> </li> </ul>", + "documentation":"<p> A format that specifies the type of package versions you want to dispose. </p>", "location":"querystring", "locationName":"format" }, @@ -1334,7 +1334,7 @@ }, "expectedStatus":{ "shape":"PackageVersionStatus", - "documentation":"<p> The expected status of the package version to dispose. Valid values are: </p> <ul> <li> <p> <code>Published</code> </p> </li> <li> <p> <code>Unfinished</code> </p> </li> <li> <p> <code>Unlisted</code> </p> </li> <li> <p> <code>Archived</code> </p> </li> <li> <p> <code>Disposed</code> </p> </li> </ul>" + "documentation":"<p> The expected status of the package version to dispose. </p>" } } }, @@ -1360,7 +1360,7 @@ }, "owner":{ "shape":"AccountId", - "documentation":"<p> The AWS account ID that owns the domain. </p>" + "documentation":"<p> The Amazon Web Services account ID that owns the domain. </p>" }, "arn":{ "shape":"Arn", @@ -1368,7 +1368,7 @@ }, "status":{ "shape":"DomainStatus", - "documentation":"<p> The current status of a domain. The valid values are </p> <ul> <li> <p> <code>Active</code> </p> </li> <li> <p> <code>Deleted</code> </p> </li> </ul>" + "documentation":"<p> The current status of a domain. </p>" }, "createdTime":{ "shape":"Timestamp", @@ -1376,7 +1376,7 @@ }, "encryptionKey":{ "shape":"Arn", - "documentation":"<p> The ARN of an AWS Key Management Service (AWS KMS) key associated with a domain. </p>" + "documentation":"<p> The ARN of an Key Management Service (KMS) key associated with a domain. </p>" }, "repositoryCount":{ "shape":"Integer", @@ -1415,7 +1415,7 @@ }, "owner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>" + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>" }, "arn":{ "shape":"Arn", @@ -1423,7 +1423,7 @@ }, "status":{ "shape":"DomainStatus", - "documentation":"<p> A string that contains the status of the domain. The valid values are: </p> <ul> <li> <p> <code>Active</code> </p> </li> <li> <p> <code>Deleted</code> </p> </li> </ul>" + "documentation":"<p> A string that contains the status of the domain. </p>" }, "createdTime":{ "shape":"Timestamp", @@ -1461,7 +1461,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" }, @@ -1498,7 +1498,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" } @@ -1532,7 +1532,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" }, @@ -1544,7 +1544,7 @@ }, "format":{ "shape":"PackageFormat", - "documentation":"<p> A format that specifies the type of the package version with the requested asset file. The valid values are: </p> <ul> <li> <p> <code>npm</code> </p> </li> <li> <p> <code>pypi</code> </p> </li> <li> <p> <code>maven</code> </p> </li> </ul>", + "documentation":"<p> A format that specifies the type of the package version with the requested asset file. </p>", "location":"querystring", "locationName":"format" }, @@ -1626,7 +1626,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" }, @@ -1638,7 +1638,7 @@ }, "format":{ "shape":"PackageFormat", - "documentation":"<p> A format that specifies the type of the package version with the requested readme file. The valid values are: </p> <ul> <li> <p> <code>npm</code> </p> </li> <li> <p> <code>pypi</code> </p> </li> <li> <p> <code>maven</code> </p> </li> </ul>", + "documentation":"<p> A format that specifies the type of the package version with the requested readme file. </p> <note> <p>Although <code>maven</code> is listed as a valid value, CodeArtifact does not support displaying readme files for Maven packages.</p> </note>", "location":"querystring", "locationName":"format" }, @@ -1667,7 +1667,7 @@ "members":{ "format":{ "shape":"PackageFormat", - "documentation":"<p> The format of the package with the requested readme file. Valid format types are: </p> <ul> <li> <p> <code>npm</code> </p> </li> <li> <p> <code>pypi</code> </p> </li> <li> <p> <code>maven</code> </p> </li> </ul>" + "documentation":"<p> The format of the package with the requested readme file. </p>" }, "namespace":{ "shape":"PackageNamespace", @@ -1707,7 +1707,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain that contains the repository. It does not include dashes or spaces. </p>", + "documentation":"<p> 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. </p>", "location":"querystring", "locationName":"domain-owner" }, @@ -1719,7 +1719,7 @@ }, "format":{ "shape":"PackageFormat", - "documentation":"<p> Returns which endpoint of a repository to return. A repository has one endpoint for each package format: </p> <ul> <li> <p> <code>npm</code> </p> </li> <li> <p> <code>pypi</code> </p> </li> <li> <p> <code>maven</code> </p> </li> </ul>", + "documentation":"<p> Returns which endpoint of a repository to return. A repository has one endpoint for each package format. </p>", "location":"querystring", "locationName":"format" } @@ -1749,7 +1749,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" }, @@ -1792,7 +1792,7 @@ "members":{ "message":{"shape":"String"} }, - "documentation":"<p> The operation did not succeed because of an error that occurred inside AWS CodeArtifact. </p>", + "documentation":"<p> The operation did not succeed because of an error that occurred inside CodeArtifact. </p>", "error":{"httpStatusCode":500}, "exception":true, "fault":true @@ -1869,7 +1869,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" }, @@ -1881,7 +1881,7 @@ }, "format":{ "shape":"PackageFormat", - "documentation":"<p> The format of the package that contains the returned package version assets. The valid package types are: </p> <ul> <li> <p> <code>npm</code>: A Node Package Manager (npm) package. </p> </li> <li> <p> <code>pypi</code>: A Python Package Index (PyPI) package. </p> </li> <li> <p> <code>maven</code>: A Maven package that contains compiled code in a distributable format, such as a JAR file. </p> </li> </ul>", + "documentation":"<p> The format of the package that contains the returned package version assets. </p>", "location":"querystring", "locationName":"format" }, @@ -1968,7 +1968,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" }, @@ -1980,7 +1980,7 @@ }, "format":{ "shape":"PackageFormat", - "documentation":"<p> The format of the package with the requested dependencies. The valid package types are: </p> <ul> <li> <p> <code>npm</code>: A Node Package Manager (npm) package. </p> </li> <li> <p> <code>pypi</code>: A Python Package Index (PyPI) package. </p> </li> <li> <p> <code>maven</code>: A Maven package that contains compiled code in a distributable format, such as a JAR file. </p> </li> </ul>", + "documentation":"<p> The format of the package with the requested dependencies. </p>", "location":"querystring", "locationName":"format" }, @@ -2015,7 +2015,7 @@ "members":{ "format":{ "shape":"PackageFormat", - "documentation":"<p> A format that specifies the type of the package that contains the returned dependencies. The valid values are: </p> <ul> <li> <p> <code>npm</code> </p> </li> <li> <p> <code>pypi</code> </p> </li> <li> <p> <code>maven</code> </p> </li> </ul>" + "documentation":"<p> A format that specifies the type of the package that contains the returned dependencies. </p>" }, "namespace":{ "shape":"PackageNamespace", @@ -2065,7 +2065,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" }, @@ -2077,7 +2077,7 @@ }, "format":{ "shape":"PackageFormat", - "documentation":"<p> The format of the returned packages. The valid package types are: </p> <ul> <li> <p> <code>npm</code>: A Node Package Manager (npm) package. </p> </li> <li> <p> <code>pypi</code>: A Python Package Index (PyPI) package. </p> </li> <li> <p> <code>maven</code>: A Maven package that contains compiled code in a distributable format, such as a JAR file. </p> </li> </ul>", + "documentation":"<p> The format of the returned packages. </p>", "location":"querystring", "locationName":"format" }, @@ -2095,7 +2095,7 @@ }, "status":{ "shape":"PackageVersionStatus", - "documentation":"<p> A string that specifies the status of the package versions to include in the returned list. It can be one of the following: </p> <ul> <li> <p> <code>Published</code> </p> </li> <li> <p> <code>Unfinished</code> </p> </li> <li> <p> <code>Unlisted</code> </p> </li> <li> <p> <code>Archived</code> </p> </li> <li> <p> <code>Disposed</code> </p> </li> </ul>", + "documentation":"<p> A string that specifies the status of the package versions to include in the returned list. </p>", "location":"querystring", "locationName":"status" }, @@ -2128,7 +2128,7 @@ }, "format":{ "shape":"PackageFormat", - "documentation":"<p> A format of the package. Valid package format values are: </p> <ul> <li> <p> <code>npm</code> </p> </li> <li> <p> <code>pypi</code> </p> </li> <li> <p> <code>maven</code> </p> </li> </ul>" + "documentation":"<p> A format of the package. </p>" }, "namespace":{ "shape":"PackageNamespace", @@ -2168,7 +2168,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" }, @@ -2180,7 +2180,7 @@ }, "format":{ "shape":"PackageFormat", - "documentation":"<p> The format of the packages. The valid package types are: </p> <ul> <li> <p> <code>npm</code>: A Node Package Manager (npm) package. </p> </li> <li> <p> <code>pypi</code>: A Python Package Index (PyPI) package. </p> </li> <li> <p> <code>maven</code>: A Maven package that contains compiled code in a distributable format, such as a JAR file. </p> </li> </ul>", + "documentation":"<p> The format of the packages. </p>", "location":"querystring", "locationName":"format" }, @@ -2240,13 +2240,13 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" }, "administratorAccount":{ "shape":"AccountId", - "documentation":"<p> Filter the list of repositories to only include those that are managed by the AWS account ID. </p>", + "documentation":"<p> Filter the list of repositories to only include those that are managed by the Amazon Web Services account ID. </p>", "location":"querystring", "locationName":"administrator-account" }, @@ -2399,7 +2399,7 @@ "members":{ "format":{ "shape":"PackageFormat", - "documentation":"<p> The format of the package. Valid values are: </p> <ul> <li> <p> <code>npm</code> </p> </li> <li> <p> <code>pypi</code> </p> </li> <li> <p> <code>maven</code> </p> </li> </ul>" + "documentation":"<p> The format of the package. </p>" }, "namespace":{ "shape":"PackageNamespace", @@ -2427,7 +2427,7 @@ "members":{ "format":{ "shape":"PackageFormat", - "documentation":"<p> The format of the package version. The valid package formats are: </p> <ul> <li> <p> <code>npm</code>: A Node Package Manager (npm) package. </p> </li> <li> <p> <code>pypi</code>: A Python Package Index (PyPI) package. </p> </li> <li> <p> <code>maven</code>: A Maven package that contains compiled code in a distributable format, such as a JAR file. </p> </li> </ul>" + "documentation":"<p> The format of the package version. </p>" }, "namespace":{ "shape":"PackageNamespace", @@ -2471,7 +2471,7 @@ }, "status":{ "shape":"PackageVersionStatus", - "documentation":"<p> A string that contains the status of the package version. It can be one of the following: </p> <ul> <li> <p> <code>Published</code> </p> </li> <li> <p> <code>Unfinished</code> </p> </li> <li> <p> <code>Unlisted</code> </p> </li> <li> <p> <code>Archived</code> </p> </li> <li> <p> <code>Disposed</code> </p> </li> </ul>" + "documentation":"<p> A string that contains the status of the package version. </p>" } }, "documentation":"<p> Details about a package version. </p>" @@ -2554,7 +2554,7 @@ }, "status":{ "shape":"PackageVersionStatus", - "documentation":"<p> A string that contains the status of the package version. It can be one of the following: </p> <ul> <li> <p> <code>Published</code> </p> </li> <li> <p> <code>Unfinished</code> </p> </li> <li> <p> <code>Unlisted</code> </p> </li> <li> <p> <code>Archived</code> </p> </li> <li> <p> <code>Disposed</code> </p> </li> </ul>" + "documentation":"<p> A string that contains the status of the package version. It can be one of the following: </p>" } }, "documentation":"<p> Details about a package version, including its status, version, and revision. The <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html\">ListPackageVersions</a> operation returns a list of <code>PackageVersionSummary</code> objects. </p>" @@ -2593,7 +2593,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>" + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>" }, "policyRevision":{ "shape":"PolicyRevision", @@ -2630,7 +2630,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" }, @@ -2668,7 +2668,7 @@ }, "administratorAccount":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that manages the repository. </p>" + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that manages the repository. </p>" }, "domainName":{ "shape":"DomainName", @@ -2676,7 +2676,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain that contains the repository. It does not include dashes or spaces. </p>" + "documentation":"<p> 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. </p>" }, "arn":{ "shape":"Arn", @@ -2688,14 +2688,14 @@ }, "upstreams":{ "shape":"UpstreamRepositoryInfoList", - "documentation":"<p> 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 <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html\">Working with upstream repositories</a>. </p>" + "documentation":"<p> 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 <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html\">Working with upstream repositories</a>. </p>" }, "externalConnections":{ "shape":"RepositoryExternalConnectionInfoList", "documentation":"<p> An array of external connections associated with the repository. </p>" } }, - "documentation":"<p> 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 <code>npm</code> CLI, the Maven CLI (<code>mvn</code>), and <code>pip</code>. You can create up to 100 repositories per AWS account. </p>" + "documentation":"<p> 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 <code>npm</code> CLI, the Maven CLI (<code>mvn</code>), and <code>pip</code>. You can create up to 100 repositories per Amazon Web Services account. </p>" }, "RepositoryExternalConnectionInfo":{ "type":"structure", @@ -2706,7 +2706,7 @@ }, "packageFormat":{ "shape":"PackageFormat", - "documentation":"<p> The package format associated with a repository's external connection. The valid package formats are: </p> <ul> <li> <p> <code>npm</code>: A Node Package Manager (npm) package. </p> </li> <li> <p> <code>pypi</code>: A Python Package Index (PyPI) package. </p> </li> <li> <p> <code>maven</code>: A Maven package that contains compiled code in a distributable format, such as a JAR file. </p> </li> </ul>" + "documentation":"<p> The package format associated with a repository's external connection. The valid package formats are: </p> <ul> <li> <p> <code>npm</code>: A Node Package Manager (npm) package. </p> </li> <li> <p> <code>pypi</code>: A Python Package Index (PyPI) package. </p> </li> <li> <p> <code>maven</code>: A Maven package that contains compiled code in a distributable format, such as a JAR file. </p> </li> <li> <p> <code>nuget</code>: A NuGet package. </p> </li> </ul>" }, "status":{ "shape":"ExternalConnectionStatus", @@ -2734,7 +2734,7 @@ }, "administratorAccount":{ "shape":"AccountId", - "documentation":"<p> The AWS account ID that manages the repository. </p>" + "documentation":"<p> The Amazon Web Services account ID that manages the repository. </p>" }, "domainName":{ "shape":"DomainName", @@ -2742,7 +2742,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>" + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>" }, "arn":{ "shape":"Arn", @@ -2770,7 +2770,7 @@ }, "resourceType":{ "shape":"ResourceType", - "documentation":"<p> The type of AWS resource. </p>" + "documentation":"<p> The type of Amazon Web Services resource. </p>" } }, "documentation":"<p> The operation did not succeed because the resource requested is not found in the service. </p>", @@ -2793,7 +2793,7 @@ "documentation":"<p> The resource policy formatted in JSON. </p>" } }, - "documentation":"<p> An AWS CodeArtifact resource policy that contains a resource ARN, document details, and a revision. </p>" + "documentation":"<p> An CodeArtifact resource policy that contains a resource ARN, document details, and a revision. </p>" }, "ResourceType":{ "type":"string", @@ -2817,7 +2817,7 @@ }, "resourceType":{ "shape":"ResourceType", - "documentation":"<p> The type of AWS resource. </p>" + "documentation":"<p> The type of Amazon Web Services resource. </p>" } }, "documentation":"<p> The operation did not succeed because it would have exceeded a service limit for your account. </p>", @@ -2839,7 +2839,7 @@ }, "status":{ "shape":"PackageVersionStatus", - "documentation":"<p> The status of a package version. Valid statuses are: </p> <ul> <li> <p> <code>Published</code> </p> </li> <li> <p> <code>Unfinished</code> </p> </li> <li> <p> <code>Unlisted</code> </p> </li> <li> <p> <code>Archived</code> </p> </li> <li> <p> <code>Disposed</code> </p> </li> </ul>" + "documentation":"<p> The status of a package version. </p>" } }, "documentation":"<p> Contains the revision and status of a package version. </p>" @@ -2865,7 +2865,7 @@ "documentation":"<p>The tag value.</p>" } }, - "documentation":"<p>A tag is a key-value pair that can be used to manage, search for, or filter resources in AWS CodeArtifact.</p>" + "documentation":"<p>A tag is a key-value pair that can be used to manage, search for, or filter resources in CodeArtifact.</p>" }, "TagKey":{ "type":"string", @@ -2973,7 +2973,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" }, @@ -2985,7 +2985,7 @@ }, "format":{ "shape":"PackageFormat", - "documentation":"<p> A format that specifies the type of the package with the statuses to update. The valid values are: </p> <ul> <li> <p> <code>npm</code> </p> </li> <li> <p> <code>pypi</code> </p> </li> <li> <p> <code>maven</code> </p> </li> </ul>", + "documentation":"<p> A format that specifies the type of the package with the statuses to update. </p>", "location":"querystring", "locationName":"format" }, @@ -3047,7 +3047,7 @@ }, "domainOwner":{ "shape":"AccountId", - "documentation":"<p> The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces. </p>", + "documentation":"<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>", "location":"querystring", "locationName":"domain-owner" }, @@ -3063,7 +3063,7 @@ }, "upstreams":{ "shape":"UpstreamRepositoryList", - "documentation":"<p> 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 <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html\">Working with upstream repositories</a>. </p>" + "documentation":"<p> 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 <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html\">Working with upstream repositories</a>. </p>" } } }, @@ -3130,5 +3130,5 @@ ] } }, - "documentation":"<p> 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. </p> <p> <b>AWS CodeArtifact Components</b> </p> <p>Use the information in this guide to help you work with the following CodeArtifact components:</p> <ul> <li> <p> <b>Repository</b>: A CodeArtifact repository contains a set of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html#welcome-concepts-package-version\">package versions</a>, each of which maps to a set of assets, or files. Repositories are polyglot, so a single repository can contain packages of any supported type. Each repository exposes endpoints for fetching and publishing packages using tools like the <b> <code>npm</code> </b> CLI, the Maven CLI (<b> <code>mvn</code> </b>), and <b> <code>pip</code> </b>.</p> </li> <li> <p> <b>Domain</b>: Repositories are aggregated into a higher-level entity known as a <i>domain</i>. All package assets and metadata are stored in the domain, but are consumed through repositories. A given package asset, such as a Maven JAR file, is stored once per domain, no matter how many repositories it's present in. All of the assets and metadata in a domain are encrypted with the same customer master key (CMK) stored in AWS Key Management Service (AWS KMS).</p> <p>Each repository is a member of a single domain and can't be moved to a different domain.</p> <p>The domain allows organizational policy to be applied across multiple repositories, such as which accounts can access repositories in the domain, and which public repositories can be used as sources of packages.</p> <p>Although an organization can have multiple domains, we recommend a single production domain that contains all published artifacts so that teams can find and share packages across their organization.</p> </li> <li> <p> <b>Package</b>: A <i>package</i> is a bundle of software and the metadata required to resolve dependencies and install the software. CodeArtifact supports <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/using-npm.html\">npm</a>, <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/using-python.html\">PyPI</a>, and <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/using-maven\">Maven</a> package formats.</p> <p>In CodeArtifact, a package consists of:</p> <ul> <li> <p>A <i>name</i> (for example, <code>webpack</code> is the name of a popular npm package)</p> </li> <li> <p>An optional namespace (for example, <code>@types</code> in <code>@types/node</code>)</p> </li> <li> <p>A set of versions (for example, <code>1.0.0</code>, <code>1.0.1</code>, <code>1.0.2</code>, etc.)</p> </li> <li> <p> Package-level metadata (for example, npm tags)</p> </li> </ul> </li> <li> <p> <b>Package version</b>: A version of a package, such as <code>@types/node 12.6.9</code>. The version number format and semantics vary for different package formats. For example, npm package versions must conform to the <a href=\"https://semver.org/\">Semantic Versioning specification</a>. In CodeArtifact, a package version consists of the version identifier, metadata at the package version level, and a set of assets.</p> </li> <li> <p> <b>Upstream repository</b>: One repository is <i>upstream</i> of another when the package versions in it can be accessed from the repository endpoint of the downstream repository, effectively merging the contents of the two repositories from the point of view of a client. CodeArtifact allows creating an upstream relationship between two repositories.</p> </li> <li> <p> <b>Asset</b>: An individual file stored in CodeArtifact associated with a package version, such as an npm <code>.tgz</code> file or Maven POM and JAR files.</p> </li> </ul> <p>CodeArtifact supports these operations:</p> <ul> <li> <p> <code>AssociateExternalConnection</code>: Adds an existing external connection to a repository. </p> </li> <li> <p> <code>CopyPackageVersions</code>: Copies package versions from one repository to another repository in the same domain.</p> </li> <li> <p> <code>CreateDomain</code>: Creates a domain</p> </li> <li> <p> <code>CreateRepository</code>: Creates a CodeArtifact repository in a domain. </p> </li> <li> <p> <code>DeleteDomain</code>: Deletes a domain. You cannot delete a domain that contains repositories. </p> </li> <li> <p> <code>DeleteDomainPermissionsPolicy</code>: Deletes the resource policy that is set on a domain.</p> </li> <li> <p> <code>DeletePackageVersions</code>: Deletes versions of a package. After a package has been deleted, it can be republished, but its assets and metadata cannot be restored because they have been permanently removed from storage.</p> </li> <li> <p> <code>DeleteRepository</code>: Deletes a repository. </p> </li> <li> <p> <code>DeleteRepositoryPermissionsPolicy</code>: Deletes the resource policy that is set on a repository.</p> </li> <li> <p> <code>DescribeDomain</code>: Returns a <code>DomainDescription</code> object that contains information about the requested domain.</p> </li> <li> <p> <code>DescribePackageVersion</code>: Returns a <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html\">PackageVersionDescription</a> object that contains details about a package version. </p> </li> <li> <p> <code>DescribeRepository</code>: Returns a <code>RepositoryDescription</code> object that contains detailed information about the requested repository. </p> </li> <li> <p> <code>DisposePackageVersions</code>: Disposes versions of a package. A package version with the status <code>Disposed</code> cannot be restored because they have been permanently removed from storage.</p> </li> <li> <p> <code>DisassociateExternalConnection</code>: Removes an existing external connection from a repository. </p> </li> <li> <p> <code>GetAuthorizationToken</code>: Generates a temporary authorization token for accessing repositories in the domain. The token expires the authorization period has passed. The default authorization period is 12 hours and can be customized to any length with a maximum of 12 hours.</p> </li> <li> <p> <code>GetDomainPermissionsPolicy</code>: Returns the policy of a resource that is attached to the specified domain. </p> </li> <li> <p> <code>GetPackageVersionAsset</code>: Returns the contents of an asset that is in a package version. </p> </li> <li> <p> <code>GetPackageVersionReadme</code>: Gets the readme file or descriptive text for a package version.</p> </li> <li> <p> <code>GetRepositoryEndpoint</code>: Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format: </p> <ul> <li> <p> <code>npm</code> </p> </li> <li> <p> <code>pypi</code> </p> </li> <li> <p> <code>maven</code> </p> </li> </ul> </li> <li> <p> <code>GetRepositoryPermissionsPolicy</code>: Returns the resource policy that is set on a repository. </p> </li> <li> <p> <code>ListDomains</code>: Returns a list of <code>DomainSummary</code> objects. Each returned <code>DomainSummary</code> object contains information about a domain.</p> </li> <li> <p> <code>ListPackages</code>: Lists the packages in a repository.</p> </li> <li> <p> <code>ListPackageVersionAssets</code>: Lists the assets for a given package version.</p> </li> <li> <p> <code>ListPackageVersionDependencies</code>: Returns a list of the direct dependencies for a package version. </p> </li> <li> <p> <code>ListPackageVersions</code>: Returns a list of package versions for a specified package in a repository.</p> </li> <li> <p> <code>ListRepositories</code>: Returns a list of repositories owned by the AWS account that called this method.</p> </li> <li> <p> <code>ListRepositoriesInDomain</code>: Returns a list of the repositories in a domain.</p> </li> <li> <p> <code>PutDomainPermissionsPolicy</code>: Attaches a resource policy to a domain.</p> </li> <li> <p> <code>PutRepositoryPermissionsPolicy</code>: Sets the resource policy on a repository that specifies permissions to access it. </p> </li> <li> <p> <code>UpdatePackageVersionsStatus</code>: Updates the status of one or more versions of a package.</p> </li> <li> <p> <code>UpdateRepository</code>: Updates the properties of a repository.</p> </li> </ul>" + "documentation":"<p> 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. </p> <p> <b>CodeArtifact Components</b> </p> <p>Use the information in this guide to help you work with the following CodeArtifact components:</p> <ul> <li> <p> <b>Repository</b>: A CodeArtifact repository contains a set of <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html#welcome-concepts-package-version\">package versions</a>, each of which maps to a set of assets, or files. Repositories are polyglot, so a single repository can contain packages of any supported type. Each repository exposes endpoints for fetching and publishing packages using tools like the <b> <code>npm</code> </b> CLI, the Maven CLI (<b> <code>mvn</code> </b>), Python CLIs (<b> <code>pip</code> </b> and <code>twine</code>), and NuGet CLIs (<code>nuget</code> and <code>dotnet</code>).</p> </li> <li> <p> <b>Domain</b>: Repositories are aggregated into a higher-level entity known as a <i>domain</i>. All package assets and metadata are stored in the domain, but are consumed through repositories. A given package asset, such as a Maven JAR file, is stored once per domain, no matter how many repositories it's present in. All of the assets and metadata in a domain are encrypted with the same customer master key (CMK) stored in Key Management Service (KMS).</p> <p>Each repository is a member of a single domain and can't be moved to a different domain.</p> <p>The domain allows organizational policy to be applied across multiple repositories, such as which accounts can access repositories in the domain, and which public repositories can be used as sources of packages.</p> <p>Although an organization can have multiple domains, we recommend a single production domain that contains all published artifacts so that teams can find and share packages across their organization.</p> </li> <li> <p> <b>Package</b>: A <i>package</i> is a bundle of software and the metadata required to resolve dependencies and install the software. CodeArtifact supports <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/using-npm.html\">npm</a>, <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/using-python.html\">PyPI</a>, <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/using-maven\">Maven</a>, and <a href=\"https://docs.aws.amazon.com/codeartifact/latest/ug/using-nuget\">NuGet</a> package formats.</p> <p>In CodeArtifact, a package consists of:</p> <ul> <li> <p>A <i>name</i> (for example, <code>webpack</code> is the name of a popular npm package)</p> </li> <li> <p>An optional namespace (for example, <code>@types</code> in <code>@types/node</code>)</p> </li> <li> <p>A set of versions (for example, <code>1.0.0</code>, <code>1.0.1</code>, <code>1.0.2</code>, etc.)</p> </li> <li> <p> Package-level metadata (for example, npm tags)</p> </li> </ul> </li> <li> <p> <b>Package version</b>: A version of a package, such as <code>@types/node 12.6.9</code>. The version number format and semantics vary for different package formats. For example, npm package versions must conform to the <a href=\"https://semver.org/\">Semantic Versioning specification</a>. In CodeArtifact, a package version consists of the version identifier, metadata at the package version level, and a set of assets.</p> </li> <li> <p> <b>Upstream repository</b>: One repository is <i>upstream</i> of another when the package versions in it can be accessed from the repository endpoint of the downstream repository, effectively merging the contents of the two repositories from the point of view of a client. CodeArtifact allows creating an upstream relationship between two repositories.</p> </li> <li> <p> <b>Asset</b>: An individual file stored in CodeArtifact associated with a package version, such as an npm <code>.tgz</code> file or Maven POM and JAR files.</p> </li> </ul> <p>CodeArtifact supports these operations:</p> <ul> <li> <p> <code>AssociateExternalConnection</code>: Adds an existing external connection to a repository. </p> </li> <li> <p> <code>CopyPackageVersions</code>: Copies package versions from one repository to another repository in the same domain.</p> </li> <li> <p> <code>CreateDomain</code>: Creates a domain</p> </li> <li> <p> <code>CreateRepository</code>: Creates a CodeArtifact repository in a domain. </p> </li> <li> <p> <code>DeleteDomain</code>: Deletes a domain. You cannot delete a domain that contains repositories. </p> </li> <li> <p> <code>DeleteDomainPermissionsPolicy</code>: Deletes the resource policy that is set on a domain.</p> </li> <li> <p> <code>DeletePackageVersions</code>: Deletes versions of a package. After a package has been deleted, it can be republished, but its assets and metadata cannot be restored because they have been permanently removed from storage.</p> </li> <li> <p> <code>DeleteRepository</code>: Deletes a repository. </p> </li> <li> <p> <code>DeleteRepositoryPermissionsPolicy</code>: Deletes the resource policy that is set on a repository.</p> </li> <li> <p> <code>DescribeDomain</code>: Returns a <code>DomainDescription</code> object that contains information about the requested domain.</p> </li> <li> <p> <code>DescribePackageVersion</code>: Returns a <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html\">PackageVersionDescription</a> object that contains details about a package version. </p> </li> <li> <p> <code>DescribeRepository</code>: Returns a <code>RepositoryDescription</code> object that contains detailed information about the requested repository. </p> </li> <li> <p> <code>DisposePackageVersions</code>: Disposes versions of a package. A package version with the status <code>Disposed</code> cannot be restored because they have been permanently removed from storage.</p> </li> <li> <p> <code>DisassociateExternalConnection</code>: Removes an existing external connection from a repository. </p> </li> <li> <p> <code>GetAuthorizationToken</code>: Generates a temporary authorization token for accessing repositories in the domain. The token expires the authorization period has passed. The default authorization period is 12 hours and can be customized to any length with a maximum of 12 hours.</p> </li> <li> <p> <code>GetDomainPermissionsPolicy</code>: Returns the policy of a resource that is attached to the specified domain. </p> </li> <li> <p> <code>GetPackageVersionAsset</code>: Returns the contents of an asset that is in a package version. </p> </li> <li> <p> <code>GetPackageVersionReadme</code>: Gets the readme file or descriptive text for a package version.</p> </li> <li> <p> <code>GetRepositoryEndpoint</code>: Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format: </p> <ul> <li> <p> <code>maven</code> </p> </li> <li> <p> <code>npm</code> </p> </li> <li> <p> <code>nuget</code> </p> </li> <li> <p> <code>pypi</code> </p> </li> </ul> </li> <li> <p> <code>GetRepositoryPermissionsPolicy</code>: Returns the resource policy that is set on a repository. </p> </li> <li> <p> <code>ListDomains</code>: Returns a list of <code>DomainSummary</code> objects. Each returned <code>DomainSummary</code> object contains information about a domain.</p> </li> <li> <p> <code>ListPackages</code>: Lists the packages in a repository.</p> </li> <li> <p> <code>ListPackageVersionAssets</code>: Lists the assets for a given package version.</p> </li> <li> <p> <code>ListPackageVersionDependencies</code>: Returns a list of the direct dependencies for a package version. </p> </li> <li> <p> <code>ListPackageVersions</code>: Returns a list of package versions for a specified package in a repository.</p> </li> <li> <p> <code>ListRepositories</code>: Returns a list of repositories owned by the Amazon Web Services account that called this method.</p> </li> <li> <p> <code>ListRepositoriesInDomain</code>: Returns a list of the repositories in a domain.</p> </li> <li> <p> <code>PutDomainPermissionsPolicy</code>: Attaches a resource policy to a domain.</p> </li> <li> <p> <code>PutRepositoryPermissionsPolicy</code>: Sets the resource policy on a repository that specifies permissions to access it. </p> </li> <li> <p> <code>UpdatePackageVersionsStatus</code>: Updates the status of one or more versions of a package.</p> </li> <li> <p> <code>UpdateRepository</code>: Updates the properties of a repository.</p> </li> </ul>" } diff --git a/contrib/python/botocore/py3/botocore/data/connect/2017-08-08/paginators-1.json b/contrib/python/botocore/py3/botocore/data/connect/2017-08-08/paginators-1.json index aff2bb5f20..8aeffb019e 100644 --- a/contrib/python/botocore/py3/botocore/data/connect/2017-08-08/paginators-1.json +++ b/contrib/python/botocore/py3/botocore/data/connect/2017-08-08/paginators-1.json @@ -193,6 +193,12 @@ ], "output_token": "NextToken", "result_key": "Users" + }, + "ListTaskTemplates": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "TaskTemplates" } } } diff --git a/contrib/python/botocore/py3/botocore/data/connect/2017-08-08/service-2.json b/contrib/python/botocore/py3/botocore/data/connect/2017-08-08/service-2.json index c85d2bdcbc..1db5368c5d 100644 --- a/contrib/python/botocore/py3/botocore/data/connect/2017-08-08/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/connect/2017-08-08/service-2.json @@ -396,6 +396,24 @@ ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Creates a security profile.</p>" }, + "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"} + ], + "documentation":"<p>Creates a new task template in the specified Amazon Connect instance.</p>" + }, "CreateUseCase":{ "name":"CreateUseCase", "http":{ @@ -584,6 +602,23 @@ ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Deletes a security profile.</p>" }, + "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"} + ], + "documentation":"<p>Deletes the task template.</p>" + }, "DeleteUseCase":{ "name":"DeleteUseCase", "http":{ @@ -1149,6 +1184,23 @@ ], "documentation":"<p>Gets historical metric data from the specified Amazon Connect instance.</p> <p>For a description of each historical metric, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html\">Historical Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, + "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"} + ], + "documentation":"<p>Gets details about a specific task template in the specified Amazon Connect instance.</p>" + }, "ListAgentStatuses":{ "name":"ListAgentStatuses", "http":{ @@ -1586,6 +1638,23 @@ ], "documentation":"<p>Lists the tags for the specified resource.</p> <p>For sample policies that use tags, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html\">Amazon Connect Identity-Based Policy Examples</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" }, + "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"} + ], + "documentation":"<p>Lists task templates for the specified Amazon Connect instance.</p>" + }, "ListUseCases":{ "name":"ListUseCases", "http":{ @@ -1900,7 +1969,26 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], - "documentation":"<p>Adds the specified tags to the specified resource.</p> <p>The supported resource types are users, routing profiles, queues, quick connects, contact flows, agent status, hours of operation, and phone number.</p> <p>For sample policies that use tags, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html\">Amazon Connect Identity-Based Policy Examples</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" + "documentation":"<p>Adds the specified tags to the specified resource.</p> <p>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.</p> <p>For sample policies that use tags, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html\">Amazon Connect Identity-Based Policy Examples</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" + }, + "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"} + ], + "documentation":"<p>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.</p> <p>Note the following requirements:</p> <ul> <li> <p>Transfer is supported for only <code>TASK</code> contacts.</p> </li> <li> <p>Do not use both <code>QueueId</code> and <code>UserId</code> in the same call.</p> </li> <li> <p>The following contact flow types are supported: Inbound contact flow, Transfer to agent flow, and Transfer to queue flow.</p> </li> <li> <p>The <code>TransferContact</code> API can be called only on active contacts.</p> </li> <li> <p>A contact cannot be transferred more than 11 times.</p> </li> </ul>" }, "UntagResource":{ "name":"UntagResource", @@ -2337,6 +2425,24 @@ ], "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Updates a security profile.</p>" }, + "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"} + ], + "documentation":"<p>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.</p>" + }, "UpdateUserHierarchy":{ "name":"UpdateUserHierarchy", "http":{ @@ -2876,14 +2982,14 @@ }, "Value":{ "shape":"ReferenceValue", - "documentation":"<p>Contains the location path of the attachment reference.</p>" + "documentation":"<p>The location path of the attachment reference.</p>" }, "Status":{ "shape":"ReferenceStatus", - "documentation":"<p>Status of an attachment reference type.</p>" + "documentation":"<p>Status of the attachment reference type.</p>" } }, - "documentation":"<p>Information about the attachment reference if the <code>referenceType</code> is <code>ATTACHMENT</code>. Otherwise, null.</p>" + "documentation":"<p>Information about a reference when the <code>referenceType</code> is <code>ATTACHMENT</code>. Otherwise, null.</p>" }, "Attribute":{ "type":"structure", @@ -3949,6 +4055,72 @@ } } }, + "CreateTaskTemplateRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Name", + "Fields" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", + "location":"uri", + "locationName":"InstanceId" + }, + "Name":{ + "shape":"TaskTemplateName", + "documentation":"<p>The name of the task template.</p>" + }, + "Description":{ + "shape":"TaskTemplateDescription", + "documentation":"<p>The description of the task template.</p>" + }, + "ContactFlowId":{ + "shape":"ContactFlowId", + "documentation":"<p>The identifier of the flow that runs by default when a task is created by referencing this template.</p>" + }, + "Constraints":{ + "shape":"TaskTemplateConstraints", + "documentation":"<p>Constraints that are applicable to the fields listed.</p>" + }, + "Defaults":{ + "shape":"TaskTemplateDefaults", + "documentation":"<p>The default values for fields when a task is created by referencing this template.</p>" + }, + "Status":{ + "shape":"TaskTemplateStatus", + "documentation":"<p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it. Tasks can only be created from <code>ACTIVE</code> templates. If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created. </p>" + }, + "Fields":{ + "shape":"TaskTemplateFields", + "documentation":"<p>Fields that are part of the template.</p>" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", + "idempotencyToken":true + } + } + }, + "CreateTaskTemplateResponse":{ + "type":"structure", + "required":[ + "Id", + "Arn" + ], + "members":{ + "Id":{ + "shape":"TaskTemplateId", + "documentation":"<p>The identifier of the task template resource.</p>" + }, + "Arn":{ + "shape":"TaskTemplateArn", + "documentation":"<p>The Amazon Resource Name (ARN) for the task template resource.</p>" + } + } + }, "CreateUseCaseRequest":{ "type":"structure", "required":[ @@ -4255,6 +4427,20 @@ "type":"list", "member":{"shape":"CurrentMetric"} }, + "DateReference":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ReferenceKey", + "documentation":"<p>Identifier of the date reference.</p>" + }, + "Value":{ + "shape":"ReferenceValue", + "documentation":"<p>A valid date.</p>" + } + }, + "documentation":"<p>Information about a reference when the <code>referenceType</code> is <code>DATE</code>. Otherwise, null.</p>" + }, "DefaultVocabulary":{ "type":"structure", "required":[ @@ -4435,6 +4621,32 @@ } } }, + "DeleteTaskTemplateRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "TaskTemplateId" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", + "location":"uri", + "locationName":"InstanceId" + }, + "TaskTemplateId":{ + "shape":"TaskTemplateId", + "documentation":"<p>A unique identifier for the task template.</p>", + "location":"uri", + "locationName":"TaskTemplateId" + } + } + }, + "DeleteTaskTemplateResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteUseCaseRequest":{ "type":"structure", "required":[ @@ -5316,6 +5528,20 @@ "exception":true }, "Email":{"type":"string"}, + "EmailReference":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ReferenceKey", + "documentation":"<p>Identifier of the email reference.</p>" + }, + "Value":{ + "shape":"ReferenceValue", + "documentation":"<p>A valid email address.</p>" + } + }, + "documentation":"<p>Information about a reference when the <code>referenceType</code> is <code>EMAIL</code>. Otherwise, null.</p>" + }, "EncryptionConfig":{ "type":"structure", "required":[ @@ -5526,6 +5752,95 @@ } } }, + "GetTaskTemplateRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "TaskTemplateId" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", + "location":"uri", + "locationName":"InstanceId" + }, + "TaskTemplateId":{ + "shape":"TaskTemplateId", + "documentation":"<p>A unique identifier for the task template.</p>", + "location":"uri", + "locationName":"TaskTemplateId" + }, + "SnapshotVersion":{ + "shape":"SnapshotVersion", + "documentation":"<p>The system generated version of a task template that is associated with a task, when the task is created.</p>", + "location":"querystring", + "locationName":"snapshotVersion" + } + } + }, + "GetTaskTemplateResponse":{ + "type":"structure", + "required":[ + "Id", + "Arn", + "Name" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>" + }, + "Id":{ + "shape":"TaskTemplateId", + "documentation":"<p>A unique identifier for the task template.</p>" + }, + "Arn":{ + "shape":"TaskTemplateArn", + "documentation":"<p>The Amazon Resource Name (ARN).</p>" + }, + "Name":{ + "shape":"TaskTemplateName", + "documentation":"<p>The name of the task template.</p>" + }, + "Description":{ + "shape":"TaskTemplateDescription", + "documentation":"<p>The description of the task template.</p>" + }, + "ContactFlowId":{ + "shape":"ContactFlowId", + "documentation":"<p>The identifier of the flow that runs by default when a task is created by referencing this template.</p>" + }, + "Constraints":{ + "shape":"TaskTemplateConstraints", + "documentation":"<p>Constraints that are applicable to the fields listed.</p>" + }, + "Defaults":{ + "shape":"TaskTemplateDefaults", + "documentation":"<p>The default values for fields when a task is created by referencing this template.</p>" + }, + "Fields":{ + "shape":"TaskTemplateFields", + "documentation":"<p>Fields that are part of the template.</p>" + }, + "Status":{ + "shape":"TaskTemplateStatus", + "documentation":"<p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it. Tasks can only be created from <code>ACTIVE</code> templates. If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>" + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"<p>The timestamp when the task template was last modified.</p>" + }, + "CreatedTime":{ + "shape":"timestamp", + "documentation":"<p>The timestamp when the task template was created.</p>" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"<p>The tags used to organize, track, or control access for this resource.</p>" + } + } + }, "Grouping":{ "type":"string", "enum":[ @@ -6255,6 +6570,20 @@ "error":{"httpStatusCode":400}, "exception":true }, + "InvisibleFieldInfo":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"TaskTemplateFieldIdentifier", + "documentation":"<p>Identifier of the invisible field.</p>" + } + }, + "documentation":"<p>A field that is invisible to an agent.</p>" + }, + "InvisibleTaskTemplateFields":{ + "type":"list", + "member":{"shape":"InvisibleFieldInfo"} + }, "KeyId":{ "type":"string", "max":128, @@ -7477,6 +7806,56 @@ } } }, + "ListTaskTemplatesRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", + "location":"uri", + "locationName":"InstanceId" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"<p>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.</p> <important> <p>It is not expected that you set this because the value returned in the previous response is always null.</p> </important>", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResult100", + "documentation":"<p>The maximum number of results to return per page.</p> <important> <p>It is not expected that you set this.</p> </important>", + "box":true, + "location":"querystring", + "locationName":"maxResults" + }, + "Status":{ + "shape":"TaskTemplateStatus", + "documentation":"<p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it. Tasks can only be created from <code>ACTIVE</code> templates. If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>", + "location":"querystring", + "locationName":"status" + }, + "Name":{ + "shape":"TaskTemplateName", + "documentation":"<p>The name of the task template.</p>", + "location":"querystring", + "locationName":"name" + } + } + }, + "ListTaskTemplatesResponse":{ + "type":"structure", + "members":{ + "TaskTemplates":{ + "shape":"TaskTemplateList", + "documentation":"<p>Provides details about a list of task templates belonging to an instance.</p>" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"<p>If there are additional results, this is the token for the next set of results.</p> <important> <p>This is always returned as a null in the response.</p> </important>" + } + } + }, "ListUseCasesRequest":{ "type":"structure", "required":[ @@ -7670,6 +8049,20 @@ "max":2500, "min":1 }, + "NumberReference":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ReferenceKey", + "documentation":"<p>Identifier of the number reference.</p>" + }, + "Value":{ + "shape":"ReferenceValue", + "documentation":"<p>A valid number.</p>" + } + }, + "documentation":"<p>Information about a reference when the <code>referenceType</code> is <code>NUMBER</code>. Otherwise, null.</p>" + }, "Origin":{ "type":"string", "max":267 @@ -8162,6 +8555,55 @@ "type":"list", "member":{"shape":"PromptSummary"} }, + "PropertyValidationException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"Message"}, + "PropertyList":{"shape":"PropertyValidationExceptionPropertyList"} + }, + "documentation":"<p/>", + "error":{"httpStatusCode":400}, + "exception":true + }, + "PropertyValidationExceptionProperty":{ + "type":"structure", + "required":[ + "PropertyPath", + "Reason", + "Message" + ], + "members":{ + "PropertyPath":{ + "shape":"String", + "documentation":"<p>The full property path.</p>" + }, + "Reason":{ + "shape":"PropertyValidationExceptionReason", + "documentation":"<p>Why the property is not valid.</p>" + }, + "Message":{ + "shape":"Message", + "documentation":"<p>A message describing why the property is not valid.</p>" + } + }, + "documentation":"<p>Contains information about why a property is not valid.</p>" + }, + "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":[ @@ -8457,6 +8899,20 @@ "max":50, "min":1 }, + "ReadOnlyFieldInfo":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"TaskTemplateFieldIdentifier", + "documentation":"<p>Identifier of the read-only field.</p>" + } + }, + "documentation":"<p>Indicates a field that is read-only to an agent.</p>" + }, + "ReadOnlyTaskTemplateFields":{ + "type":"list", + "member":{"shape":"ReadOnlyFieldInfo"} + }, "Reference":{ "type":"structure", "required":[ @@ -8470,10 +8926,10 @@ }, "Type":{ "shape":"ReferenceType", - "documentation":"<p>The type of the reference. Only <code>URL</code> type can be added or updated on a contact.</p>" + "documentation":"<p>The type of the reference.</p>" } }, - "documentation":"<p>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.</p>" + "documentation":"<p>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.</p>" }, "ReferenceKey":{ "type":"string", @@ -8492,11 +8948,27 @@ "members":{ "Url":{ "shape":"UrlReference", - "documentation":"<p>Information about the URL reference if the <code>referenceType</code> is <code>URL</code>. Otherwise, null.</p>" + "documentation":"<p>Information about the reference when the <code>referenceType</code> is <code>URL</code>. Otherwise, null.</p>" }, "Attachment":{ "shape":"AttachmentReference", - "documentation":"<p>Information about the attachment reference if the <code>referenceType</code> is <code>ATTACHMENT</code>. Otherwise, null.</p>" + "documentation":"<p>Information about the reference when the <code>referenceType</code> is <code>ATTACHMENT</code>. Otherwise, null.</p>" + }, + "String":{ + "shape":"StringReference", + "documentation":"<p>Information about a reference when the <code>referenceType</code> is <code>STRING</code>. Otherwise, null.</p>" + }, + "Number":{ + "shape":"NumberReference", + "documentation":"<p>Information about a reference when the <code>referenceType</code> is <code>NUMBER</code>. Otherwise, null.</p>" + }, + "Date":{ + "shape":"DateReference", + "documentation":"<p>Information about a reference when the <code>referenceType</code> is <code>DATE</code>. Otherwise, null.</p>" + }, + "Email":{ + "shape":"EmailReference", + "documentation":"<p>Information about a reference when the <code>referenceType</code> is <code>EMAIL</code>. Otherwise, null.</p>" } }, "documentation":"<p>Contains summary information about a reference. <code>ReferenceSummary</code> contains only one non null field between the URL and attachment based on the reference type.</p>", @@ -8510,13 +8982,17 @@ "type":"string", "enum":[ "URL", - "ATTACHMENT" + "ATTACHMENT", + "NUMBER", + "STRING", + "DATE", + "EMAIL" ] }, "ReferenceTypes":{ "type":"list", "member":{"shape":"ReferenceType"}, - "max":2 + "max":6 }, "ReferenceValue":{ "type":"string", @@ -8542,6 +9018,20 @@ } } }, + "RequiredFieldInfo":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"TaskTemplateFieldIdentifier", + "documentation":"<p>The unique identifier for the field.</p>" + } + }, + "documentation":"<p>Information about a required field.</p>" + }, + "RequiredTaskTemplateFields":{ + "type":"list", + "member":{"shape":"RequiredFieldInfo"} + }, "ResourceConflictException":{ "type":"structure", "members":{ @@ -9044,6 +9534,11 @@ "error":{"httpStatusCode":402}, "exception":true }, + "SingleSelectOptions":{ + "type":"list", + "member":{"shape":"TaskTemplateSingleSelectOption"} + }, + "SnapshotVersion":{"type":"string"}, "SourceApplicationName":{ "type":"string", "max":100, @@ -9251,7 +9746,6 @@ "type":"structure", "required":[ "InstanceId", - "ContactFlowId", "Name" ], "members":{ @@ -9291,6 +9785,14 @@ "ScheduledTime":{ "shape":"Timestamp", "documentation":"<p>The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact flow. The scheduled time cannot be in the past. It must be within up to 6 days in future. </p>" + }, + "TaskTemplateId":{ + "shape":"TaskTemplateId", + "documentation":"<p>A unique identifier for the task template.</p>" + }, + "QuickConnectId":{ + "shape":"QuickConnectId", + "documentation":"<p>The identifier for the quick connect.</p>" } } }, @@ -9428,6 +9930,20 @@ }, "documentation":"<p>A leaf node condition which can be used to specify a string condition, for example, <code>username = 'abc'</code>. </p>" }, + "StringReference":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ReferenceKey", + "documentation":"<p>Identifier of the string reference.</p>" + }, + "Value":{ + "shape":"ReferenceValue", + "documentation":"<p>A valid string.</p>" + } + }, + "documentation":"<p>Information about a reference when the <code>referenceType</code> is <code>STRING</code>. Otherwise, null.</p>" + }, "SupportedMessagingContentType":{ "type":"string", "max":100, @@ -9528,6 +10044,191 @@ "type":"string", "max":256 }, + "TaskTemplateArn":{ + "type":"string", + "max":500, + "min":1 + }, + "TaskTemplateConstraints":{ + "type":"structure", + "members":{ + "RequiredFields":{ + "shape":"RequiredTaskTemplateFields", + "documentation":"<p>Lists the fields that are required to be filled by agents.</p>" + }, + "ReadOnlyFields":{ + "shape":"ReadOnlyTaskTemplateFields", + "documentation":"<p>Lists the fields that are read-only to agents, and cannot be edited.</p>" + }, + "InvisibleFields":{ + "shape":"InvisibleTaskTemplateFields", + "documentation":"<p>Lists the fields that are invisible to agents.</p>" + } + }, + "documentation":"<p>Describes constraints that apply to the template fields.</p>" + }, + "TaskTemplateDefaultFieldValue":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"TaskTemplateFieldIdentifier", + "documentation":"<p>Identifier of a field. </p>" + }, + "DefaultValue":{ + "shape":"TaskTemplateFieldValue", + "documentation":"<p>Default value for the field.</p>" + } + }, + "documentation":"<p>Describes a default field and its corresponding value.</p>" + }, + "TaskTemplateDefaultFieldValueList":{ + "type":"list", + "member":{"shape":"TaskTemplateDefaultFieldValue"} + }, + "TaskTemplateDefaults":{ + "type":"structure", + "members":{ + "DefaultFieldValues":{ + "shape":"TaskTemplateDefaultFieldValueList", + "documentation":"<p>Default value for the field.</p>" + } + }, + "documentation":"<p>Describes default values for fields on a template.</p>" + }, + "TaskTemplateDescription":{ + "type":"string", + "max":255, + "min":1 + }, + "TaskTemplateField":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"TaskTemplateFieldIdentifier", + "documentation":"<p>The unique identifier for the field.</p>" + }, + "Description":{ + "shape":"TaskTemplateFieldDescription", + "documentation":"<p>The description of the field.</p>" + }, + "Type":{ + "shape":"TaskTemplateFieldType", + "documentation":"<p>Indicates the type of field.</p>" + }, + "SingleSelectOptions":{ + "shape":"SingleSelectOptions", + "documentation":"<p>A list of options for a single select field.</p>" + } + }, + "documentation":"<p>Describes a single task template field.</p>" + }, + "TaskTemplateFieldDescription":{ + "type":"string", + "max":255, + "min":1 + }, + "TaskTemplateFieldIdentifier":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"TaskTemplateFieldName", + "documentation":"<p>The name of the task template field.</p>" + } + }, + "documentation":"<p>The identifier of the task template field.</p>" + }, + "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", + "documentation":"<p>A unique identifier for the task template.</p>" + }, + "Arn":{ + "shape":"TaskTemplateArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the task template.</p>" + }, + "Name":{ + "shape":"TaskTemplateName", + "documentation":"<p>The name of the task template.</p>" + }, + "Description":{ + "shape":"TaskTemplateDescription", + "documentation":"<p>The description of the task template.</p>" + }, + "Status":{ + "shape":"TaskTemplateStatus", + "documentation":"<p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it. Tasks can only be created from <code>ACTIVE</code> templates. If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>" + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"<p>The timestamp when the task template was last modified.</p>" + }, + "CreatedTime":{ + "shape":"timestamp", + "documentation":"<p>The timestamp when the task template was created.</p>" + } + }, + "documentation":"<p>Contains summary information about the task template.</p>" + }, + "TaskTemplateName":{ + "type":"string", + "max":100, + "min":1 + }, + "TaskTemplateSingleSelectOption":{ + "type":"string", + "max":100, + "min":1 + }, + "TaskTemplateStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "INACTIVE" + ] + }, "Threshold":{ "type":"structure", "members":{ @@ -9562,6 +10263,54 @@ "CAMPAIGN" ] }, + "TransferContactRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "ContactId", + "ContactFlowId" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>" + }, + "ContactId":{ + "shape":"ContactId", + "documentation":"<p>The identifier of the contact in this instance of Amazon Connect </p>" + }, + "QueueId":{ + "shape":"QueueId", + "documentation":"<p>The identifier for the queue.</p>" + }, + "UserId":{ + "shape":"AgentResourceId", + "documentation":"<p>The identifier for the user.</p>" + }, + "ContactFlowId":{ + "shape":"ContactFlowId", + "documentation":"<p>The identifier of the contact flow.</p>" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", + "idempotencyToken":true + } + } + }, + "TransferContactResponse":{ + "type":"structure", + "members":{ + "ContactId":{ + "shape":"ContactId", + "documentation":"<p>The identifier of the contact in this instance of Amazon Connect </p>" + }, + "ContactArn":{ + "shape":"ARN", + "documentation":"<p>The Amazon Resource Name (ARN) of the contact.</p>" + } + } + }, "URI":{ "type":"string", "max":2000, @@ -9856,7 +10605,7 @@ }, "References":{ "shape":"ContactReferences", - "documentation":"<p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP).</p>" + "documentation":"<p>Well-formed data on contact, shown to agents on Contact Control Panel (CCP).</p>" } } }, @@ -10356,6 +11105,108 @@ } } }, + "UpdateTaskTemplateRequest":{ + "type":"structure", + "required":[ + "TaskTemplateId", + "InstanceId" + ], + "members":{ + "TaskTemplateId":{ + "shape":"TaskTemplateId", + "documentation":"<p>A unique identifier for the task template.</p>", + "location":"uri", + "locationName":"TaskTemplateId" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>", + "location":"uri", + "locationName":"InstanceId" + }, + "Name":{ + "shape":"TaskTemplateName", + "documentation":"<p>The name of the task template.</p>" + }, + "Description":{ + "shape":"TaskTemplateDescription", + "documentation":"<p>The description of the task template.</p>" + }, + "ContactFlowId":{ + "shape":"ContactFlowId", + "documentation":"<p>The identifier of the flow that runs by default when a task is created by referencing this template.</p>" + }, + "Constraints":{ + "shape":"TaskTemplateConstraints", + "documentation":"<p>Constraints that are applicable to the fields listed.</p>" + }, + "Defaults":{ + "shape":"TaskTemplateDefaults", + "documentation":"<p>The default values for fields when a task is created by referencing this template.</p>" + }, + "Status":{ + "shape":"TaskTemplateStatus", + "documentation":"<p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it. Tasks can only be created from <code>ACTIVE</code> templates. If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>" + }, + "Fields":{ + "shape":"TaskTemplateFields", + "documentation":"<p>Fields that are part of the template.</p>" + } + } + }, + "UpdateTaskTemplateResponse":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>" + }, + "Id":{ + "shape":"TaskTemplateId", + "documentation":"<p>The identifier of the task template resource.</p>" + }, + "Arn":{ + "shape":"TaskTemplateArn", + "documentation":"<p>The Amazon Resource Name (ARN) for the task template resource.</p>" + }, + "Name":{ + "shape":"TaskTemplateName", + "documentation":"<p>The name of the task template.</p>" + }, + "Description":{ + "shape":"TaskTemplateDescription", + "documentation":"<p>The description of the task template.</p>" + }, + "ContactFlowId":{ + "shape":"ContactFlowId", + "documentation":"<p>The identifier of the flow that runs by default when a task is created by referencing this template.</p>" + }, + "Constraints":{ + "shape":"TaskTemplateConstraints", + "documentation":"<p>Constraints that are applicable to the fields listed.</p>" + }, + "Defaults":{ + "shape":"TaskTemplateDefaults", + "documentation":"<p>The default values for fields when a task is created by referencing this template.</p>" + }, + "Fields":{ + "shape":"TaskTemplateFields", + "documentation":"<p>Fields that are part of the template.</p>" + }, + "Status":{ + "shape":"TaskTemplateStatus", + "documentation":"<p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it. Tasks can only be created from <code>ACTIVE</code> templates. If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>" + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"<p>The timestamp when the task template was last modified.</p>" + }, + "CreatedTime":{ + "shape":"timestamp", + "documentation":"<p>The timestamp when the task template was created.</p>" + } + } + }, "UpdateUserHierarchyGroupNameRequest":{ "type":"structure", "required":[ diff --git a/contrib/python/botocore/py3/botocore/data/kendra/2019-02-03/service-2.json b/contrib/python/botocore/py3/botocore/data/kendra/2019-02-03/service-2.json index 4e8283cc64..ea8dab8b6d 100644 --- a/contrib/python/botocore/py3/botocore/data/kendra/2019-02-03/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/kendra/2019-02-03/service-2.json @@ -2342,6 +2342,10 @@ "JiraConfiguration":{ "shape":"JiraConfiguration", "documentation":"<p>Provides the configuration information to connect to Jira as your data source.</p>" + }, + "GitHubConfiguration":{ + "shape":"GitHubConfiguration", + "documentation":"<p>Provides the configuration information to connect to GitHub as your data source.</p>" } }, "documentation":"<p>Provides the configuration information for an Amazon Kendra data source.</p>" @@ -2606,7 +2610,8 @@ "SLACK", "BOX", "QUIP", - "JIRA" + "JIRA", + "GITHUB" ] }, "DataSourceVpcConfiguration":{ @@ -3413,7 +3418,7 @@ "members":{ "Id":{ "shape":"DocumentId", - "documentation":"<p>A unique identifier of the document in the index.</p>" + "documentation":"<p>A unique identifier of the document in the index.</p> <p>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 <code>BatchPutDocument</code> API to index the same documents, or vice versa. You can delete a data source and then use the <code>BatchPutDocument</code> API to index the same documents, or vice versa.</p>" }, "Title":{ "shape":"Title", @@ -4258,6 +4263,135 @@ } } }, + "GitHubConfiguration":{ + "type":"structure", + "required":["SecretArn"], + "members":{ + "SaaSConfiguration":{ + "shape":"SaaSConfiguration", + "documentation":"<p>Configuration information to connect to GitHub Enterprise Cloud (SaaS).</p>" + }, + "OnPremiseConfiguration":{ + "shape":"OnPremiseConfiguration", + "documentation":"<p>Configuration information to connect to GitHub Enterprise Server (on premises).</p>" + }, + "Type":{ + "shape":"Type", + "documentation":"<p>The type of GitHub service you want to connect to—GitHub Enterprise Cloud (SaaS) or GitHub Enterprise Server (on premises).</p>" + }, + "SecretArn":{ + "shape":"SecretArn", + "documentation":"<p>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:</p> <ul> <li> <p>githubToken—The access token created in GitHub. For more information on creating a token in GitHub, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/data-source-github.html#github-authentication\">Authentication for a GitHub data source</a>.</p> </li> </ul>" + }, + "UseChangeLog":{ + "shape":"Boolean", + "documentation":"<p> <code>TRUE</code> 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.</p>" + }, + "GitHubDocumentCrawlProperties":{ + "shape":"GitHubDocumentCrawlProperties", + "documentation":"<p>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.</p>" + }, + "RepositoryFilter":{ + "shape":"RepositoryNames", + "documentation":"<p>A list of names of the specific repositories you want to index.</p>" + }, + "InclusionFolderNamePatterns":{ + "shape":"StringList", + "documentation":"<p>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.</p>" + }, + "InclusionFileTypePatterns":{ + "shape":"StringList", + "documentation":"<p>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.</p>" + }, + "InclusionFileNamePatterns":{ + "shape":"StringList", + "documentation":"<p>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.</p>" + }, + "ExclusionFolderNamePatterns":{ + "shape":"StringList", + "documentation":"<p>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.</p>" + }, + "ExclusionFileTypePatterns":{ + "shape":"StringList", + "documentation":"<p>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.</p>" + }, + "ExclusionFileNamePatterns":{ + "shape":"StringList", + "documentation":"<p>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.</p>" + }, + "VpcConfiguration":{ + "shape":"DataSourceVpcConfiguration", + "documentation":"<p>Configuration information of an Amazon Virtual Private Cloud to connect to your GitHub. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html\">Configuring a VPC</a>.</p>" + }, + "GitHubRepositoryConfigurationFieldMappings":{ + "shape":"DataSourceToIndexFieldMappingList", + "documentation":"<p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map GitHub repository attributes or field names to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to GitHub fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The GitHub data source field names must exist in your GitHub custom metadata.</p>" + }, + "GitHubCommitConfigurationFieldMappings":{ + "shape":"DataSourceToIndexFieldMappingList", + "documentation":"<p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or field names of GitHub commits to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to GitHub fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The GitHub data source field names must exist in your GitHub custom metadata.</p>" + }, + "GitHubIssueDocumentConfigurationFieldMappings":{ + "shape":"DataSourceToIndexFieldMappingList", + "documentation":"<p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or field names of GitHub issues to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to GitHub fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The GitHub data source field names must exist in your GitHub custom metadata.</p>" + }, + "GitHubIssueCommentConfigurationFieldMappings":{ + "shape":"DataSourceToIndexFieldMappingList", + "documentation":"<p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or field names of GitHub issue comments to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to GitHub fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The GitHub data source field names must exist in your GitHub custom metadata.</p>" + }, + "GitHubIssueAttachmentConfigurationFieldMappings":{ + "shape":"DataSourceToIndexFieldMappingList", + "documentation":"<p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or field names of GitHub issue attachments to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to GitHub fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The GitHub data source field names must exist in your GitHub custom metadata.</p>" + }, + "GitHubPullRequestCommentConfigurationFieldMappings":{ + "shape":"DataSourceToIndexFieldMappingList", + "documentation":"<p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or field names of GitHub pull request comments to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to GitHub fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The GitHub data source field names must exist in your GitHub custom metadata.</p>" + }, + "GitHubPullRequestDocumentConfigurationFieldMappings":{ + "shape":"DataSourceToIndexFieldMappingList", + "documentation":"<p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or field names of GitHub pull requests to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to GitHub fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The GitHub data source field names must exist in your GitHub custom metadata.</p>" + }, + "GitHubPullRequestDocumentAttachmentConfigurationFieldMappings":{ + "shape":"DataSourceToIndexFieldMappingList", + "documentation":"<p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or field names of GitHub pull request attachments to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to GitHub fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The GitHub data source field names must exist in your GitHub custom metadata.</p>" + } + }, + "documentation":"<p>Provides the configuration information to connect to GitHub as your data source.</p>" + }, + "GitHubDocumentCrawlProperties":{ + "type":"structure", + "members":{ + "CrawlRepositoryDocuments":{ + "shape":"Boolean", + "documentation":"<p> <code>TRUE</code> to index all files with a repository.</p>" + }, + "CrawlIssue":{ + "shape":"Boolean", + "documentation":"<p> <code>TRUE</code> to index all issues within a repository.</p>" + }, + "CrawlIssueComment":{ + "shape":"Boolean", + "documentation":"<p> <code>TRUE</code> to index all comments on issues.</p>" + }, + "CrawlIssueCommentAttachment":{ + "shape":"Boolean", + "documentation":"<p> <code>TRUE</code> to include all comment attachments for issues.</p>" + }, + "CrawlPullRequest":{ + "shape":"Boolean", + "documentation":"<p> <code>TRUE</code> to index all pull requests within a repository.</p>" + }, + "CrawlPullRequestComment":{ + "shape":"Boolean", + "documentation":"<p> <code>TRUE</code> to index all comments on pull requests.</p>" + }, + "CrawlPullRequestCommentAttachment":{ + "shape":"Boolean", + "documentation":"<p> <code>TRUE</code> to include all comment attachments for pull requests.</p>" + } + }, + "documentation":"<p>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.</p>" + }, "GoogleDriveConfiguration":{ "type":"structure", "required":["SecretArn"], @@ -4669,7 +4803,7 @@ }, "SecretArn":{ "shape":"SecretArn", - "documentation":"<p>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:</p> <ul> <li> <p>jira-id—The Active Directory user name, along with the Domain Name System (DNS) domain name. For example, <i>user@corp.example.com</i>.</p> </li> <li> <p>jiraCredentials—The password of the Jira account user.</p> </li> </ul>" + "documentation":"<p>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:</p> <ul> <li> <p>jira-id—The ID of the Jira account.</p> </li> <li> <p>jiraCredentials—The password of the Jira account user.</p> </li> </ul>" }, "UseChangeLog":{ "shape":"Boolean", @@ -4723,7 +4857,8 @@ "shape":"DataSourceVpcConfiguration", "documentation":"<p>Configuration information for an Amazon Virtual Private Cloud to connect to your Jira. Your Jira account must reside inside your VPC.</p>" } - } + }, + "documentation":"<p>Provides the configuration information to connect to Jira as your data source.</p>" }, "JiraStatus":{ "type":"list", @@ -5327,6 +5462,29 @@ "min":1 }, "ObjectBoolean":{"type":"boolean"}, + "OnPremiseConfiguration":{ + "type":"structure", + "required":[ + "HostUrl", + "OrganizationName", + "SslCertificateS3Path" + ], + "members":{ + "HostUrl":{ + "shape":"Url", + "documentation":"<p>The GitHub host URL or API endpoint URL. For example, <i>https://on-prem-host-url/api/v3/</i> </p>" + }, + "OrganizationName":{ + "shape":"OrganizationName", + "documentation":"<p>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 <b>Your organizations</b> under your profile picture dropdown.</p>" + }, + "SslCertificateS3Path":{ + "shape":"S3Path", + "documentation":"<p>Information required to find a specific file in an Amazon S3 bucket.</p>" + } + }, + "documentation":"<p>Provides the configuration information to connect to GitHub Enterprise Server (on premises).</p>" + }, "OneDriveConfiguration":{ "type":"structure", "required":[ @@ -5405,6 +5563,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":[ @@ -5926,6 +6090,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":{ @@ -6026,6 +6200,24 @@ }, "documentation":"<p>Information required to find a specific file in an Amazon S3 bucket.</p>" }, + "SaaSConfiguration":{ + "type":"structure", + "required":[ + "OrganizationName", + "HostUrl" + ], + "members":{ + "OrganizationName":{ + "shape":"OrganizationName", + "documentation":"<p>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 <b>Your organizations</b> under your profile picture dropdown.</p>" + }, + "HostUrl":{ + "shape":"Url", + "documentation":"<p>The GitHub host URL or API endpoint URL. For example, <i>https://api.github.com</i>.</p>" + } + }, + "documentation":"<p>Provides the configuration information to connect to GitHub Enterprise Cloud (SaaS).</p>" + }, "SalesforceChatterFeedConfiguration":{ "type":"structure", "required":["DocumentDataFieldName"], @@ -6354,10 +6546,10 @@ "members":{ "KmsKeyId":{ "shape":"KmsKeyId", - "documentation":"<p>The identifier of the KMScustomer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.</p>" + "documentation":"<p>The identifier of the KMS key. Amazon Kendra doesn't support asymmetric keys.</p>" } }, - "documentation":"<p>Provides the identifier of the KMScustomer master key (CMK) used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.</p>" + "documentation":"<p>Provides the identifier of the KMS key used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric keys.</p>" }, "ServiceNowAuthenticationType":{ "type":"string", @@ -6829,6 +7021,10 @@ "max":2048, "min":1 }, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, "SubmitFeedbackRequest":{ "type":"structure", "required":[ @@ -7135,6 +7331,13 @@ "max":5000, "min":0 }, + "Type":{ + "type":"string", + "enum":[ + "SAAS", + "ON_PREMISE" + ] + }, "UntagResourceRequest":{ "type":"structure", "required":[ diff --git a/contrib/python/botocore/py3/botocore/data/proton/2020-07-20/paginators-1.json b/contrib/python/botocore/py3/botocore/data/proton/2020-07-20/paginators-1.json index 9f835e49c5..450f2e2908 100644 --- a/contrib/python/botocore/py3/botocore/data/proton/2020-07-20/paginators-1.json +++ b/contrib/python/botocore/py3/botocore/data/proton/2020-07-20/paginators-1.json @@ -94,6 +94,22 @@ "input_token": "nextToken", "output_token": "nextToken", "result_key": "provisionedResources" + }, + "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" } } } diff --git a/contrib/python/botocore/py3/botocore/data/proton/2020-07-20/service-2.json b/contrib/python/botocore/py3/botocore/data/proton/2020-07-20/service-2.json index 247938aeb8..c0ab5492cc 100644 --- a/contrib/python/botocore/py3/botocore/data/proton/2020-07-20/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/proton/2020-07-20/service-2.json @@ -32,6 +32,24 @@ "documentation":"<p>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.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html\">Environment account connections</a> in the <i>Proton Administrator guide</i>.</p>", "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"} + ], + "documentation":"<p>Attempts to cancel a component deployment (for a component that is in the <code>IN_PROGRESS</code> deployment status).</p> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p>" + }, "CancelEnvironmentDeployment":{ "name":"CancelEnvironmentDeployment", "http":{ @@ -86,6 +104,26 @@ ], "documentation":"<p>Attempts to cancel a service pipeline deployment on an <a>UpdateServicePipeline</a> action, if the deployment is <code>IN_PROGRESS</code>. For more information, see <i>Update a service pipeline</i> in the <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-pipeline-update.html\">Proton Administrator guide</a> or the <a href=\"https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-pipeline-update.html\">Proton User guide</a>.</p> <p>The following list includes potential cancellation scenarios.</p> <ul> <li> <p>If the cancellation attempt succeeds, the resulting deployment state is <code>CANCELLED</code>.</p> </li> <li> <p>If the cancellation attempt fails, the resulting deployment state is <code>FAILED</code>.</p> </li> <li> <p>If the current <a>UpdateServicePipeline</a> action succeeds before the cancellation attempt starts, the resulting deployment state is <code>SUCCEEDED</code> and the cancellation attempt has no effect.</p> </li> </ul>" }, + "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"} + ], + "documentation":"<p>Create an Proton component. A component is an infrastructure extension for a service instance.</p> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p>", + "idempotent":true + }, "CreateEnvironment":{ "name":"CreateEnvironment", "http":{ @@ -261,6 +299,25 @@ "documentation":"<p>Set up a template to create new template versions automatically. When a commit is pushed to your registered <a href=\"https://docs.aws.amazon.com/proton/latest/APIReference/API_Repository.html\">repository</a>, 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 <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-template-sync-configs.html\">Template sync configurations</a> in the <i>Proton Administrator Guide</i>.</p>", "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"} + ], + "documentation":"<p>Delete an Proton component resource.</p> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p>", + "idempotent":true + }, "DeleteEnvironment":{ "name":"DeleteEnvironment", "http":{ @@ -372,7 +429,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], - "documentation":"<p>Delete a service.</p>", + "documentation":"<p>Delete a service, with its instances and pipeline.</p> <note> <p>You can't delete a service if it has any service instances that have components attached to them.</p> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p> </note>", "idempotent":true }, "DeleteServiceTemplate":{ @@ -449,6 +506,23 @@ ], "documentation":"<p>Get detail data for the Proton pipeline service role.</p>" }, + "GetComponent":{ + "name":"GetComponent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetComponentInput"}, + "output":{"shape":"GetComponentOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"<p>Get detailed data for a component.</p> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p>" + }, "GetEnvironment":{ "name":"GetEnvironment", "http":{ @@ -464,7 +538,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], - "documentation":"<p>Get detail data for an environment.</p>" + "documentation":"<p>Get detailed data for an environment.</p>" }, "GetEnvironmentAccountConnection":{ "name":"GetEnvironmentAccountConnection", @@ -481,7 +555,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], - "documentation":"<p>In an environment account, view the detail data for an environment account connection.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html\">Environment account connections</a> in the <i>Proton Administrator guide</i>.</p>" + "documentation":"<p>In an environment account, get the detailed data for an environment account connection.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html\">Environment account connections</a> in the <i>Proton Administrator guide</i>.</p>" }, "GetEnvironmentTemplate":{ "name":"GetEnvironmentTemplate", @@ -498,7 +572,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], - "documentation":"<p>Get detail data for an environment template.</p>" + "documentation":"<p>Get detailed data for an environment template.</p>" }, "GetEnvironmentTemplateVersion":{ "name":"GetEnvironmentTemplateVersion", @@ -515,7 +589,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], - "documentation":"<p>View detail data for a major or minor version of an environment template.</p>" + "documentation":"<p>Get detailed data for a major or minor version of an environment template.</p>" }, "GetRepository":{ "name":"GetRepository", @@ -566,7 +640,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], - "documentation":"<p>Get detail data for a service.</p>" + "documentation":"<p>Get detailed data for a service.</p>" }, "GetServiceInstance":{ "name":"GetServiceInstance", @@ -583,7 +657,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], - "documentation":"<p>Get detail data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.</p>" + "documentation":"<p>Get detailed data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.</p>" }, "GetServiceTemplate":{ "name":"GetServiceTemplate", @@ -600,7 +674,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], - "documentation":"<p>Get detail data for a service template.</p>" + "documentation":"<p>Get detailed data for a service template.</p>" }, "GetServiceTemplateVersion":{ "name":"GetServiceTemplateVersion", @@ -617,7 +691,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], - "documentation":"<p>View detail data for a major or minor version of a service template.</p>" + "documentation":"<p>Get detailed data for a major or minor version of a service template.</p>" }, "GetTemplateSyncConfig":{ "name":"GetTemplateSyncConfig", @@ -653,6 +727,56 @@ ], "documentation":"<p>Get the status of a template sync.</p>" }, + "ListComponentOutputs":{ + "name":"ListComponentOutputs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListComponentOutputsInput"}, + "output":{"shape":"ListComponentOutputsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"<p>Get a list of component Infrastructure as Code (IaC) outputs.</p> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p>" + }, + "ListComponentProvisionedResources":{ + "name":"ListComponentProvisionedResources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListComponentProvisionedResourcesInput"}, + "output":{"shape":"ListComponentProvisionedResourcesOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"<p>List provisioned resources for a component with details.</p> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p>" + }, + "ListComponents":{ + "name":"ListComponents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListComponentsInput"}, + "output":{"shape":"ListComponentsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"<p>List components with summary data. You can filter the result list by environment, service, or a single service instance.</p> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p>" + }, "ListEnvironmentAccountConnections":{ "name":"ListEnvironmentAccountConnections", "http":{ @@ -801,7 +925,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], - "documentation":"<p>View a list service instance infrastructure as code outputs with detail data.</p>" + "documentation":"<p>Get a list service of instance Infrastructure as Code (IaC) outputs.</p>" }, "ListServiceInstanceProvisionedResources":{ "name":"ListServiceInstanceProvisionedResources", @@ -835,7 +959,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], - "documentation":"<p>List service instances with summaries of detail data.</p>" + "documentation":"<p>List service instances with summary data.</p>" }, "ListServicePipelineOutputs":{ "name":"ListServicePipelineOutputs", @@ -852,7 +976,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], - "documentation":"<p>View a list service pipeline infrastructure as code outputs with detail.</p>" + "documentation":"<p>Get a list of service pipeline Infrastructure as Code (IaC) outputs.</p>" }, "ListServicePipelineProvisionedResources":{ "name":"ListServicePipelineProvisionedResources", @@ -1030,6 +1154,25 @@ ], "documentation":"<p>Update the Proton service pipeline role or repository settings.</p>" }, + "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"} + ], + "documentation":"<p>Update a component.</p> <p>There are a few modes for updating a component. The <code>deploymentType</code> field defines the mode.</p> <note> <p>You can't update a component while its deployment status, or the deployment status of a service instance attached to it, is <code>IN_PROGRESS</code>.</p> </note> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p>" + }, "UpdateEnvironment":{ "name":"UpdateEnvironment", "http":{ @@ -1120,7 +1263,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], - "documentation":"<p>Edit a service description or use a spec to add and delete service instances.</p> <note> <p>Existing service instances and the service pipeline <i>can't</i> be edited using this API. They can only be deleted.</p> </note> <p>Use the <code>description</code> parameter to modify the description.</p> <p>Edit the <code>spec</code> parameter to add or delete instances.</p>" + "documentation":"<p>Edit a service description or use a spec to add and delete service instances.</p> <note> <p>Existing service instances and the service pipeline <i>can't</i> be edited using this API. They can only be deleted.</p> </note> <p>Use the <code>description</code> parameter to modify the description.</p> <p>Edit the <code>spec</code> parameter to add or delete instances.</p> <note> <p>You can't delete a service instance (remove it from the spec) if it has an attached component.</p> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p> </note>" }, "UpdateServiceInstance":{ "name":"UpdateServiceInstance", @@ -1138,7 +1281,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], - "documentation":"<p>Update a service instance.</p> <p>There are four modes for updating a service instance. The <code>deploymentType</code> field defines the mode.</p> <dl> <dt/> <dd> <p> <code>NONE</code> </p> <p>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</p> </dd> <dt/> <dd> <p> <code>CURRENT_VERSION</code> </p> <p>In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. <i>Don’t</i> include minor or major version parameters when you use this <code>deployment-type</code>.</p> </dd> <dt/> <dd> <p> <code>MINOR_VERSION</code> </p> <p>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.</p> </dd> <dt/> <dd> <p> <code>MAJOR_VERSION</code> </p> <p>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.</p> </dd> </dl>" + "documentation":"<p>Update a service instance.</p> <p>There are a few modes for updating a service instance. The <code>deploymentType</code> field defines the mode.</p> <note> <p>You can't update a service instance while its deployment status, or the deployment status of a component attached to it, is <code>IN_PROGRESS</code>.</p> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p> </note>" }, "UpdateServicePipeline":{ "name":"UpdateServicePipeline", @@ -1266,6 +1409,26 @@ "type":"string", "pattern":"^\\d{12}$" }, + "CancelComponentDeploymentInput":{ + "type":"structure", + "required":["componentName"], + "members":{ + "componentName":{ + "shape":"ResourceName", + "documentation":"<p>The name of the component with the deployment to cancel.</p>" + } + } + }, + "CancelComponentDeploymentOutput":{ + "type":"structure", + "required":["component"], + "members":{ + "component":{ + "shape":"Component", + "documentation":"<p>The detailed data of the component with the deployment that is being canceled.</p>" + } + } + }, "CancelEnvironmentDeploymentInput":{ "type":"structure", "required":["environmentName"], @@ -1385,6 +1548,142 @@ "type":"list", "member":{"shape":"CompatibleEnvironmentTemplate"} }, + "Component":{ + "type":"structure", + "required":[ + "arn", + "createdAt", + "deploymentStatus", + "environmentName", + "lastModifiedAt", + "name" + ], + "members":{ + "arn":{ + "shape":"ComponentArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the component.</p>" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"<p>The time when the component was created.</p>" + }, + "deploymentStatus":{ + "shape":"DeploymentStatus", + "documentation":"<p>The component deployment status.</p>" + }, + "deploymentStatusMessage":{ + "shape":"StatusMessage", + "documentation":"<p>The message associated with the component deployment status.</p>" + }, + "description":{ + "shape":"Description", + "documentation":"<p>A description of the component.</p>" + }, + "environmentName":{ + "shape":"ResourceName", + "documentation":"<p>The name of the Proton environment that this component is associated with.</p>" + }, + "lastDeploymentAttemptedAt":{ + "shape":"Timestamp", + "documentation":"<p>The time when a deployment of the component was last attempted.</p>" + }, + "lastDeploymentSucceededAt":{ + "shape":"Timestamp", + "documentation":"<p>The time when the component was last deployed successfully.</p>" + }, + "lastModifiedAt":{ + "shape":"Timestamp", + "documentation":"<p>The time when the component was last modified.</p>" + }, + "name":{ + "shape":"ResourceName", + "documentation":"<p>The name of the component.</p>" + }, + "serviceInstanceName":{ + "shape":"ResourceName", + "documentation":"<p>The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.</p>" + }, + "serviceName":{ + "shape":"ResourceName", + "documentation":"<p>The name of the service that <code>serviceInstanceName</code> is associated with. Provided when a component is attached to a service instance.</p>" + }, + "serviceSpec":{ + "shape":"SpecContents", + "documentation":"<p>The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.</p>" + } + }, + "documentation":"<p>Detailed data of an Proton component resource.</p> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p>" + }, + "ComponentArn":{"type":"string"}, + "ComponentDeploymentUpdateType":{ + "type":"string", + "enum":[ + "NONE", + "CURRENT_VERSION" + ] + }, + "ComponentSummary":{ + "type":"structure", + "required":[ + "arn", + "createdAt", + "deploymentStatus", + "environmentName", + "lastModifiedAt", + "name" + ], + "members":{ + "arn":{ + "shape":"ComponentArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the component.</p>" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"<p>The time when the component was created.</p>" + }, + "deploymentStatus":{ + "shape":"DeploymentStatus", + "documentation":"<p>The component deployment status.</p>" + }, + "deploymentStatusMessage":{ + "shape":"StatusMessage", + "documentation":"<p>The message associated with the component deployment status.</p>" + }, + "environmentName":{ + "shape":"ResourceName", + "documentation":"<p>The name of the Proton environment that this component is associated with.</p>" + }, + "lastDeploymentAttemptedAt":{ + "shape":"Timestamp", + "documentation":"<p>The time when a deployment of the component was last attempted.</p>" + }, + "lastDeploymentSucceededAt":{ + "shape":"Timestamp", + "documentation":"<p>The time when the component was last deployed successfully.</p>" + }, + "lastModifiedAt":{ + "shape":"Timestamp", + "documentation":"<p>The time when the component was last modified.</p>" + }, + "name":{ + "shape":"ResourceName", + "documentation":"<p>The name of the component.</p>" + }, + "serviceInstanceName":{ + "shape":"ResourceName", + "documentation":"<p>The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.</p>" + }, + "serviceName":{ + "shape":"ResourceName", + "documentation":"<p>The name of the service that <code>serviceInstanceName</code> is associated with. Provided when a component is attached to a service instance.</p>" + } + }, + "documentation":"<p>Summary data of an Proton component resource.</p> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p>" + }, + "ComponentSummaryList":{ + "type":"list", + "member":{"shape":"ComponentSummary"} + }, "ConflictException":{ "type":"structure", "required":["message"], @@ -1394,6 +1693,62 @@ "documentation":"<p>The request <i>couldn't</i> be made due to a conflicting operation or resource.</p>", "exception":true }, + "CreateComponentInput":{ + "type":"structure", + "required":[ + "manifest", + "name", + "templateFile" + ], + "members":{ + "description":{ + "shape":"Description", + "documentation":"<p>An optional customer-provided description of the component.</p>" + }, + "environmentName":{ + "shape":"ResourceName", + "documentation":"<p>The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify <code>serviceInstanceName</code> and <code>serviceName</code>.</p>" + }, + "manifest":{ + "shape":"TemplateManifestContents", + "documentation":"<p>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.</p>" + }, + "name":{ + "shape":"ResourceName", + "documentation":"<p>The customer-provided name of the component.</p>" + }, + "serviceInstanceName":{ + "shape":"ResourceName", + "documentation":"<p>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 <code>serviceInstanceName</code> and <code>serviceName</code> or neither of them.</p>" + }, + "serviceName":{ + "shape":"ResourceName", + "documentation":"<p>The name of the service that <code>serviceInstanceName</code> is associated with. If you don't specify this, the component isn't attached to any service instance. Specify both <code>serviceInstanceName</code> and <code>serviceName</code> or neither of them.</p>" + }, + "serviceSpec":{ + "shape":"SpecContents", + "documentation":"<p>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.</p>" + }, + "tags":{ + "shape":"TagList", + "documentation":"<p>An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.</p> <p>For more information, see <i>Proton resources and tagging</i> in the <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/resources.html\">Proton Administrator Guide</a> or <a href=\"https://docs.aws.amazon.com/proton/latest/userguide/resources.html\">Proton User Guide</a>.</p>" + }, + "templateFile":{ + "shape":"TemplateFileContents", + "documentation":"<p>A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.</p> <note> <p>Components support a single IaC file, even if you use Terraform as your template language.</p> </note>" + } + } + }, + "CreateComponentOutput":{ + "type":"structure", + "required":["component"], + "members":{ + "component":{ + "shape":"Component", + "documentation":"<p>The detailed data of the created component.</p>" + } + } + }, "CreateEnvironmentAccountConnectionInput":{ "type":"structure", "required":[ @@ -1407,6 +1762,10 @@ "documentation":"<p>When included, if two identical requests are made with the same client token, Proton returns the environment account connection that the first request created.</p>", "idempotencyToken":true }, + "componentRoleArn":{ + "shape":"Arn", + "documentation":"<p>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.</p> <p>You must specify <code>componentRoleArn</code> to allow directly defined components to be associated with any environments running in this account.</p> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p>" + }, "environmentName":{ "shape":"ResourceName", "documentation":"<p>The name of the Proton environment that's created in the associated management account.</p>" @@ -1444,6 +1803,10 @@ "templateName" ], "members":{ + "componentRoleArn":{ + "shape":"Arn", + "documentation":"<p>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.</p> <p>You must specify <code>componentRoleArn</code> to allow directly defined components to be associated with this environment.</p> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p>" + }, "description":{ "shape":"Description", "documentation":"<p>A description of the environment that's being created and deployed.</p>" @@ -1736,7 +2099,7 @@ }, "compatibleEnvironmentTemplates":{ "shape":"CompatibleEnvironmentTemplateInputList", - "documentation":"<p>An array of compatible environment template objects for the new version of a service template.</p>" + "documentation":"<p>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.</p>" }, "description":{ "shape":"Description", @@ -1750,6 +2113,10 @@ "shape":"TemplateVersionSourceInput", "documentation":"<p>An object that includes the template bundle S3 bucket path and name for the new version of a service template.</p>" }, + "supportedComponentSources":{ + "shape":"ServiceTemplateSupportedComponentSourceInputList", + "documentation":"<p>An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.</p> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p>" + }, "tags":{ "shape":"TagList", "documentation":"<p>An optional list of metadata items that you can associate with the Proton service template version. A tag is a key-value pair.</p> <p>For more information, see <i>Proton resources and tagging</i> in the <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/resources.html\">Proton Administrator Guide</a> or <a href=\"https://docs.aws.amazon.com/proton/latest/userguide/resources.html\">Proton User Guide</a>.</p>" @@ -1815,6 +2182,25 @@ } } }, + "DeleteComponentInput":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"ResourceName", + "documentation":"<p>The name of the component to delete.</p>" + } + } + }, + "DeleteComponentOutput":{ + "type":"structure", + "members":{ + "component":{ + "shape":"Component", + "documentation":"<p>The detailed data of the component being deleted.</p>" + } + } + }, "DeleteEnvironmentAccountConnectionInput":{ "type":"structure", "required":["id"], @@ -1830,7 +2216,7 @@ "members":{ "environmentAccountConnection":{ "shape":"EnvironmentAccountConnection", - "documentation":"<p>The environment account connection detail data that's returned by Proton.</p>" + "documentation":"<p>The detailed data of the environment account connection being deleted.</p>" } } }, @@ -1849,7 +2235,7 @@ "members":{ "environment":{ "shape":"Environment", - "documentation":"<p>The environment detail data that's returned by Proton.</p>" + "documentation":"<p>The detailed data of the environment being deleted.</p>" } } }, @@ -1868,7 +2254,7 @@ "members":{ "environmentTemplate":{ "shape":"EnvironmentTemplate", - "documentation":"<p>The environment template detail data that's returned by Proton.</p>" + "documentation":"<p>The detailed data of the environment template being deleted.</p>" } } }, @@ -1899,7 +2285,7 @@ "members":{ "environmentTemplateVersion":{ "shape":"EnvironmentTemplateVersion", - "documentation":"<p>The environment template version detail data that's returned by Proton.</p>" + "documentation":"<p>The detailed data of the environment template version being deleted.</p>" } } }, @@ -1944,7 +2330,7 @@ "members":{ "service":{ "shape":"Service", - "documentation":"<p>The service detail data that's returned by Proton.</p>" + "documentation":"<p>The detailed data of the service being deleted.</p>" } } }, @@ -1963,7 +2349,7 @@ "members":{ "serviceTemplate":{ "shape":"ServiceTemplate", - "documentation":"<p>The service template detail data that's returned by Proton.</p>" + "documentation":"<p>The detailed data of the service template being deleted.</p>" } } }, @@ -1994,7 +2380,7 @@ "members":{ "serviceTemplateVersion":{ "shape":"ServiceTemplateVersion", - "documentation":"<p>The service template version detail data that's returned by Proton.</p>" + "documentation":"<p>The detailed data of the service template version being deleted.</p>" } } }, @@ -2085,6 +2471,10 @@ "shape":"EnvironmentArn", "documentation":"<p>The Amazon Resource Name (ARN) of the environment.</p>" }, + "componentRoleArn":{ + "shape":"Arn", + "documentation":"<p>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.</p> <p>The environment must have a <code>componentRoleArn</code> to allow directly defined components to be associated with the environment.</p> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p>" + }, "createdAt":{ "shape":"Timestamp", "documentation":"<p>The time when the environment was created.</p>" @@ -2150,7 +2540,7 @@ "documentation":"<p>The Amazon Resource Name (ARN) of the environment template.</p>" } }, - "documentation":"<p>The environment detail data. An Proton environment is a set resources shared across an Proton service.</p>" + "documentation":"<p>Detailed data of an Proton environment resource. An Proton environment is a set of resources shared across Proton services.</p>" }, "EnvironmentAccountConnection":{ "type":"structure", @@ -2170,6 +2560,10 @@ "shape":"EnvironmentAccountConnectionArn", "documentation":"<p>The Amazon Resource Name (ARN) of the environment account connection.</p>" }, + "componentRoleArn":{ + "shape":"Arn", + "documentation":"<p>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.</p> <p>The environment account connection must have a <code>componentRoleArn</code> to allow directly defined components to be associated with any environments running in the account.</p> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p>" + }, "environmentAccountId":{ "shape":"AwsAccountId", "documentation":"<p>The environment account that's connected to the environment account connection.</p>" @@ -2203,7 +2597,7 @@ "documentation":"<p>The status of the environment account connection.</p>" } }, - "documentation":"<p>The environment account connection detail data.</p>" + "documentation":"<p>Detailed data of an Proton environment account connection resource.</p>" }, "EnvironmentAccountConnectionArn":{"type":"string"}, "EnvironmentAccountConnectionId":{ @@ -2247,6 +2641,10 @@ "shape":"EnvironmentAccountConnectionArn", "documentation":"<p>The Amazon Resource Name (ARN) of the environment account connection.</p>" }, + "componentRoleArn":{ + "shape":"Arn", + "documentation":"<p>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.</p> <p>The environment account connection must have a <code>componentRoleArn</code> to allow directly defined components to be associated with any environments running in the account.</p> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p>" + }, "environmentAccountId":{ "shape":"AwsAccountId", "documentation":"<p>The ID of the environment account that's connected to the environment account connection.</p>" @@ -2280,7 +2678,7 @@ "documentation":"<p>The status of the environment account connection.</p>" } }, - "documentation":"<p>A summary of the environment account connection detail data.</p>" + "documentation":"<p>Summary data of an Proton environment account connection resource.</p>" }, "EnvironmentAccountConnectionSummaryList":{ "type":"list", @@ -2305,6 +2703,10 @@ "shape":"EnvironmentArn", "documentation":"<p>The Amazon Resource Name (ARN) of the environment.</p>" }, + "componentRoleArn":{ + "shape":"Arn", + "documentation":"<p>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.</p> <p>The environment must have a <code>componentRoleArn</code> to allow directly defined components to be associated with the environment.</p> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p>" + }, "createdAt":{ "shape":"Timestamp", "documentation":"<p>The time when the environment was created.</p>" @@ -2362,7 +2764,7 @@ "documentation":"<p>The name of the environment template.</p>" } }, - "documentation":"<p>A summary of the environment detail data.</p>" + "documentation":"<p>Summary data of an Proton environment resource. An Proton environment is a set of resources shared across Proton services.</p>" }, "EnvironmentSummaryList":{ "type":"list", @@ -2630,13 +3032,32 @@ } } }, + "GetComponentInput":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"ResourceName", + "documentation":"<p>The name of the component that you want to get the detailed data for.</p>" + } + } + }, + "GetComponentOutput":{ + "type":"structure", + "members":{ + "component":{ + "shape":"Component", + "documentation":"<p>The detailed data of the requested component.</p>" + } + } + }, "GetEnvironmentAccountConnectionInput":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"EnvironmentAccountConnectionId", - "documentation":"<p>The ID of the environment account connection.</p>" + "documentation":"<p>The ID of the environment account connection that you want to get the detailed data for.</p>" } } }, @@ -2646,7 +3067,7 @@ "members":{ "environmentAccountConnection":{ "shape":"EnvironmentAccountConnection", - "documentation":"<p>The environment account connection detail data that's returned by Proton.</p>" + "documentation":"<p>The detailed data of the requested environment account connection.</p>" } } }, @@ -2656,7 +3077,7 @@ "members":{ "name":{ "shape":"ResourceName", - "documentation":"<p>The name of the environment that you want to get the detail data for.</p>" + "documentation":"<p>The name of the environment that you want to get the detailed data for.</p>" } } }, @@ -2666,7 +3087,7 @@ "members":{ "environment":{ "shape":"Environment", - "documentation":"<p>The environment detail data that's returned by Proton.</p>" + "documentation":"<p>The detailed data of the requested environment.</p>" } } }, @@ -2676,7 +3097,7 @@ "members":{ "name":{ "shape":"ResourceName", - "documentation":"<p>The name of the environment template that you want to get the detail data for.</p>" + "documentation":"<p>The name of the environment template that you want to get the detailed data for.</p>" } } }, @@ -2686,7 +3107,7 @@ "members":{ "environmentTemplate":{ "shape":"EnvironmentTemplate", - "documentation":"<p>The environment template detail data that's returned by Proton.</p>" + "documentation":"<p>The detailed data of the requested environment template.</p>" } } }, @@ -2700,15 +3121,15 @@ "members":{ "majorVersion":{ "shape":"TemplateVersionPart", - "documentation":"<p>To view environment template major version detail data, include <code>major Version</code>.</p>" + "documentation":"<p>To get environment template major version detail data, include <code>major Version</code>.</p>" }, "minorVersion":{ "shape":"TemplateVersionPart", - "documentation":"<p>To view environment template minor version detail data, include <code>minorVersion</code>.</p>" + "documentation":"<p>To get environment template minor version detail data, include <code>minorVersion</code>.</p>" }, "templateName":{ "shape":"ResourceName", - "documentation":"<p>The name of the environment template.</p>" + "documentation":"<p>The name of the environment template a version of which you want to get detailed data for..</p>" } } }, @@ -2718,7 +3139,7 @@ "members":{ "environmentTemplateVersion":{ "shape":"EnvironmentTemplateVersion", - "documentation":"<p>The environment template version detail data that's returned by Proton.</p>" + "documentation":"<p>The detailed data of the requested environment template version.</p>" } } }, @@ -2791,7 +3212,7 @@ "members":{ "name":{ "shape":"ResourceName", - "documentation":"<p>The name of the service that you want to get the detail data for.</p>" + "documentation":"<p>The name of the service that you want to get the detailed data for.</p>" } } }, @@ -2804,7 +3225,7 @@ "members":{ "name":{ "shape":"ResourceName", - "documentation":"<p>The name of a service instance that you want to get the detail data for.</p>" + "documentation":"<p>The name of a service instance that you want to get the detailed data for.</p>" }, "serviceName":{ "shape":"ResourceName", @@ -2818,7 +3239,7 @@ "members":{ "serviceInstance":{ "shape":"ServiceInstance", - "documentation":"<p>The service instance detail data that's returned by Proton.</p>" + "documentation":"<p>The detailed data of the requested service instance.</p>" } } }, @@ -2827,7 +3248,7 @@ "members":{ "service":{ "shape":"Service", - "documentation":"<p>The service detail data that's returned by Proton.</p>" + "documentation":"<p>The detailed data of the requested service.</p>" } } }, @@ -2837,7 +3258,7 @@ "members":{ "name":{ "shape":"ResourceName", - "documentation":"<p>The name of the service template that you want to get detail data for.</p>" + "documentation":"<p>The name of the service template that you want to get detailed data for.</p>" } } }, @@ -2847,7 +3268,7 @@ "members":{ "serviceTemplate":{ "shape":"ServiceTemplate", - "documentation":"<p>The service template detail data that's returned by Proton.</p>" + "documentation":"<p>The detailed data of the requested service template.</p>" } } }, @@ -2861,15 +3282,15 @@ "members":{ "majorVersion":{ "shape":"TemplateVersionPart", - "documentation":"<p>To view service template major version detail data, include <code>major Version</code>.</p>" + "documentation":"<p>To get service template major version detail data, include <code>major Version</code>.</p>" }, "minorVersion":{ "shape":"TemplateVersionPart", - "documentation":"<p>To view service template minor version detail data, include <code>minorVersion</code>.</p>" + "documentation":"<p>To get service template minor version detail data, include <code>minorVersion</code>.</p>" }, "templateName":{ "shape":"ResourceName", - "documentation":"<p>The name of the service template.</p>" + "documentation":"<p>The name of the service template a version of which you want to get detailed data for.</p>" } } }, @@ -2879,7 +3300,7 @@ "members":{ "serviceTemplateVersion":{ "shape":"ServiceTemplateVersion", - "documentation":"<p>The service template version detail data that's returned by Proton.</p>" + "documentation":"<p>The detailed data of the requested service template version.</p>" } } }, @@ -2964,6 +3385,101 @@ "fault":true, "retryable":{"throttling":false} }, + "ListComponentOutputsInput":{ + "type":"structure", + "required":["componentName"], + "members":{ + "componentName":{ + "shape":"ResourceName", + "documentation":"<p>The name of the component whose outputs you want.</p>" + }, + "nextToken":{ + "shape":"EmptyNextToken", + "documentation":"<p>A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.</p>" + } + } + }, + "ListComponentOutputsOutput":{ + "type":"structure", + "required":["outputs"], + "members":{ + "nextToken":{ + "shape":"EmptyNextToken", + "documentation":"<p>A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.</p>" + }, + "outputs":{ + "shape":"OutputsList", + "documentation":"<p>An array of component Infrastructure as Code (IaC) outputs.</p>" + } + } + }, + "ListComponentProvisionedResourcesInput":{ + "type":"structure", + "required":["componentName"], + "members":{ + "componentName":{ + "shape":"ResourceName", + "documentation":"<p>The name of the component whose provisioned resources you want.</p>" + }, + "nextToken":{ + "shape":"EmptyNextToken", + "documentation":"<p>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.</p>" + } + } + }, + "ListComponentProvisionedResourcesOutput":{ + "type":"structure", + "required":["provisionedResources"], + "members":{ + "nextToken":{ + "shape":"EmptyNextToken", + "documentation":"<p>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.</p>" + }, + "provisionedResources":{ + "shape":"ProvisionedResourceList", + "documentation":"<p>An array of provisioned resources for a component.</p>" + } + } + }, + "ListComponentsInput":{ + "type":"structure", + "members":{ + "environmentName":{ + "shape":"ResourceName", + "documentation":"<p>The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.</p>" + }, + "maxResults":{ + "shape":"MaxPageResults", + "documentation":"<p>The maximum number of components to list.</p>" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"<p>A token that indicates the location of the next component in the array of components, after the list of components that was previously requested.</p>" + }, + "serviceInstanceName":{ + "shape":"ResourceName", + "documentation":"<p>The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.</p>" + }, + "serviceName":{ + "shape":"ResourceName", + "documentation":"<p>The name of a service for result list filtering. Proton returns components attached to service instances of the service.</p>" + } + } + }, + "ListComponentsOutput":{ + "type":"structure", + "required":["components"], + "members":{ + "components":{ + "shape":"ComponentSummaryList", + "documentation":"<p>An array of components with summary data.</p>" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"<p>A token that indicates the location of the next component in the array of components, after the current requested list of components.</p>" + } + } + }, "ListEnvironmentAccountConnectionsInput":{ "type":"structure", "required":["requestedBy"], @@ -3234,11 +3750,11 @@ }, "serviceInstanceName":{ "shape":"ResourceName", - "documentation":"<p>The service instance name.</p>" + "documentation":"<p>The name of the service instance whose outputs you want.</p>" }, "serviceName":{ "shape":"ResourceName", - "documentation":"<p>The service name.</p>" + "documentation":"<p>The name of the service that <code>serviceInstanceName</code> is associated to.</p>" } } }, @@ -3252,7 +3768,7 @@ }, "outputs":{ "shape":"OutputsList", - "documentation":"<p>An array of service instance infrastructure as code outputs.</p>" + "documentation":"<p>An array of service instance Infrastructure as Code (IaC) outputs.</p>" } } }, @@ -3269,11 +3785,11 @@ }, "serviceInstanceName":{ "shape":"ResourceName", - "documentation":"<p>The service instance name.</p>" + "documentation":"<p>The name of the service instance whose provisioned resources you want.</p>" }, "serviceName":{ "shape":"ResourceName", - "documentation":"<p>The service name.</p>" + "documentation":"<p>The name of the service that <code>serviceInstanceName</code> is associated to.</p>" } } }, @@ -3318,7 +3834,7 @@ }, "serviceInstances":{ "shape":"ServiceInstanceSummaryList", - "documentation":"<p>An array of service instances with summaries of detail data.</p>" + "documentation":"<p>An array of service instances with summary data.</p>" } } }, @@ -3332,7 +3848,7 @@ }, "serviceName":{ "shape":"ResourceName", - "documentation":"<p>The service name.</p>" + "documentation":"<p>The name of the service whose pipeline's outputs you want.</p>" } } }, @@ -3346,7 +3862,7 @@ }, "outputs":{ "shape":"OutputsList", - "documentation":"<p>An array of outputs.</p>" + "documentation":"<p>An array of service pipeline Infrastructure as Code (IaC) outputs.</p>" } } }, @@ -3360,7 +3876,7 @@ }, "serviceName":{ "shape":"ResourceName", - "documentation":"<p>The service name.</p>" + "documentation":"<p>The name of the service whose pipeline's provisioned resources you want.</p>" } } }, @@ -3534,7 +4050,7 @@ "documentation":"<p>The status of your provisioned resource.</p>" }, "statusMessage":{ - "shape":"SyntheticNotifyResourceDeploymentStatusChangeInputString", + "shape":"NotifyResourceDeploymentStatusChangeInputStatusMessageString", "documentation":"<p>The deployment status message for your provisioned resource.</p>" } } @@ -3545,6 +4061,12 @@ "max":50, "min":0 }, + "NotifyResourceDeploymentStatusChangeInputStatusMessageString":{ + "type":"string", + "max":5000, + "min":0, + "sensitive":true + }, "NotifyResourceDeploymentStatusChangeOutput":{ "type":"structure", "members":{ @@ -3679,7 +4201,7 @@ "documentation":"<p>The repository provider.</p>" } }, - "documentation":"<p>Detail date for a repository that has been registered with Proton.</p>" + "documentation":"<p>Detailed data of a repository that has been registered with Proton.</p>" }, "RepositoryArn":{"type":"string"}, "RepositoryBranch":{ @@ -3773,7 +4295,7 @@ "documentation":"<p>The repository provider.</p>" } }, - "documentation":"<p>A summary of detail data for a registered repository.</p>" + "documentation":"<p>Summary data of a repository that has been registered with Proton.</p>" }, "RepositorySummaryList":{ "type":"list", @@ -3890,6 +4412,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"], @@ -4070,7 +4598,7 @@ }, "description":{ "shape":"Description", - "documentation":"<p>A description of a service.</p>" + "documentation":"<p>A description of the service.</p>" }, "lastModifiedAt":{ "shape":"Timestamp", @@ -4109,7 +4637,7 @@ "documentation":"<p>The name of the service template.</p>" } }, - "documentation":"<p>The service detail data.</p>" + "documentation":"<p>Detailed data of an Proton service resource.</p>" }, "ServiceArn":{"type":"string"}, "ServiceInstance":{ @@ -4142,7 +4670,7 @@ }, "deploymentStatusMessage":{ "shape":"StatusMessage", - "documentation":"<p>A service instance deployment status message.</p>" + "documentation":"<p>The message associated with the service instance deployment status.</p>" }, "environmentName":{ "shape":"ResourceName", @@ -4181,7 +4709,7 @@ "documentation":"<p>The name of the service template that was used to create the service instance.</p>" } }, - "documentation":"<p>The service instance detail data.</p>" + "documentation":"<p>Detailed data of an Proton service instance resource.</p>" }, "ServiceInstanceArn":{"type":"string"}, "ServiceInstanceSummary":{ @@ -4249,7 +4777,7 @@ "documentation":"<p>The name of the service template.</p>" } }, - "documentation":"<p>A summary of the service instance detail data.</p>" + "documentation":"<p>Summary data of an Proton service instance resource.</p>" }, "ServiceInstanceSummaryList":{ "type":"list", @@ -4309,7 +4837,7 @@ "documentation":"<p>The name of the service template that was used to create the service pipeline.</p>" } }, - "documentation":"<p>The service pipeline detail data.</p>" + "documentation":"<p>Detailed data of an Proton service instance pipeline resource.</p>" }, "ServiceQuotaExceededException":{ "type":"structure", @@ -4383,7 +4911,7 @@ "documentation":"<p>The name of the service template.</p>" } }, - "documentation":"<p>A summary of the service detail data.</p>" + "documentation":"<p>Summary data of an Proton service resource.</p>" }, "ServiceSummaryList":{ "type":"list", @@ -4435,7 +4963,7 @@ "documentation":"<p>The recommended version of the service template.</p>" } }, - "documentation":"<p>The service template detail data.</p>" + "documentation":"<p>Detailed data of an Proton service template resource.</p>" }, "ServiceTemplateArn":{"type":"string"}, "ServiceTemplateSummary":{ @@ -4480,12 +5008,20 @@ "documentation":"<p>The recommended version of the service template.</p>" } }, - "documentation":"<p>The service template summary data.</p>" + "documentation":"<p>Summary data of an Proton service template resource.</p>" }, "ServiceTemplateSummaryList":{ "type":"list", "member":{"shape":"ServiceTemplateSummary"} }, + "ServiceTemplateSupportedComponentSourceInputList":{ + "type":"list", + "member":{"shape":"ServiceTemplateSupportedComponentSourceType"} + }, + "ServiceTemplateSupportedComponentSourceType":{ + "type":"string", + "enum":["DIRECTLY_DEFINED"] + }, "ServiceTemplateVersion":{ "type":"structure", "required":[ @@ -4543,12 +5079,16 @@ "shape":"StatusMessage", "documentation":"<p>A service template version status message.</p>" }, + "supportedComponentSources":{ + "shape":"ServiceTemplateSupportedComponentSourceInputList", + "documentation":"<p>An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.</p> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p>" + }, "templateName":{ "shape":"ResourceName", "documentation":"<p>The name of the version of a service template.</p>" } }, - "documentation":"<p>The version of a service template detail data.</p>" + "documentation":"<p>Detailed data of an Proton service template version resource.</p>" }, "ServiceTemplateVersionArn":{"type":"string"}, "ServiceTemplateVersionSummary":{ @@ -4604,7 +5144,7 @@ "documentation":"<p>The name of the service template.</p>" } }, - "documentation":"<p>A summary of the service template version detail data.</p>" + "documentation":"<p>Summary data of an Proton service template version resource.</p>" }, "ServiceTemplateVersionSummaryList":{ "type":"list", @@ -4630,12 +5170,6 @@ "type":"string", "enum":["TEMPLATE_SYNC"] }, - "SyntheticNotifyResourceDeploymentStatusChangeInputString":{ - "type":"string", - "max":5000, - "min":0, - "sensitive":true - }, "Tag":{ "type":"structure", "required":[ @@ -4698,6 +5232,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, @@ -4830,13 +5376,61 @@ } } }, - "UpdateEnvironmentAccountConnectionInput":{ + "UpdateComponentInput":{ "type":"structure", "required":[ - "id", - "roleArn" + "deploymentType", + "name" ], "members":{ + "deploymentType":{ + "shape":"ComponentDeploymentUpdateType", + "documentation":"<p>The deployment type. It defines the mode for updating a component, as follows:</p> <dl> <dt/> <dd> <p> <code>NONE</code> </p> <p>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated. You can only specify <code>description</code> in this mode.</p> </dd> <dt/> <dd> <p> <code>CURRENT_VERSION</code> </p> <p>In this mode, the component is deployed and updated with the new <code>serviceSpec</code>, <code>templateSource</code>, and/or <code>type</code> that you provide. Only requested parameters are updated.</p> </dd> </dl>" + }, + "description":{ + "shape":"Description", + "documentation":"<p>An optional customer-provided description of the component.</p>" + }, + "name":{ + "shape":"ResourceName", + "documentation":"<p>The name of the component to update.</p>" + }, + "serviceInstanceName":{ + "shape":"ResourceNameOrEmpty", + "documentation":"<p>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 <code>serviceInstanceName</code> and <code>serviceName</code> or for neither of them.</p>" + }, + "serviceName":{ + "shape":"ResourceNameOrEmpty", + "documentation":"<p>The name of the service that <code>serviceInstanceName</code> 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 <code>serviceInstanceName</code> and <code>serviceName</code> or for neither of them.</p>" + }, + "serviceSpec":{ + "shape":"SpecContents", + "documentation":"<p>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.</p>" + }, + "templateFile":{ + "shape":"TemplateFileContents", + "documentation":"<p>A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.</p> <note> <p>Components support a single IaC file, even if you use Terraform as your template language.</p> </note>" + } + } + }, + "UpdateComponentOutput":{ + "type":"structure", + "required":["component"], + "members":{ + "component":{ + "shape":"Component", + "documentation":"<p>The detailed data of the updated component.</p>" + } + } + }, + "UpdateEnvironmentAccountConnectionInput":{ + "type":"structure", + "required":["id"], + "members":{ + "componentRoleArn":{ + "shape":"Arn", + "documentation":"<p>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.</p> <p>The environment account connection must have a <code>componentRoleArn</code> to allow directly defined components to be associated with any environments running in the account.</p> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p>" + }, "id":{ "shape":"EnvironmentAccountConnectionId", "documentation":"<p>The ID of the environment account connection to update.</p>" @@ -4864,6 +5458,10 @@ "name" ], "members":{ + "componentRoleArn":{ + "shape":"Arn", + "documentation":"<p>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.</p> <p>The environment must have a <code>componentRoleArn</code> to allow directly defined components to be associated with the environment.</p> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p>" + }, "deploymentType":{ "shape":"DeploymentUpdateType", "documentation":"<p>There are four modes for updating an environment. The <code>deploymentType</code> field defines the mode.</p> <dl> <dt/> <dd> <p> <code>NONE</code> </p> <p>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</p> </dd> <dt/> <dd> <p> <code>CURRENT_VERSION</code> </p> <p>In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. <i>Don’t</i> include major or minor version parameters when you use this <code>deployment-type</code>.</p> </dd> <dt/> <dd> <p> <code>MINOR_VERSION</code> </p> <p>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.</p> </dd> <dt/> <dd> <p> <code>MAJOR_VERSION</code> </p> <p>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).</p> </dd> </dl>" @@ -5008,7 +5606,7 @@ "members":{ "deploymentType":{ "shape":"DeploymentUpdateType", - "documentation":"<p>The deployment type.</p> <p>There are four modes for updating a service instance. The <code>deploymentType</code> field defines the mode.</p> <dl> <dt/> <dd> <p> <code>NONE</code> </p> <p>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</p> </dd> <dt/> <dd> <p> <code>CURRENT_VERSION</code> </p> <p>In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. <i>Don’t</i> include major or minor version parameters when you use this <code>deployment-type</code>.</p> </dd> <dt/> <dd> <p> <code>MINOR_VERSION</code> </p> <p>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.</p> </dd> <dt/> <dd> <p> <code>MAJOR_VERSION</code> </p> <p>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.</p> </dd> </dl>" + "documentation":"<p>The deployment type. It defines the mode for updating a service instance, as follows:</p> <dl> <dt/> <dd> <p> <code>NONE</code> </p> <p>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</p> </dd> <dt/> <dd> <p> <code>CURRENT_VERSION</code> </p> <p>In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. <i>Don’t</i> include major or minor version parameters when you use this deployment type.</p> </dd> <dt/> <dd> <p> <code>MINOR_VERSION</code> </p> <p>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.</p> </dd> <dt/> <dd> <p> <code>MAJOR_VERSION</code> </p> <p>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.</p> </dd> </dl>" }, "name":{ "shape":"ResourceName", @@ -5130,7 +5728,7 @@ "members":{ "compatibleEnvironmentTemplates":{ "shape":"CompatibleEnvironmentTemplateInputList", - "documentation":"<p>An array of compatible environment names for a service template major or minor version to update.</p>" + "documentation":"<p>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.</p>" }, "description":{ "shape":"Description", @@ -5148,6 +5746,10 @@ "shape":"TemplateVersionStatus", "documentation":"<p>The status of the service template minor version to update.</p>" }, + "supportedComponentSources":{ + "shape":"ServiceTemplateSupportedComponentSourceInputList", + "documentation":"<p>An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.</p> <note> <p>A change to <code>supportedComponentSources</code> doesn't impact existing component attachments to instances based on this template version. A change only affects later associations.</p> </note> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html\">Proton components</a> in the <i>Proton Administrator Guide</i>.</p>" + }, "templateName":{ "shape":"ResourceName", "documentation":"<p>The name of the service template.</p>" diff --git a/contrib/python/botocore/py3/botocore/data/proton/2020-07-20/waiters-2.json b/contrib/python/botocore/py3/botocore/data/proton/2020-07-20/waiters-2.json index babd5af180..f99a6fe345 100644 --- a/contrib/python/botocore/py3/botocore/data/proton/2020-07-20/waiters-2.json +++ b/contrib/python/botocore/py3/botocore/data/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/contrib/python/botocore/py3/botocore/data/voice-id/2021-09-27/service-2.json b/contrib/python/botocore/py3/botocore/data/voice-id/2021-09-27/service-2.json index 67a207e304..8a52ea352c 100644 --- a/contrib/python/botocore/py3/botocore/data/voice-id/2021-09-27/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/voice-id/2021-09-27/service-2.json @@ -48,7 +48,7 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"<p>Deletes the specified domain from the Amazon Connect Voice ID system.</p>" + "documentation":"<p>Deletes the specified domain from Voice ID.</p>" }, "DeleteFraudster":{ "name":"DeleteFraudster", @@ -60,11 +60,12 @@ "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, + {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"<p>Deletes the specified fraudster from the Amazon Connect Voice ID system.</p>" + "documentation":"<p>Deletes the specified fraudster from Voice ID.</p>" }, "DeleteSpeaker":{ "name":"DeleteSpeaker", @@ -81,7 +82,7 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"<p>Deletes the specified speaker from the Amazon Connect Voice ID system.</p>" + "documentation":"<p>Deletes the specified speaker from Voice ID.</p>" }, "DescribeDomain":{ "name":"DescribeDomain", @@ -179,6 +180,7 @@ "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, + {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} @@ -285,7 +287,7 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"<p>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.</p>" + "documentation":"<p>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.</p>" }, "StartFraudsterRegistrationJob":{ "name":"StartFraudsterRegistrationJob", @@ -343,7 +345,7 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"<p>Tags an Amazon Connect Voice ID resource with the provided list of tags.</p>" + "documentation":"<p>Tags a Voice ID resource with the provided list of tags.</p>" }, "UntagResource":{ "name":"UntagResource", @@ -489,7 +491,8 @@ "ENROLLMENT_ALREADY_EXISTS", "SPEAKER_NOT_SET", "SPEAKER_OPTED_OUT", - "CONCURRENT_CHANGES" + "CONCURRENT_CHANGES", + "DOMAIN_LOCKED_FROM_ENCRYPTION_UPDATES" ] }, "CreateDomainRequest":{ @@ -514,7 +517,7 @@ }, "ServerSideEncryptionConfiguration":{ "shape":"ServerSideEncryptionConfiguration", - "documentation":"<p>The configuration, containing the KMS Key Identifier, to be used by Voice ID for the server-side encryption of your data. Refer to <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/encryption-at-rest.html#encryption-at-rest-voiceid\"> Amazon Connect VoiceID encryption at rest</a> for more details on how the KMS Key is used. </p>" + "documentation":"<p>The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Refer to <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/encryption-at-rest.html#encryption-at-rest-voiceid\"> Amazon Connect Voice ID encryption at rest</a> for more details on how the KMS key is used. </p>" }, "Tags":{ "shape":"TagList", @@ -741,7 +744,11 @@ }, "ServerSideEncryptionConfiguration":{ "shape":"ServerSideEncryptionConfiguration", - "documentation":"<p>The server-side encryption configuration containing the KMS Key Identifier you want Voice ID to use to encrypt your data.</p>" + "documentation":"<p>The server-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data.</p>" + }, + "ServerSideEncryptionUpdateDetails":{ + "shape":"ServerSideEncryptionUpdateDetails", + "documentation":"<p>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.</p>" }, "UpdatedAt":{ "shape":"Timestamp", @@ -804,7 +811,11 @@ }, "ServerSideEncryptionConfiguration":{ "shape":"ServerSideEncryptionConfiguration", - "documentation":"<p>The server-side encryption configuration containing the KMS Key Identifier you want Voice ID to use to encrypt your data..</p>" + "documentation":"<p>The server-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data.</p>" + }, + "ServerSideEncryptionUpdateDetails":{ + "shape":"ServerSideEncryptionUpdateDetails", + "documentation":"<p>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.</p>" }, "UpdatedAt":{ "shape":"Timestamp", @@ -890,7 +901,7 @@ }, "StreamingStatus":{ "shape":"StreamingStatus", - "documentation":"<p>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 <code>NOT_ENOUGH_SPEECH</code>. In this situation, if the <code>StreamingStatus</code> is <code>ONGOING/PENDING_CONFIGURATION</code>, 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 <code>NOT_ENOUGH_SPEECH</code> even after <code>StreamingStatus</code> is <code>ENDED</code>, 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.</p>" + "documentation":"<p>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 <code>NOT_ENOUGH_SPEECH</code>. In this situation, if the <code>StreamingStatus</code> is <code>ONGOING/PENDING_CONFIGURATION</code>, 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 <code>NOT_ENOUGH_SPEECH</code> even after <code>StreamingStatus</code> is <code>ENDED</code>, 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.</p>" } } }, @@ -1054,7 +1065,7 @@ }, "JobName":{ "shape":"JobName", - "documentation":"<p>The client-provied name for the fraudster registration job.</p>" + "documentation":"<p>The client-provided name for the fraudster registration job.</p>" }, "JobProgress":{ "shape":"JobProgress", @@ -1066,7 +1077,7 @@ }, "OutputDataConfig":{ "shape":"OutputDataConfig", - "documentation":"<p>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.</p>" + "documentation":"<p>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.</p>" }, "RegistrationConfig":{ "shape":"RegistrationConfig", @@ -1412,7 +1423,7 @@ }, "S3Uri":{ "shape":"S3Uri", - "documentation":"<p>The S3 path of the folder to which Voice ID writes the job output file, which has a <code>*.out</code> extension. For example, if the input file name is <code>input-file.json</code> and the output folder path is <code>s3://output-bucket/output-folder</code>, the full output file path is <code>s3://output-bucket/output-folder/job-Id/input-file.json.out</code>.</p>" + "documentation":"<p>The S3 path of the folder where Voice ID writes the job output file. It has a <code>*.out</code> extension. For example, if the input file name is <code>input-file.json</code> and the output folder path is <code>s3://output-bucket/output-folder</code>, the full output file path is <code>s3://output-bucket/output-folder/job-Id/input-file.json.out</code>.</p>" } }, "documentation":"<p>The configuration containing output file information for a batch job.</p>" @@ -1429,7 +1440,7 @@ "documentation":"<p>The minimum similarity score between the new and old fraudsters in order to consider the new fraudster a duplicate.</p>" } }, - "documentation":"<p>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.</p>" + "documentation":"<p>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.</p>" }, "ResourceNotFoundException":{ "type":"structure", @@ -1472,10 +1483,36 @@ "members":{ "KmsKeyId":{ "shape":"KmsKeyId", - "documentation":"<p>The identifier of the KMS Key you want Voice ID to use to encrypt your data.</p>" + "documentation":"<p>The identifier of the KMS key you want Voice ID to use to encrypt your data.</p>" + } + }, + "documentation":"<p>The configuration containing information about the customer managed key used for encrypting customer data.</p>" + }, + "ServerSideEncryptionUpdateDetails":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"<p>Message explaining the current UpdateStatus. When the UpdateStatus is FAILED, this message explains the cause of the failure.</p>" + }, + "OldKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"<p>The previous KMS key ID the domain was encrypted with, before ServerSideEncryptionConfiguration was updated to a new KMS key ID.</p>" + }, + "UpdateStatus":{ + "shape":"ServerSideEncryptionUpdateStatus", + "documentation":"<p>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.</p>" } }, - "documentation":"<p>The configuration containing information about the customer-managed KMS Key used for encrypting customer data.</p>" + "documentation":"<p>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.</p>" + }, + "ServerSideEncryptionUpdateStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] }, "ServiceQuotaExceededException":{ "type":"structure", @@ -1586,7 +1623,7 @@ }, "OutputDataConfig":{ "shape":"OutputDataConfig", - "documentation":"<p>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.</p>" + "documentation":"<p>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.</p>" } }, "documentation":"<p>Contains all the information about a speaker enrollment job.</p>" @@ -1729,7 +1766,7 @@ }, "OutputDataConfig":{ "shape":"OutputDataConfig", - "documentation":"<p>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.</p>" + "documentation":"<p>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.</p>" }, "RegistrationConfig":{ "shape":"RegistrationConfig", @@ -1770,7 +1807,7 @@ }, "EnrollmentConfig":{ "shape":"EnrollmentConfig", - "documentation":"<p>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.</p>" + "documentation":"<p>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.</p>" }, "InputDataConfig":{ "shape":"InputDataConfig", @@ -1782,7 +1819,7 @@ }, "OutputDataConfig":{ "shape":"OutputDataConfig", - "documentation":"<p>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.</p>" + "documentation":"<p>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.</p>" } } }, @@ -1932,7 +1969,7 @@ }, "ServerSideEncryptionConfiguration":{ "shape":"ServerSideEncryptionConfiguration", - "documentation":"<p>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. </p>" + "documentation":"<p>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. </p>" } } }, |